{
  "opencollection": "1.0.0",
  "info": {
    "name": "MX Platform accounts spending plan API",
    "version": "20111101"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "spending plan",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List spending plan iteration items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              }
            ]
          },
          "docs": "Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`."
        },
        {
          "info": {
            "name": "Create spending plan iteration item",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items",
            "params": [
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint creates a new `spending_plan_iteration_item`."
        },
        {
          "info": {
            "name": "List spending plans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              }
            ]
          },
          "docs": "Use this endpoint to list all the spending plans associated with the user."
        },
        {
          "info": {
            "name": "Create spending plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              }
            ]
          },
          "docs": "This endpoint creates a new `spending_plan` for the user."
        },
        {
          "info": {
            "name": "Read spending plan account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "spending_plan_account_guid",
                "value": "ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c",
                "type": "path",
                "description": "The unique ID for the specified account."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID."
        },
        {
          "info": {
            "name": "Delete spending plan account",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts/:spending_plan_account_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "spending_plan_account_guid",
                "value": "ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c",
                "type": "path",
                "description": "The unique ID for the specified account."
              }
            ]
          },
          "docs": "Use this endpoint to delete a `spending_plan_account`."
        },
        {
          "info": {
            "name": "Read a spending plan iteration item",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "iteration_item_guid",
                "value": "SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3",
                "type": "path",
                "description": "The unique ID for the `iteration_item`."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID."
        },
        {
          "info": {
            "name": "Update a spending plan iteration item",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "iteration_item_guid",
                "value": "SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3",
                "type": "path",
                "description": "The unique ID for the `iteration_item`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to update an existing `spending_plan_iteration_item`."
        },
        {
          "info": {
            "name": "Delete spending plan iteration item",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current/iteration_items/:iteration_item_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "iteration_item_guid",
                "value": "SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3",
                "type": "path",
                "description": "The unique ID for the `iteration_item`."
              }
            ]
          },
          "docs": "Use this endpoint to delete a spending plan `iteration_item`."
        },
        {
          "info": {
            "name": "Read a spending plan for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of a specific spending plan according to its unique GUID."
        },
        {
          "info": {
            "name": "Delete spending plan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              }
            ]
          },
          "docs": "Use this endpoint to delete a user's `spending_plan`."
        },
        {
          "info": {
            "name": "List spending plan accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/spending_plan_accounts",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              }
            ]
          },
          "docs": "Use this endpoint to list all the spending plan accounts associated with the spending plan."
        },
        {
          "info": {
            "name": "List spending plan iterations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              }
            ]
          },
          "docs": "Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`."
        },
        {
          "info": {
            "name": "Read current spending plan iteration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/current",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of the current spending plan `iteration`."
        },
        {
          "info": {
            "name": "Read a spending plan iteration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/spending_plans/:spending_plan_guid/iterations/:iteration_number",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "spending_plan_guid",
                "value": "SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262",
                "type": "path",
                "description": "The unique ID for the `spending_plan`."
              },
              {
                "name": "iteration_number",
                "value": "1",
                "type": "path",
                "description": "The current iteration number for the spending plan `iteration`."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`."
        }
      ]
    }
  ],
  "bundled": true
}