Skip to main content

Deactivate Subscriber

Manually deactivates a subscriber on a plan. After deactivation, no new renewal invoices will be generated until the subscriber is reactivated via Activate Subscriber.

Already-issued invoices that have not yet been paid are not cancelled — they run out their lifetime (7 days for subscription invoices) and become expired.

Calling deactivate on a subscriber who is already inactive has no effect.

POST/api/subscriptions/%plan_id%/users/%user_id%/deactivateAuth: Required

Response

Returns the updated subscriber record:

idstring

Subscriber identifier.

emailstring

Subscriber's email.

statusstring

New status — inactive after a successful deactivation.

subscribedDatestring

Date the subscriber was attached to the plan.

renewalDatestring

Last scheduled renewal date.

revenueAmountstring

Total revenue from this subscriber.

revenueAssetstring

Currency of revenueAmount.

createdAtstring

Record creation timestamp.

updatedAtstring

Last update timestamp.