Update a billing subscription

Update a billing subscription

ℹ️

This endpoint requires the following scope: billing_subscriptions:all

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

The ID of the billing subscription to retrieve

Body Params
boolean

To stop an in_progress billing subscription use value true.
To resume a stopped billing subscription use value false

mode
object
string
enum
string
enum

Payment method
offline means the subscription is not linked to a payment method
gocardless_direct-debit means at each new occurrence the client will be automatically debited thanks to GoCardless. To do so, you need a GoCardless account properly configured.

Allowed:
string | null
recurring_rule
object
int64

Customer identifier

customer_invoice_data
object
Responses

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