{
  "opencollection": "1.0.0",
  "info": {
    "name": "CyberSource Merged Spec bankAccountValidation Subscriptions API",
    "version": "0.0.1"
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a List of Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rbs/v1/subscriptions",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Page offset number."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of items to be returned. Default - `20`, Max - `100`\n"
              },
              {
                "name": "code",
                "value": "",
                "type": "query",
                "description": "Filter by Subscription Code"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by Subscription Status"
              },
              {
                "name": "customerId",
                "value": "",
                "type": "query",
                "description": "Filter by Customer Id"
              },
              {
                "name": "clientReferenceInformationCode",
                "value": "",
                "type": "query",
                "description": "Filter by Client Reference Information Code / Merchant Reference Number"
              }
            ]
          },
          "docs": "Retrieve Subscriptions by Subscription Code & Subscription Status.\n"
        },
        {
          "info": {
            "name": "Create a Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rbs/v1/subscriptions"
          },
          "docs": "Create a Recurring Billing Subscription"
        },
        {
          "info": {
            "name": "Get a Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Get a Subscription by Subscription Id"
        },
        {
          "info": {
            "name": "Update a Subscription",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Update a Subscription by Subscription Id"
        },
        {
          "info": {
            "name": "Cancel a Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id/cancel",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Cancel a Subscription"
        },
        {
          "info": {
            "name": "Suspend a Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id/suspend",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Suspend a Subscription\n"
        },
        {
          "info": {
            "name": "Reactivating a Suspended Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id/activate",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              },
              {
                "name": "processMissedPayments",
                "value": "",
                "type": "query",
                "description": "Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true.\nWhen any option other than \"Ask each time before reactivating\" is selected in the reactivation settings, the value that you enter will be ignored.\n"
              }
            ]
          },
          "docs": "# Reactivating a Suspended Subscription\n\nYou can reactivate a suspended subscription for the next billing cycle. You cannot reactivate a canceled or completed subscription.\n\nYou can specify whether you want to process missed payments for the period during which the subscription was suspended using the `processMissedPayments` query parameter by setting it to true or false. \nIf no value is specified, the system will default to `true`.\n\n**Important:** The \"processMissedPayments\" query parameter is "
        },
        {
          "info": {
            "name": "Get a Subscription Code",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/code"
          },
          "docs": "Get a Unique Subscription Code"
        },
        {
          "info": {
            "name": "Get Payments for a Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id/payments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Page offset number."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of items to be returned. Default - `20`, Max - `100`\n"
              },
              {
                "name": "scheduledPaymentsCount",
                "value": "",
                "type": "query",
                "description": "Number of existing scheduled payments to be returned. Default - `5`, Max - `9999`\n"
              }
            ]
          },
          "docs": "Retrieve a list of payments for a specific subscription by its ID.\n"
        },
        {
          "info": {
            "name": "Update Payments for a subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/rbs/v1/subscriptions/:id/payments",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Modifies the state of a subscription's payments.\nCurrently, the only possible modifications are \"skipping\" and \"restoring\" payments. \nMarking a payment as \"skipped\" means it will not be processed when its scheduled time arrives. \"Restoring\" a payment removes it from the list of payments to be skipped.\n"
        }
      ]
    }
  ],
  "bundled": true
}