cancel paddle subscription
PUT
/payments/cancel-paddle-subscription
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/payments/cancel-paddle-subscription' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"reason": "this is just a reason"
}'Response Response Example
{
"success": true,
"message": "subscription cancelled successfully",
"data": {
"data": {
"id": "sub_01jjaqybd8jx4n9zc3jg4h85gg",
"status": "canceled",
"customer_id": "ctm_01jja0yvygm712sbcy5tg0qm4r",
"address_id": "add_01jjaqxgdbyk4a3nrpfz0as5zv",
"business_id": null,
"currency_code": "USD",
"created_at": "2025-01-23T23:28:47.528Z",
"updated_at": "2025-01-25T16:15:23.251Z",
"started_at": "2025-01-23T23:28:46.939798Z",
"first_billed_at": "2025-01-23T23:28:46.939798Z",
"next_billed_at": null,
"paused_at": null,
"canceled_at": "2025-01-25T16:15:23.248Z",
"collection_mode": "automatic",
"billing_details": null,
"current_billing_period": null,
"billing_cycle": {
"frequency": 1,
"interval": "month"
},
"scheduled_change": null,
"items": [
{
"status": "active",
"quantity": 1,
"recurring": true,
"created_at": "2025-01-23T23:28:47.528Z",
"updated_at": "2025-01-23T23:28:47.528Z",
"previously_billed_at": "2025-01-23T23:28:46.939798Z",
"next_billed_at": null,
"trial_dates": null,
"price": {
"id": "pri_01jghfs5cbdpnnssd65k5f8eet",
"product_id": "pro_01jghfna2trth6n33ycebpprz7",
"type": "standard",
"description": "a price for the pro monthly tier ",
"name": "pro-monthly",
"tax_mode": "external",
"billing_cycle": {
"frequency": 1,
"interval": "month"
},
"trial_period": null,
"unit_price": {
"amount": "1000",
"currency_code": "USD"
},
"unit_price_overrides": [],
"custom_data": {
"plan": "pro-monthly"
},
"status": "active",
"quantity": {
"minimum": 1,
"maximum": 999999
},
"import_meta": null,
"created_at": "2025-01-01T17:49:26.283387Z",
"updated_at": "2025-01-23T09:31:14.504944Z"
},
"product": {
"id": "pro_01jghfna2trth6n33ycebpprz7",
"name": "pro",
"type": "standard",
"tax_category": "standard",
"description": "",
"image_url": "",
"custom_data": null,
"status": "active",
"created_at": "2025-01-01T17:47:20.026Z",
"updated_at": "2025-01-02T14:43:11.65Z"
}
}
],
"custom_data": null,
"management_urls": {
"update_payment_method": "https://sandbox-buyer-portal.paddle.com/subscriptions/sub_01jjaqybd8jx4n9zc3jg4h85gg/update-payment-method?token=pga_eyJhbGciOiJFZERTQSIsImtpZCI6Imp3a18wMWhkazBuOHF3OG55NTJ5cGNocGNhazA1ayIsInR5cCI6IkpXVCJ9.eyJpZCI6InBnYV8wMWpqZjN5Nmt6cWVtcGFiY21obmQ3MzhzdiIsInNlbGxlci1pZCI6IjI2MDIwIiwidHlwZSI6InN0YW5kYXJkIiwidmVyc2lvbiI6IjEiLCJ1c2FnZSI6Im1hbmFnZW1lbnRfdXJsIiwic2NvcGUiOiJjdXN0b21lci5zdWJzY3JpcHRpb24tcGF5bWVudC51cGRhdGUgY3VzdG9tZXIuc3Vic2NyaXB0aW9uLXBheW1lbnQucmVhZCBjdXN0b21lci5zdWJzY3JpcHRpb24tY2FuY2VsLmNyZWF0ZSBjdXN0b21lci5zdWJzY3JpcHRpb24ucmVhZCIsImlzcyI6Imd1ZXN0YWNjZXNzLXNlcnZpY2UiLCJzdWIiOiJjdG1fMDFqamEweXZ5Z203MTJzYmN5NXRnMHFtNHIiLCJleHAiOjE3NjkzNTc3MjMsImlhdCI6MTczNzgyMTcyM30.Upw7djpaotGgoUFB66cmRWRbQ4h87vXLGfjmgQnlDZ4jIpdhvsmTPf6COZX982PY3J9xRX_faJqMTNihbG88DA",
"cancel": "https://sandbox-buyer-portal.paddle.com/subscriptions/sub_01jjaqybd8jx4n9zc3jg4h85gg/cancel?token=pga_eyJhbGciOiJFZERTQSIsImtpZCI6Imp3a18wMWhkazBuOHF3OG55NTJ5cGNocGNhazA1ayIsInR5cCI6IkpXVCJ9.eyJpZCI6InBnYV8wMWpqZjN5Nmt6cWVtcGFiY21obmQ3MzhzdiIsInNlbGxlci1pZCI6IjI2MDIwIiwidHlwZSI6InN0YW5kYXJkIiwidmVyc2lvbiI6IjEiLCJ1c2FnZSI6Im1hbmFnZW1lbnRfdXJsIiwic2NvcGUiOiJjdXN0b21lci5zdWJzY3JpcHRpb24tcGF5bWVudC51cGRhdGUgY3VzdG9tZXIuc3Vic2NyaXB0aW9uLXBheW1lbnQucmVhZCBjdXN0b21lci5zdWJzY3JpcHRpb24tY2FuY2VsLmNyZWF0ZSBjdXN0b21lci5zdWJzY3JpcHRpb24ucmVhZCIsImlzcyI6Imd1ZXN0YWNjZXNzLXNlcnZpY2UiLCJzdWIiOiJjdG1fMDFqamEweXZ5Z203MTJzYmN5NXRnMHFtNHIiLCJleHAiOjE3NjkzNTc3MjMsImlhdCI6MTczNzgyMTcyM30.Upw7djpaotGgoUFB66cmRWRbQ4h87vXLGfjmgQnlDZ4jIpdhvsmTPf6COZX982PY3J9xRX_faJqMTNihbG88DA"
},
"discount": null,
"import_meta": null
},
"meta": {
"request_id": "c67774f7-f9cc-4462-a0b7-c43adb1974e7"
}
}
}Modified at 2025-09-02 07:34:45