{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Subscriptions API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a list of all subscriptions.\n\n### Filtering\n\nThis endpoint supports filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering).\n\nThe following attributes and operators are supported.\n\n| Operator | Attribute | Description |\n| --- | --- | --- | \n| `eq` | `account_id`, `name`, `email`, `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `account_id`, `name`, `email`, `external_ref` | In. Che"
        },
        {
          "info": {
            "name": "Create a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a subscription"
        },
        {
          "info": {
            "name": "Get subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get subscription"
        },
        {
          "info": {
            "name": "Update a subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a subscription. For example, a subscriber can switch from one pricing option to another in a subscription.\n"
        },
        {
          "info": {
            "name": "Delete a subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ]
          },
          "docs": "Deletes a subscription\n"
        },
        {
          "info": {
            "name": "Get a feature in a subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/features/:feature_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "feature_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the feature."
              }
            ]
          },
          "docs": "Get a feature in a subscription"
        },
        {
          "info": {
            "name": "Get a plan in a subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/plans/:plan_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ]
          },
          "docs": "Get a plan in a subscription"
        },
        {
          "info": {
            "name": "Get a pricing option in a subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/pricing-options/:pricing_option_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "pricing_option_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the pricing option."
              }
            ]
          },
          "docs": "Get a pricing option in a subscription"
        },
        {
          "info": {
            "name": "List an subscriptions features",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/features",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              }
            ]
          },
          "docs": "List an subscriptions features"
        },
        {
          "info": {
            "name": "List subscription plans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/plans",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ]
          },
          "docs": "Retrieves a list of plans associated with the specified subscription. Using this endpoint you can see the plan that is currently active in a subscription. If `active_plan` is `true`, a plan is active in a subscription. If `active_plan` is null, the pricing option is not active."
        },
        {
          "info": {
            "name": "Manage subscription plans",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/plans",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Manage subscription plans by replacing, changing or detaching plans on the subscription"
        },
        {
          "info": {
            "name": "List subscription pricing options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/pricing-options",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ]
          },
          "docs": "Retrieves a list of pricing options associated with the specified subscription. Using this endpoint you can see the pricing options that are currently active in a subscription. If `active_pricing_option` is `true`, a pricing option is active in a subscription. If `active_pricing_option` is null, the pricing option is not active."
        },
        {
          "info": {
            "name": "List subscription states",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ]
          },
          "docs": "List subscription states"
        },
        {
          "info": {
            "name": "Create a subscription state",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The subscription lifecycle is the states that a subscription can go through when a customer subscribes to a service or a plan. \n\nA subscription can have the following states:\n\n- `pending` \n- `canceled`\n- `paused`\n- `resumed`\nFor more information, see [Managing the Subscription Lifecycle](/docs/api/subscriptions/subscriptions#managing-the-subscription-lifecycle).\n\nImmediate cancellation (`cancel` with `cancel_immediately: true`) ends the subscription and updates entitlements in this request; it d"
        },
        {
          "info": {
            "name": "Get subscription state",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/states/:state_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "state_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription state."
              }
            ]
          },
          "docs": "Get subscription state"
        },
        {
          "info": {
            "name": "List subscription invoices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              }
            ]
          },
          "docs": "Lists all invoices for a given subscription."
        },
        {
          "info": {
            "name": "List subscription invoice payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices/:invoice_uuid/payments",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "invoice_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the invoice."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used."
              }
            ]
          },
          "docs": "Lists all invoice payments for a given invoice."
        },
        {
          "info": {
            "name": "Get subscription invoice payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices/:invoice_uuid/payments/:payment_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "invoice_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the invoice."
              },
              {
                "name": "payment_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the payment."
              }
            ]
          },
          "docs": "Gets a specific payment for a given invoice."
        },
        {
          "info": {
            "name": "Get subscription invoice",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/subscriptions/:subscription_uuid/invoices/:invoice_uuid",
            "params": [
              {
                "name": "subscription_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the subscription."
              },
              {
                "name": "invoice_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the invoice."
              }
            ]
          },
          "docs": "Gets a specific invoice for a given subscription."
        }
      ]
    }
  ],
  "bundled": true
}