{
  "opencollection": "1.0.0",
  "info": {
    "name": "Configuration alertRules paymentSchedules API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "paymentSchedules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a list of payment schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              },
              {
                "name": "customer_id",
                "value": "",
                "type": "query",
                "description": "Filter based of customer ID"
              },
              {
                "name": "expand[]",
                "value": "",
                "type": "query",
                "description": "The id fields of the resources that are going to be expanded."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The amount of records shown in the list"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page which is going to be shown"
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "The parameter by which the response is ordered."
              },
              {
                "name": "order_direction",
                "value": "",
                "type": "query",
                "description": "The order direction by which the response is ordered."
              }
            ]
          },
          "docs": "Requires the PAYMENT_SCHEDULE.VIEW permission."
        },
        {
          "info": {
            "name": "Create a payment schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the PAYMENT_SCHEDULE.CREATE permission."
        },
        {
          "info": {
            "name": "Initialize resources for a payment schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules/init",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the PAYMENT_SCHEDULE.CREATE, PAYMENT_METHOD.CREATE, PAYMENT_METHOD.UPDATE, CUSTOMER.CREATE or CUSTOMER.UPDATE permission."
        },
        {
          "info": {
            "name": "Get a payment schedule by ID or reference",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules/:resourceIdOrReference",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              },
              {
                "name": "resourceIdOrReference",
                "value": "",
                "type": "path",
                "description": "The ID or reference of the resource."
              },
              {
                "name": "expand[]",
                "value": "",
                "type": "query",
                "description": "The id fields of the resources that are going to be expanded."
              }
            ]
          },
          "docs": "Requires the PAYMENT_SCHEDULE.VIEW permission."
        },
        {
          "info": {
            "name": "Patch a payment schedule.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules/:resourceIdOrReference",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              },
              {
                "name": "resourceIdOrReference",
                "value": "",
                "type": "path",
                "description": "The ID or reference of the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the PAYMENT_SCHEDULE.VIEW permission."
        },
        {
          "info": {
            "name": "Cancel a payment schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules/:resourceIdOrReference/cancel",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              },
              {
                "name": "resourceIdOrReference",
                "value": "",
                "type": "path",
                "description": "The ID or reference of the resource."
              }
            ]
          },
          "docs": "Requires the PAYMENT_SCHEDULE.UPDATE permission."
        },
        {
          "info": {
            "name": "Pause a payment schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules/:resourceIdOrReference/pause",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              },
              {
                "name": "resourceIdOrReference",
                "value": "",
                "type": "path",
                "description": "The ID or reference of the resource."
              }
            ]
          },
          "docs": "Requires the PAYMENT_SCHEDULE.UPDATE permission."
        },
        {
          "info": {
            "name": "Activate a payment schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://test.api.solvimon.com/v:version/payment-schedules/:resourceIdOrReference/activate",
            "headers": [
              {
                "name": "X-API-KEY",
                "value": ""
              },
              {
                "name": "x-platform-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "version"
              },
              {
                "name": "resourceIdOrReference",
                "value": "",
                "type": "path",
                "description": "The ID or reference of the resource."
              }
            ]
          },
          "docs": "Requires the PAYMENT_SCHEDULE.UPDATE permission."
        }
      ]
    }
  ],
  "bundled": true
}