Authorizations
Path Parameters
Body
application/json
Response
Successful response
The response is of type object
.
curl --request POST \
--url https://app.flowglad.com/api/v1/subscriptions/{id}/cancel \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"cancellation": {
"timing": "<string>"
}
}'
{
"subscription": {
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "<string>",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<string>",
"currentBillingPeriodStart": "<string>",
"currentBillingPeriodEnd": "<string>",
"metadata": {},
"canceledAt": "<string>",
"cancelScheduledAt": "<string>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": "<any>",
"billingCycleAnchorDate": "<string>",
"name": "<string>",
"renews": true,
"current": true
}
}
curl --request POST \
--url https://app.flowglad.com/api/v1/subscriptions/{id}/cancel \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"cancellation": {
"timing": "<string>"
}
}'
{
"subscription": {
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "<string>",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<string>",
"currentBillingPeriodStart": "<string>",
"currentBillingPeriodEnd": "<string>",
"metadata": {},
"canceledAt": "<string>",
"cancelScheduledAt": "<string>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": "<any>",
"billingCycleAnchorDate": "<string>",
"name": "<string>",
"renews": true,
"current": true
}
}
Successful response
The response is of type object
.
Was this page helpful?