{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Proration Policies API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Proration Policies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List proration policies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/proration-policies",
            "params": [
              {
                "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": "Retrieves a list of all proration policies.\n"
        },
        {
          "info": {
            "name": "Create a Proration Policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/proration-policies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "In Subscriptions, you configure proration by creating a proration policy and attaching it to an offering. Once you have [attached](/docs/api/subscriptions/update-offering) the policy, the proration policy applies to all subscriptions that use the offering.\n"
        },
        {
          "info": {
            "name": "Get proration policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/proration-policies/:proration_policy_uuid",
            "params": [
              {
                "name": "proration_policy_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a proration policy."
              }
            ]
          },
          "docs": "Get proration policy"
        },
        {
          "info": {
            "name": "Update proration policy",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/proration-policies/:proration_policy_uuid",
            "params": [
              {
                "name": "proration_policy_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a proration policy."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can update a proration policy at any time. For any subscriptions that are using the updated proration policy, the changes are also applied. Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the proration policy is not updated.\n\nWhen updating proration policies:\n\n- You can change the name of an existing policy.\n- You can update `rounding`.\n- You can update `external_ref` as long as `external_ref` is still u"
        },
        {
          "info": {
            "name": "Delete proration policy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/proration-policies/:proration_policy_uuid",
            "params": [
              {
                "name": "proration_policy_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a proration policy."
              }
            ]
          },
          "docs": "A proration policy cannot be deleted if it is being used by any subscriptions. This means you must detach a proration policy that you want to delete from any offerings using that policy before deleting the policy. See [Remove a proration policy from an offering](/docs/api/subscriptions/update-offering)."
        }
      ]
    }
  ],
  "bundled": true
}