v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Subscriptions

Cancel a subscription

Cancels an active subscription with the given subscription_id.

delete/subscriptions/{subscription_id}

Path parameters

subscription_idstring required

Example:1abc2DE_FGhIjKLm3NoPQR

Unique identifier for the subscription.

Query parameters

billingPeriod0 | 1

Defines when the subscription cancellation should occur:

Default (End of billing period): 1 - Cancels the subscription at the end of the current billing period.
Immediate Cancellation: 0 - Cancels the subscription immediately.

Response

Subscription canceled successfully.

Example response

{
  "subscriptions": [
    {
      "subscription": "1abc2DE_FGhIjKLm3NoPQR",
      "action": "subscription.cancel",
      "result": "success"
    }
  ]
}