WEweb2wave

Pause a subscription

Pause an active subscription in the payment system. The subscription will be paused and no further charges will be made until it is resumed. Only available for Stripe and Paddle subscriptions.

put/subscription/pause

Request

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

Request body

pay_system_idstring required

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

behavior'keep_as_draft' | 'mark_uncollectible' | 'void'

Behavior for paused subscription (Stripe only). Options: 'keep_as_draft', 'mark_uncollectible', 'void'

Response

Subscription paused successfully.

successinteger
errorinteger
messagestring

Example response

{
  "success": 1,
  "message": "Subscription payment collection has been paused"
}

Changes

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