POST
/
api
/
v1
/
subscriptions
/
{id}
/
cancel
Cancel a Subscription
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
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Body

application/json

Response

Successful response

The response is of type object.