GOgocardless
Billing Request Template

Create a Billing Request Template

post/billing_request_templates

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "billing_request_templates": {
    "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",
    "links": {
      "creditor": "CR123"
    }
  }
}

Response

Resource created successfully

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

Changes

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