Sign in
latestOpenAPI 3.0.32026-08-084947174.1 KB

f9302ec2ef8a

Subscriptions

Cancel a subscription

Cancels an active subscription by its ID.

post/subscriptions/cancel/{id}

Path parameters

idinteger required

The ID of the subscription to cancel

Request body

ref_subscription_cancellation_reason_idinteger required

ID of the reason for cancelling the subscription. Use the /subscriptions/cancellation_reasons endpoint to get the list of valid IDs.

Valid IDs:

  • 2: client_request_client_dissatisfied - Customer requested cancellation. Dissatisfied with service
  • 3: internal_decision_fired_client - Internal decision. Fired Client.
  • 4: billing_error - Billing error. Duplicate charge, failed charge, etc.
  • 5: other - Other reason not listed.
  • 6: unknown - Unknown reason. Client did not provide a reason.
  • 7: system_cancelled - System cancelled (non-payment or failed payment).
  • 8: client_request_changing_to_competitor - Client switching to competitor's service.
  • 9: client_request_changing_to_individual - Client switching to individual plan.
  • 10: client_request_terminating_registration - Client terminated state registration.
  • 11: client_request_doing_themselves - Client doing service themselves.

Example request

{
  "ref_subscription_cancellation_reason_id": 2
}

Response

Subscription cancellation request received

messagestring

Example response

{
  "message": "Subscription cancellation request received."
}