Cancel a subscription

Cancel a subscription owned by the authenticated customer. By default the subscription is scheduled to cancel at the end of the current billing period — set cancel_at_period_end=false to cancel immediately. Idempotent — cancelling an already-canceled subscription is a no-op that returns the current state.

Related endpoints

• POST /customer-portal/sessions — Create a customer-portal session
• GET /customer-portal/customer — Retrieve the authenticated customer
• GET /customer-portal/subscriptions — List the authenticated customer's subscriptions
• GET /customer-portal/subscriptions/{id} — Retrieve a subscription
• GET /customer-portal/invoices — List the authenticated customer's invoices
• GET /customer-portal/invoices/{id} — Retrieve an invoice

Common errors

• 401 unauthenticated — missing, malformed, or revoked API key.
• 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

curl -X POST "https://api.revkeen.com/v2/customer-portal/subscriptions/00000000-0000-0000-0000-000000000000/cancel" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "cancel_at_period_end": true,    "reason": "string"  }'

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "object": "subscription",
    "status": "string",
    "currency": "string",
    "amount_minor": 0,
    "interval": "string",
    "interval_count": 0,
    "current_period_start": "2019-08-24T14:15:22Z",
    "current_period_end": "2019-08-24T14:15:22Z",
    "trial_end": "2019-08-24T14:15:22Z",
    "cancel_at": "2019-08-24T14:15:22Z",
    "canceled_at": "2019-08-24T14:15:22Z",
    "started_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}