Terminate a subscription (write)
terminate_subscriptionEnd a subscription at the term's end, or specify an immediate or scheduled termination date. Termination is irreversible; use suspension for temporary pauses.
Instructions
WRITE. Terminates a ProAbono subscription. By default it takes effect at the end of the current term, so it is not an immediate loss of access: the customer keeps their rights until then, and an application that revokes access on the call is wrong. Set immediate to end it now, or termination_date to schedule it for a chosen date. A terminated subscription cannot be restarted -- suspend_subscription is the reversible one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| immediate | No | End the subscription now instead of at the end of the current term. | |
| subscription_id | Yes | Internal identifier of the subscription (Id, from list_subscriptions). | |
| termination_date | No | Schedule the termination for this date, ISO 8601. Overrides the term end. |