GOgocardless
Subscription

List subscriptions

Returns a cursor-paginated list of your subscriptions. Please note if the subscriptions are related to customers who have been removed, they will not be shown in the response.

get/subscriptions

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.

mandatestring

Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates created before 2016.

Example:MD123
customerstring

Unique identifier, beginning with "CU".

Example:CU123
statusstring

Up to 5 of:

  • pending_customer_approval
  • customer_approval_denied
  • active
  • finished
  • cancelled
  • paused

Omit entirely to include subscriptions in all states.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "subscriptions": [
    {
      "id": "SB123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "amount": 1000,
      "name": "12 month subscription",
      "start_date": "2014-10-21",
      "end_date": "2015-10-21",
      "interval": 1,
      "interval_unit": "monthly",
      "day_of_month": 28,
      "currency": "EUR",
      "month": "january",
      "count": 5,
      "payment_reference": "GOLDPLAN",
      "status": "active",
      "upcoming_payments": [
        {
          "amount": 2500,
          "charge_date": "2014-11-03"
        }
      ],
      "app_fee": 100,
      "links": {
        "mandate": "MD123"
      },
      "earliest_charge_date_after_resume": "2014-11-03"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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