Cancel Customer

Terminate all billing of an existing customer and lock the customer down unless otherwise un-cancelled. Canceling a customer also cancels subscriptions and purchases associated with that customer. Cancelling applies the same cancellationOption to the Subscriptions as was specified in the Customer Cancellation action. For example, "Full" will reverse the Customer the full value of each Subscription active on their account.

Body Params
int32
required

This is the unique id of the customer to cancel.

string
enum
required

This field defines how the system behaves when cancelling the customer's subscriptions. "None" indicates that no reversal will take place, and the system will fully earn the charges. "Unearned" will reverse the unearned revenue amounts. This is a typically partial reversal based on monthly or daily earning rules set on the plan product level at the time the subscription was created. "Full" will fully reverse all charges for the current period, regardless of how much is earned.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json