{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Dunning Rules API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Dunning Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List dunning rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/dunning-rules",
            "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."
              }
            ]
          },
          "docs": "Retrieves a list of all dunning rule sets.\n"
        },
        {
          "info": {
            "name": "Create a dunning rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/dunning-rules",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Dunning rules must use a `fixed` strategy. This means payments are retried on a fixed schedule. \n\nWhen an invoice is created, it immediately becomes eligible for payment by the next payment run. If the first payment attempt fails then the invoice enters dunning. In subsequent payment runs, invoices are only  considered for payment if they meet the dunning rules you create.\n\nYou can configure a dunning rule to be the default for your store. There can only be one default rule per store. All invoic"
        },
        {
          "info": {
            "name": "Get dunning rule policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/dunning-rules/:dunning_rule_uuid",
            "params": [
              {
                "name": "dunning_rule_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a dunning rule set."
              }
            ]
          },
          "docs": "Get dunning rule policy"
        },
        {
          "info": {
            "name": "Update dunning rule policy",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/dunning-rules/:dunning_rule_uuid",
            "params": [
              {
                "name": "dunning_rule_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a dunning rule set."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the rule is not updated. For fields that are optional, an existing value can be removed by specifying a value of null."
        },
        {
          "info": {
            "name": "Delete dunning rules",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/subscriptions/dunning-rules/:dunning_rule_uuid",
            "params": [
              {
                "name": "dunning_rule_uuid",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a dunning rule set."
              }
            ]
          },
          "docs": "You can delete a dunning rule at any time. If a dunning rule is deleted then Subscriptions reverts to the configuration used if no dunning rule is set; payment is retried once a day for 10 days, in total 11 payments. You can decide what action to take after the Subscriptions has stopped retrying the payments. See [Dunning Rules](/docs/api/subscriptions/dunning-rules)."
        }
      ]
    }
  ],
  "bundled": true
}