Skip to main content
POST
/
api
/
v1
/
subscriptions
/
{subscription_id}
/
cancel
Cancel subscription
curl --request POST \
  --url https://api.example.com/api/v1/subscriptions/{subscription_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effective_date": "2023-12-25",
  "reason": "<string>"
}
'
{
  "subscription": {
    "auto_advance_invoices": true,
    "billing_day_anchor": 123,
    "charge_automatically": true,
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "AED",
    "current_period_start": "2023-12-25",
    "customer_id": "<string>",
    "customer_name": "<string>",
    "id": "<string>",
    "mrr_cents": 1,
    "net_terms": 1,
    "period": "MONTHLY",
    "plan_id": "<string>",
    "plan_name": "<string>",
    "plan_version": 1,
    "plan_version_id": "<string>",
    "start_date": "2023-12-25",
    "status": "PENDING_ACTIVATION",
    "activated_at": "2023-11-07T05:31:56Z",
    "billing_start_date": "2023-12-25",
    "current_period_end": "2023-12-25",
    "customer_alias": "<string>",
    "end_date": "2023-12-25",
    "invoice_memo": "<string>",
    "payment_methods_config": {
      "type": "online",
      "config": {
        "card": {
          "enabled": true
        },
        "direct_debit": {
          "enabled": true
        }
      }
    },
    "plan_description": "<string>",
    "purchase_order": "<string>",
    "trial_duration": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscription_id
string<MeteroidId>
required

Subscription ID

Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"

Body

application/json
effective_date
string<date> | null

If not provided, the cancellation will be effective at the end of the current billing or committed period.

reason
string | null

Response

Subscription canceled

subscription
object
required