Subscriptions

Resume subscription

Resumes a subscription that is pending cancellation or is already canceled.

If the subscription is in a CANCELED state:

  • An immediate charge for the subscription amount will be trigered.
  • If the charge is unsuccessful, the subscription will be moved to PASTDUE status until a charge is successful.
  • If all charge retry attempts fail, the subscription will be become CANCELED once again. If the subscription is in the PENDING cancellation state:
  • The existing billing cycle will remain in place
patch/subscriptions/{id}/resume

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/subscriptions/{id}/resume
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

The unique identifier of the subscription

Request body

ResumeSubscriptionRequest required

Response

When request is accepted. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

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