{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Offerings API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Offerings",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List offerings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings",
            "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 subscription offerings.\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` | `external_ref`, `plans.external_ref`, `proration_policy_id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |\n| `in` | `external_ref`, `plans.external_"
        },
        {
          "info": {
            "name": "Create an offering",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an offering"
        },
        {
          "info": {
            "name": "Build an offering",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/build",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "An offering includes plans and pricing options; plans are combined with one or more pricing options to form an offering. An offering can include either:\n\n- subscription plans (created within an offering).\n- Product Experience Manager products. See [**create a product**](/docs/api/pxm/products/create-product).\n\nWhen you are building an offering:\n\n- you can create new pricing options and plans.\n- you can modify an existing plan and pricing options. For example, you can modify the plan price or any"
        },
        {
          "info": {
            "name": "Get offering",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get offering"
        },
        {
          "info": {
            "name": "Update an offering",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "After saving an offering, you can update an offering at any time. Updating an offering does not affect any active subscriptions. The changes take effect on all new subscriptions that are created. For fields that are optional, an existing value can be removed by specifying a value of null.\n"
        },
        {
          "info": {
            "name": "Delete offering",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              }
            ]
          },
          "docs": "When a subscription is created, it creates a snapshot of the offering. This means you can delete an offering without affecting any active subscriptions."
        },
        {
          "info": {
            "name": "Get a feature in an offering",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features/:feature_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "feature_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the feature."
              }
            ]
          },
          "docs": "Get a feature in an offering"
        },
        {
          "info": {
            "name": "Updates a feature in an offering",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features/:feature_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "feature_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the feature."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the unique identifier of the feature in the offering that you want to update. Any modifications that you make to the features in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created."
        },
        {
          "info": {
            "name": "Remove a feature from an offering",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features/:feature_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "feature_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the feature."
              }
            ]
          },
          "docs": "After saving an offering, you can remove features from it at any time.\n\n Removing a feature from an offering does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n"
        },
        {
          "info": {
            "name": "Attach a feature",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features/attach",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "After saving an offering, you can attach new features to it at any time.\n\nAdding new features does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n"
        },
        {
          "info": {
            "name": "List an offering's pricing options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/pricing-options",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "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 offering's pricing options"
        },
        {
          "info": {
            "name": "Create a pricing option inside an offering",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/pricing-options",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "After saving an offering, you can add new pricing option to it at any time.\n"
        },
        {
          "info": {
            "name": "Get a pricing option in an offering",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/pricing-options/:pricing_option_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "pricing_option_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the pricing option."
              }
            ]
          },
          "docs": "Get a pricing option in an offering"
        },
        {
          "info": {
            "name": "Update a pricing option in an offering",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/pricing-options/:pricing_option_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "pricing_option_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the pricing option."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a pricing option in an offering"
        },
        {
          "info": {
            "name": "Remove a pricing option from an offering",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/pricing-options/:pricing_option_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "pricing_option_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the pricing option."
              }
            ]
          },
          "docs": "After saving an offering, you can remove pricing options from it at any time.\n\nRemoving a pricing option from an offering does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n"
        },
        {
          "info": {
            "name": "List an offering's features",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "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 offering's features"
        },
        {
          "info": {
            "name": "Create a feature directly inside an offering",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "After saving an offering, you can add new features to it at any time.\n"
        },
        {
          "info": {
            "name": "List an offering's plans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "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 offering's plans"
        },
        {
          "info": {
            "name": "Create a plan inside an offering",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "After saving an offering, you can add new plans to it at any time.\n"
        },
        {
          "info": {
            "name": "Get a plan in an offering",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans/:plan_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ]
          },
          "docs": "Get a plan in an offering"
        },
        {
          "info": {
            "name": "Update a plan in an offering",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans/:plan_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the unique identifier of the plan in the offering that you want to update. Any modifications that you make to the plans in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created."
        },
        {
          "info": {
            "name": "Remove a plan from an offering",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans/:plan_uuid",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ]
          },
          "docs": "After saving an offering, you can remove plans from it at any time.\n\n Removing a plan from an offering does not affect any existing active subscriptions. The changes take effect on all new subscriptions that are created.\n"
        },
        {
          "info": {
            "name": "List the pricing options available to a plan in an offering",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans/:plan_uuid/relationships/pricing_options",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ]
          },
          "docs": "List the pricing options available to a plan in an offering"
        },
        {
          "info": {
            "name": "Adds an offering's pricing options to the plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans/:plan_uuid/relationships/pricing_options",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the unique identifier of the pricing in the offering that you want to update. Any modifications that you make to the plans in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created."
        },
        {
          "info": {
            "name": "Removes an offering's pricing options from the plan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/plans/:plan_uuid/relationships/pricing_options",
            "params": [
              {
                "name": "offering_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the offering."
              },
              {
                "name": "plan_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the plan."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the unique identifier of the pricing in the offering that you want to update. Any modifications that you make to the plans in an offering, does not affect any active subscriptions. The changes take effect on all new subscriptions that are created."
        }
      ]
    }
  ],
  "bundled": true
}