HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

User / Cancel subscription

post
https://{tenantUrl}/public-api/actions/users/v1.0//cancel-subscription

Cancels renewal of the user's subscription. The subscription and its benefits remain active until the current billing period ends. Use the terminate subscription action when benefits must end immediately.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

the user ID for whom to cancel the subscription

Body Params
string
required

The reason for the cancellation. It would be included in the Audit logs.

churnReason
object

Optional churn reason for the user's exit. It is kept with the subscription and applied to the exit recorded when the subscription ends; reactivating the subscription discards it. The reason must apply to users. Custom reasons allow the chose_to_leave, forced and circumstances_changed exit types. Send an empty object or omit it to keep no reason. It is not included in the Audit logs.

Responses
202

Action accepted

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?