Logo
GoCardless API API Documentation

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

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 




RESPONSES

status Created

{ "instalment_schedules": { "id": "IS000063XHF9FF", "created_at": "2024-03-22T21:08:36.452Z", "total_amount": 2500, "currency": "GBP", "status": "pending", "name": "Intelligent Fresh Sausages", "metadata": {}, "payment_errors": {}, "links": { "mandate": "MD000ZS5F79P1E", "customer": "CU0014DQSA7A4W" } } }



Curl
curl -X POST 'https://api-sandbox.gocardless.com/instalment_schedules' -d '{"instalment_schedules":{"name":"$randomProductName","currency":"GBP","total_amount":"2500","instalments":{"start_date":"2024-12-14","interval_unit":"monthly","interval":1,"amounts":["1500","1000"]},"retry_if_possible":true,"links":{"mandate":"$randomProductName"}}}'

ENDPOINTS