Update a plan
Updates an existing plan’s properties such as display name, description, and metadata.
Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Path Parameters
The unique identifier of the entity
1 - 255Body
Partially update an existing plan. Only provided fields are updated; omitted fields keep their current value.
The display name of the package
255The description of the package
255The unique identifier for the entity in the billing provider
255Metadata associated with the entity
The ID of the parent plan, if this plan should inherit entitlements from another plan. Optional — omit to create a standalone plan with no inherited entitlements.
255Default trial configuration for the plan. When set, subscriptions provisioned on this plan without explicit trial settings automatically start in trial for the configured duration; leave unset for no automatic trial.
List of compatible addon IDs for this plan
255Pricing configuration to set on the plan draft. Unlike the rest of this request, this is a full replace of the pricing configuration, not a merge — see SetPackagePricingRequest.
Response
The updated plan object.
Response object
Plan configuration object
Related topics
Update a plan entitlementScheduled updatesLaunch a trial for a paid plan with unlimited usage-based featuresUpdate SubscriptionUpdate a product