Cancel a subscription
Useepay API V2.0 Sandbox Environment
https://openapi1.uat.useepay.com
Useepay API V2.0 Sandbox Environment
https://openapi1.uat.useepay.com
POST
/api/v1/subscriptions/{{subscription-id}}/cancel
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://openapi1.uat.useepay.com/api/v1/subscriptions/sub_1JBQUBE5K0000/cancel' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com' \
--header 'Content-Type: application/json' \
--data-raw '{
"cancellation_details":{
"comment":"cancel desc"
,"feedback":"low_quality"
}
,"prorate":false
}'Response Response Example
{
"id": "sub_1JBPC9HT80000",
"recurring": {
"interval": "month",
"interval_count": 1,
"unit_amount": 112,
"total_billing_cycles": 10
},
"currency": "USD",
"description": "subscription desc",
"items": [
{
"metadata": {
"mid": "00001"
},
"quantity": 1,
"price_data": {
"currency": "USD",
"product": "iphone16",
"recurring": null,
"unit_amount": 1120
}
}
],
"metadata": {
"sid": "0001"
},
"status": "incomplete",
"livemode": null,
"prorate": null,
"merchant_no": "500000000007264",
"app_id": "www.pay.com",
"create_at": "2024-10-28T03:49:28Z",
"modify_at": "2024-10-28T03:49:28Z",
"customer_id": "cus_1JA7UDDQG3800",
"cancel_at_period_end": null,
"current_period_end": null,
"current_period_start": null,
"latest_invoice": null,
"first_invoice_id": null,
"cancel_at": null,
"canceled_at": null,
"collection_method": "charge_automatically",
"days_until_due": null,
"ended_at": null,
"cancellation_details": null,
"invoice_now": null
}Modified at 2025-01-13 12:05:57