GOgocardless
Instalment Schedule

List instalment schedules

Returns a cursor-paginated list of your instalment schedules.

get/instalment_schedules

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

statusstring

At most five valid status values

mandatestring

ID of the associated mandate which the instalment schedule will create payments against.

Example:MD123
customerstring

ID of the associated customer.

Example:CU123

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "instalment_schedules": [
    {
      "id": "IS123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "total_amount": 1000,
      "name": "Invoice 4404",
      "currency": "EUR",
      "status": "active",
      "payment_errors": {
        "0": [
          {
            "field": "charge_date",
            "message": "must be on or after mandate's next_possible_customer_charge_date"
          }
        ]
      },
      "links": {
        "mandate": "MD123",
        "customer": "CU123",
        "payments": [
          "PM123",
          "PM456"
        ]
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.