Skip to main content
PATCH
Update subscription

Authorizations

Authorization
string
header
required

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

Path Parameters

subscription_id
string<MeteroidId>
required

Subscription ID

Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"

Body

application/json
auto_advance_invoices
boolean | null

If false, invoices will stay in Draft until manually reviewed and finalized.

charge_automatically
boolean | null

Automatically try to charge the customer's configured payment method on finalize.

custom_properties
any

Partial update of custom property values (merge; send a key with null to remove it). Validated against the tenant's SUBSCRIPTION property definitions. Omit to leave unchanged.

invoice_memo
string | null

Default memo for invoices

net_terms
integer<int32> | null

Payment terms in days (0 = due on issue)

Required range: x >= 0
payment_methods_config
object

Payment methods configuration (Online, BankTransfer, or External)

purchase_order
string | null

Purchase order number

Response

Subscription updated

subscription
object
required