GOgocardless
Instalment Schedule

Create (with schedule)

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.

post/instalment_schedules/create_with_schedule

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "instalment_schedules": {
    "name": "Invoice 4404",
    "currency": "EUR",
    "payment_reference": "WINEBOX001",
    "instalments": {
      "start_date": "2014-10-21",
      "interval": 1,
      "interval_unit": "monthly"
    },
    "links": {
      "mandate": "MD123"
    }
  }
}

Response

Resource created successfully

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"
      ]
    }
  }
}

Changes

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