v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB

Subscriptions

Cancel subscription

Cancel a subscription either immediately or at the end of the billing period.

post/api/v1/subscriptions/{subscription_id}/cancel

Path parameters

subscription_idstring MeteroidId required

Example:sub_7n42DGM5Tflk9n8mt7Fhc7

Subscription ID

Request body

effective_datestring date nullable

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

reasonstring nullable

Response

Subscription canceled

Example response

{
  "subscription": {
    "currency": "EUR",
    "customer_id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
    "id": "sub_7n42DGM5Tflk9n8mt7Fhc7",
    "payment_methods_config": {
      "account_id": "ba_7n42DGM5Tflk9n8mt7Fhc7"
    },
    "plan_id": "plan_7n42DGM5Tflk9n8mt7Fhc7",
    "plan_version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7"
  }
}