GOgocardless
Billing Request

List Billing Requests

Returns a cursor-paginated list of your billing requests.

get/billing_requests

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.

status'pending' | 'ready_to_fulfil' | 'fulfilling' | 'fulfilled' | 'cancelled'

One of:

  • pending: the billing request is pending and can be used
  • ready_to_fulfil: the billing request is ready to fulfil
  • fulfilling: the billing request is currently undergoing fulfilment
  • fulfilled: the billing request has been fulfilled and a payment created
  • cancelled: the billing request has been cancelled and cannot be used
Example:pending
customerstring
Example:CU123

ID of a customer. If specified, this endpoint will return all requests for the given customer.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "billing_requests": [
    {
      "id": "BRQ123",
      "created_at": "2015-01-01T12:00:00.000Z",
      "status": "pending",
      "account_information_request": {
        "country_code": "GB"
      },
      "mandate_request": {
        "description": "Top-up Payment",
        "currency": "GBP",
        "scheme": "bacs"
      },
      "payment_request": {
        "description": "Top-up Payment",
        "currency": "GBP",
        "scheme": "faster_payments",
        "amount": 1000,
        "app_fee": 100,
        "reference": "some-custom-ref"
      },
      "subscription_request": {
        "amount": 1000,
        "currency": "USD",
        "interval_unit": "monthly",
        "interval": 1,
        "app_fee": 100,
        "count": 5,
        "day_of_month": 28,
        "month": "january",
        "name": "12 month subscription",
        "payment_reference": "GOLDPLAN",
        "start_date": "2014-10-21"
      },
      "instalment_schedule_request": {
        "name": "Invoice 4404",
        "currency": "USD",
        "total_amount": 1000,
        "payment_reference": "GOLDPLAN",
        "app_fee": 100,
        "instalments_with_dates": [
          {
            "amount": 250,
            "charge_date": "2020-11-03"
          }
        ],
        "instalments_with_schedule": {
          "start_date": "2014-10-21",
          "interval": 1,
          "interval_unit": "monthly",
          "amounts": [
            1000
          ]
        }
      },
      "links": {
        "customer": "CU123",
        "creditor": "CR123",
        "organisation": "OR123",
        "customer_bank_account": "BA123",
        "account_information_request": "AIR123",
        "payment_request": "PRQ123",
        "payment_request_payment": "PM123",
        "mandate_request": "MRQ123",
        "mandate_request_mandate": "MD123",
        "subscription_request": "SBR123",
        "subscription_request_subscription": "SB123",
        "instalment_schedule_request": "ISR123",
        "instalment_schedule_request_instalment_schedule": "IS123",
        "payment_provider": "PP123"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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