WEweb2wave

Cancel a subscription

Cancel an active subscription in the payment system.

put/subscription/cancel

Request

  • Base URL
    https://api.web2wave.com/api
  • URL
    https://api.web2wave.com/api/subscription/cancel
  • Auth
    API key in header api_key

Request body

pay_system_idstring

ID of the subscription in external Stripe/Paddle/PayPal, e.g. sub_1PzNJzCsRq5tBi2bbfNsAf86or I-H7HC902MYM49

commentstring

Optional comment for the cancellation.

cancel_at_period_endboolean

If true, the subscription will be canceled at the end of the current billing period. If false or not provided, the subscription will be canceled immediately.

Example request

{
  "cancel_at_period_end": true
}

Response

Subscription canceled successfully.

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.