Skip to main content
PATCH
Update Subscription

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Path Parameters

subscription_id
string
required

Body

application/json
cancel_at_period_end
boolean
default_payment_method
string
items
object[]
proration_behavior
enum<string>
Available options:
create_prorations,
none
metadata
object

Response

Subscription updated

id
string
object
enum<string>
Available options:
subscription
customer
string
status
enum<string>
Available options:
trialing,
active,
past_due,
paused,
canceled,
unpaid
current_period_start
integer
current_period_end
integer
trial_start
integer
trial_end
integer
cancel_at_period_end
boolean
canceled_at
integer
ended_at
integer
collection_method
string
days_until_due
integer
default_payment_method
string
items
object
latest_invoice
string
metadata
object
created
integer