Passer au contenu principal
PATCH
JavaScript

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

subscription_id
string
requis

Subscription Id

Corps

application/json
billing
null | object
cancel_at_next_billing_date
boolean | null

When set, the subscription will remain active until the end of billing period

cancel_reason
null | enum<string>
Options disponibles:
cancelled_by_customer,
cancelled_by_merchant,
cancelled_by_merchant_send_dunning,
dodo_team
cancellation_comment
string | null

Free-text cancellation comment (only valid when cancelling or scheduling cancellation).

cancellation_feedback
null | enum<string>

Customer-supplied churn reason (only valid when cancelling or scheduling cancellation).

Options disponibles:
too_expensive,
missing_features,
switched_service,
unused,
customer_service,
low_quality,
too_complex,
other
credit_entitlement_cart
object[] | null

Update credit entitlement cart settings

customer_business_name
string | null

Optional business / legal name associated with the tax id. When provided together with a valid tax id for a B2B subscription, this name is rendered on the invoice instead of the customer's personal name. Send null to explicitly clear the business name.

customer_name
string | null
disable_on_demand
null | Disable On Demand Request · object
metadata
null | Metadata · object

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

next_billing_date
string<date-time> | null
status
null | enum<string>
Options disponibles:
pending,
active,
on_hold,
cancelled,
failed,
expired
subscription_period_count
integer<int32> | null

New number of subscription_period_interval units the subscription entitlement should span. Used together with subscription_period_interval to extend the subscription period. The resulting period must not be shorter than the current one (this endpoint only extends).

subscription_period_interval
null | enum<string>

New interval unit for the subscription period. When changing the period, this may be supplied alongside subscription_period_count; if omitted the existing interval is retained.

Options disponibles:
Day,
Week,
Month,
Year
tax_id
string | null

Réponse

Subscription successfully updated

Response struct representing subscription details

addons
Addon Cart Response Item · object[]
requis

Addons associated with this subscription

billing
object
requis

Billing address details for payments

brand_id
string
requis

Brand id this subscription belongs to

cancel_at_next_billing_date
boolean
requis

Indicates if the subscription will cancel at the next billing date

created_at
string<date-time>
requis

Timestamp when the subscription was created

credit_entitlement_cart
object[]
requis

Credit entitlement cart settings for this subscription

currency
enum<string>
requis

Currency used for the subscription payments

Options disponibles:
AED,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BYN,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STN,
SVC,
SZL,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
customer
object
requis

Customer details associated with the subscription

metadata
Metadata · object
requis

Additional custom data associated with the subscription

meter_credit_entitlement_cart
object[]
requis

Meter credit entitlement cart settings for this subscription

meters
object[]
requis

Meters associated with this subscription (for usage-based billing)

next_billing_date
string<date-time>
requis

Timestamp of the next scheduled billing. Indicates the end of current billing period

on_demand
boolean
requis

Wether the subscription is on-demand or not

payment_frequency_count
integer<int32>
requis

Number of payment frequency intervals

payment_frequency_interval
enum<string>
requis

Time interval for payment frequency (e.g. month, year)

Options disponibles:
Day,
Week,
Month,
Year
previous_billing_date
string<date-time>
requis

Timestamp of the last payment. Indicates the start of current billing period

product_id
string
requis

Identifier of the product associated with this subscription

quantity
integer<int32>
requis

Number of units/items included in the subscription

recurring_pre_tax_amount
integer<int32>
requis

Amount charged before tax for each recurring payment in the currency's smallest unit (cents for USD, yen for JPY, fils for KWD)

status
enum<string>
requis

Current status of the subscription

Options disponibles:
pending,
active,
on_hold,
cancelled,
failed,
expired
subscription_id
string
requis

Unique identifier for the subscription

subscription_period_count
integer<int32>
requis

Number of subscription period intervals

subscription_period_interval
enum<string>
requis

Time interval for the subscription period (e.g. month, year)

Options disponibles:
Day,
Week,
Month,
Year
tax_inclusive
boolean
requis

Indicates if the recurring_pre_tax_amount is tax inclusive

trial_period_days
integer<int32>
requis

Number of days in the trial period (0 if no trial)

cancellation_comment
string | null

Free-text cancellation comment, if any

cancellation_feedback
null | enum<string>

Customer-supplied churn reason, if any

Options disponibles:
too_expensive,
missing_features,
switched_service,
unused,
customer_service,
low_quality,
too_complex,
other
cancelled_at
string<date-time> | null

Cancelled timestamp if the subscription is cancelled

custom_field_responses
object[] | null

Customer's responses to custom fields collected during checkout

customer_business_name
string | null

Business / legal name associated with the tax id (B2B). When set this is used on the invoice in place of the customer's personal name.

discount_cycles_remaining
integer<int32> | null

DEPRECATED: Use discounts[].cycles_remaining instead.

discount_id
string | null

DEPRECATED: Use discounts instead. Returns the first discount's ID if present.

discounts
object[] | null

All stacked discounts applied, ordered by position

expires_at
string<date-time> | null

Timestamp when the subscription will expire

payment_method_id
string | null

Saved payment method id used for recurring charges

scheduled_change
null | object

Scheduled plan change details, if any

tax_id
string | null

Tax identifier provided for this subscription (if applicable)

Dernière modification le 1 avril 2026