GoCardless API API Documentation
List Instalment Schedules
GET {{url}}/instalment_schedules
Returns a cursor-paginated list of your instalment schedules.
Body
PARAM
| Key | Datatype | Required | Description |
after
|
null | Cursor pointing to the start of the desired set. | |
before
|
null | Cursor pointing to the end of the desired set. | |
created_at[gt]
|
null | Limit to records created after the specified date-time. | |
created_at[gte]
|
null | Limit to records created on or after the specified date-time. | |
created_at[lt]
|
null | Limit to records created before the specified date-time. | |
created_at[lte]
|
null | Limit to records created on or before the specified date-time. | |
customer
|
null | ID of the associated customer. | |
limit
|
null | Number of records to return. | |
mandate
|
null | ID of the associated mandate which the instalment schedule will create payments against. | |
status
|
null | At most five valid status values |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"instalment_schedules": [
{
"id": "IS0000753ZZ2PF",
"created_at": "2024-08-07T03:10:37.354Z",
"total_amount": 2500,
"currency": "GBP",
"status": "active",
"name": "Intelligent Plastic Bike",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD00121V4D4M56",
"customer": "CU0017Y0SNE7DX",
"payments": [
"PM00AHCYHC7S05",
"PM00AHCYHDSPSC"
]
}
},
{
"id": "IS0000753Y18ZD",
"created_at": "2024-08-07T03:10:36.452Z",
"total_amount": 2500,
"currency": "GBP",
"status": "active",
"name": "Awesome Rubber Bike",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD00121V4D4M56",
"customer": "CU0017Y0SNE7DX",
"payments": [
"PM00AHCYH9TWBT",
"PM00AHCYHB8M11"
]
}
},
{
"id": "IS0000753XEZAR",
"created_at": "2024-08-07T03:10:35.321Z",
"total_amount": 2500,
"currency": "GBP",
"status": "active",
"name": "Licensed Fresh Bike",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD00121V4D4M56",
"customer": "CU0017Y0SNE7DX",
"payments": [
"PM00AHCYH8MJBQ",
"PM00AHCYHA8B4S"
]
}
},
{
"id": "IS0000753WXKPP",
"created_at": "2024-08-07T03:10:32.733Z",
"total_amount": 2500,
"currency": "GBP",
"status": "active",
"name": "Refined Concrete Hat",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD00121V4D4M56",
"customer": "CU0017Y0SNE7DX",
"payments": [
"PM00AHCYGYYQZM",
"PM00AHCYGZPAGF"
]
}
},
{
"id": "IS000074KM364V",
"created_at": "2024-07-31T11:38:56.884Z",
"total_amount": 50000,
"currency": "GBP",
"status": "cancelled",
"name": "Test",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD0011BPP6F4HX",
"customer": "CU0016PH5ZCGVM",
"payments": [
"PM00AGJJ47NNRX",
"PM00AGJJ48VD1G",
"PM00AGJJ4AVKS3",
"PM00AGJJ4BDESM",
"PM00AGJJ4CJ085",
"PM00AGJJ4DGG3C"
]
}
},
{
"id": "IS0000733P1NF8",
"created_at": "2024-07-24T09:51:45.590Z",
"total_amount": 60240,
"currency": "GBP",
"status": "active",
"name": "Toll Split Charge",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD0011VT1BZRRM",
"customer": "CU0017M7JX7S3D",
"payments": [
"PM00AF5XPRKZSR",
"PM00AF5XPWVZ8X",
"PM00AF5XPXNJZ7",
"PM00AF5XPZJVZC",
"PM00AF5XQ0D9J9",
"PM00AF5XQ487GR",
"PM00AF5XQ6BDZK",
"PM00AF5XQ8KTDM",
"PM00AF5XQAJRXW",
"PM00AF5XQEV99E",
"PM00AF5XQGZ5KE",
"PM00AF5XQJDJBB",
"PM00AF5XQMS3QD",
"PM00AF5XQQ1K4S",
"PM00AF5XQT4VHN",
"PM00AF5XQWWAWR",
"PM00AF5XQYFWYQ",
"PM00AF5XR12H1H",
"PM00AF5XR4N14Y",
"PM00AF5XR6F39K",
"PM00AF5XR9DSRY",
"PM00AF5XRD96YG",
"PM00AF5XRFEZJT",
"PM00AF5XRK7JY4",
"PM00AF5XRNFF9Y"
]
}
},
{
"id": "IS00006DWXBENR",
"created_at": "2024-05-22T16:03:45.401Z",
"total_amount": 2500,
"currency": "GBP",
"status": "active",
"name": "Instalment API Test",
"metadata": {},
"payment_errors": {},
"links": {
"mandate": "MD0011BPP2FF8F",
"customer": "CU00162BEDNZSF",
"payments": [
"PM00A23SD08S11",
"PM00A23SD1SRDY"
]
}
}
],
"meta": {
"cursors": {
"before": null,
"after": null
},
"limit": 50
}
} |
Curl
curl -X GET 'https://api-sandbox.gocardless.com/instalment_schedules?after=&before=&created_at[gt]=&created_at[gte]=&created_at[lt]=&created_at[lte]=&customer=&limit=&mandate=&status='
ENDPOINTS