Cancel subscription

Cancels an active subscription, either immediately or at a specified time such as end of billing period.

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

Path parameters

idstring required

The unique identifier of the entity

endDatestring date-time

Subscription end date

cancellationAction'DEFAULT' | 'REVOKE_ENTITLEMENTS'

Action on cancellation (downgrade or revoke)

cancellationTime'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE'

When to cancel (immediate, period end, or date)

prorateboolean

If set, enables or disables prorating of credits on subscription cancellation.

The subscription object reflecting the cancellation.