Core Endpoints-Instalment Schedules

Number of APIs: 5

1. List Instalment Schedules

GET {{url}}/instalment_schedules

Returns a cursor-paginated list of your instalment schedules.

List instalment schedules API Docs

---

2. Create Instalment Schedules (with schedule)

POST {{url}}/instalment_schedules

Creates a new instalment schedule object, along with the associated payments. This API is recommended if you wish to use the GoCardless scheduling logic. For finer control over the individual dates, please check out the alternative version.

It can take quite a while to create the associated payments, so the API will return the status as pending initially. When processing has completed, a subsequent GET request for the instalment schedule will either have the status success and link to the created payments, or the status error and detailed information about the failures.

Create with schedules API Docs

---

3. Update an Instalment Schedule

PUT {{url}}/instalment_schedules/{{instalment_schedule}}

Updates an instalment schedule. This accepts only the metadata parameter.

Update an instalment schedule API Docs

---

4. Cancel an Instalment Schedule

POST {{url}}/instalment_schedules/{{instalment_schedule}}/actions/cancel

Immediately cancels an instalment schedule; no further payments will be collected for it.

This will fail with a cancellation_failed error if the instalment schedule is already cancelled or has completed.

Cancel an instalment schedule API Docs

---

5. Get a Single Instalment Schedules

GET {{url}}/instalment_schedules/{{instalment_schedule}}

Retrieves the details of an existing instalment schedule.

Get instalment schedule API Docs

---