GoCardless API API Documentation
Create a Subscripton
POST {{url}}/subscriptions
Creates a new subscription object
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status Created
| {
"subscriptions": {
"id": "SB000AM48DNDJM",
"created_at": "2024-03-22T20:27:03.150Z",
"amount": 21279,
"currency": "GBP",
"status": "active",
"name": "extend virtual methodologies",
"start_date": "2024-04-15",
"end_date": "2025-03-18",
"interval": 1,
"interval_unit": "monthly",
"day_of_month": 15,
"month": null,
"count": 12,
"metadata": {
"order_no": "ORDER837"
},
"payment_reference": null,
"upcoming_payments": [
{
"charge_date": "2024-04-15",
"amount": 21279
},
{
"charge_date": "2024-05-15",
"amount": 21279
},
{
"charge_date": "2024-06-17",
"amount": 21279
},
{
"charge_date": "2024-07-15",
"amount": 21279
},
{
"charge_date": "2024-08-15",
"amount": 21279
},
{
"charge_date": "2024-09-16",
"amount": 21279
},
{
"charge_date": "2024-10-15",
"amount": 21279
},
{
"charge_date": "2024-11-15",
"amount": 21279
},
{
"charge_date": "2024-12-16",
"amount": 21279
},
{
"charge_date": "2025-01-15",
"amount": 21279
}
],
"app_fee": null,
"links": {
"mandate": "MD000ZS5AS941B"
},
"retry_if_possible": true,
"earliest_charge_date_after_resume": null
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/subscriptions'
ENDPOINTS