GOgocardless
Billing Request Template

List Billing Request Templates

Returns a cursor-paginated list of your Billing Request Templates.

get/billing_request_templates

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.

payment_request_schemestring nullable

(Optional) A scheme used for Open Banking payments. Currently faster_payments is supported in the UK (GBP) and sepa_credit_transfer and sepa_instant_credit_transfer are supported in supported Eurozone countries (EUR). For Eurozone countries, sepa_credit_transfer is used as the default. Please be aware that sepa_instant_credit_transfer may incur an additional fee for your customer.

Example:faster_payments

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "billing_request_templates": [
    {
      "id": "BRT123",
      "name": "12 Month Gold Plan",
      "mandate_request_currency": "GBP",
      "mandate_request_scheme": "bacs",
      "payment_request_description": "Top-up Payment",
      "mandate_request_description": "Top-up Payment",
      "payment_request_amount": "100.00",
      "payment_request_currency": "GBP",
      "payment_request_scheme": "faster_payments",
      "redirect_uri": "https://my-website.com/abc/callback",
      "authorisation_url": "https://pay.gocardless.com/BRT123",
      "created_at": "2021-01-01T12:00:00.000Z",
      "updated_at": "2021-01-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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