Pause a subscription

This endpoint pauses an active subscription, immediately, at the end of the current billing cycle, or on a specific date, depending on pause_policy. While paused, the subscription does not generate new charges.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique ID of the subscription to pause.

Body Params
date-time

Date on which the pause will take effect. Required only when pause_policy is pause_at.

string
enum
required

Indicates when the pause should take effect.

Allowed:
string

Reason for the pause, for auditing purposes.

Headers
string
required

Authentication key used to access the API.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json