GoCardless API API Documentation
Create a Billing Request Template
POST {{url}}/billing_request_templates
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"billing_request_templates": {
"id": "BRT00007T8MMYHM",
"name": "12 Month Gold Plan",
"mandate_request_currency": "GBP",
"mandate_request_scheme": "bacs",
"mandate_request_verify": "recommended",
"mandate_request_metadata": {
"test": "ABC123"
},
"mandate_request_description": null,
"payment_request_description": "One-time joining fee",
"payment_request_amount": "69.99",
"payment_request_currency": "GBP",
"payment_request_scheme": "faster_payments",
"payment_request_metadata": {
"test": "ABC123"
},
"redirect_uri": "https://my-company.com/landing",
"authorisation_url": "https://pay-sandbox.gocardless.com/BRT00007T8MMYHM",
"metadata": {
"checkout-flow": "primary"
},
"created_at": "2024-03-22T21:35:05.583Z",
"updated_at": "2024-03-22T21:35:05.583Z"
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/billing_request_templates' -d '{"billing_request_templates":{"name":"12 Month Gold Plan","payment_request_description":"One-time joining fee","payment_request_currency":"GBP","payment_request_scheme":"faster_payments","payment_request_amount":"69.99","payment_request_metadata":{"test":"ABC123"},"mandate_request_verify":"recommended","mandate_request_currency":"GBP","mandate_request_scheme":"bacs","mandate_request_metadata":{"test":"ABC123"},"redirect_uri":"https://my-company.com/landing","metadata":{"checkout-flow":"primary"}}}'
ENDPOINTS