Update plan

Update an existing plan's properties. This endpoint updates plan-level configuration but does NOT include products. Use the dedicated product endpoints for product management.

For draft plans: Updates plan in place For active plans: Creates new version and applies updates

Path Params
uuid
required
Body Params
length between 1 and 255

Plan name

display_config

Display configuration

ISO 8601 duration (P1M, P1Y)

renewal_config

Renewal configuration

custom_attributes

Custom metadata

trial_config

Trial configuration

discounts

Plan-wide discounts

taxes

Tax configuration

commitments

Commitment requirements

payment_config

Payment configuration

billing_config

Billing configuration

enum

Provisioning mode determining when/how contract is created

enum

Plan status

Three-letter ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')

Business entity ID

products

Products to upsert (by pricing_id: exists = update, new = add)

Responses

404

Plan not found

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