Skip to main content
PATCH
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

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

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing plan. Only provided fields are updated; omitted fields keep their current value.

displayName
string

The display name of the package

Maximum string length: 255
description
string | null

The description of the package

Maximum string length: 255
billingId
string | null

The unique identifier for the entity in the billing provider

Maximum string length: 255
metadata
object

Metadata associated with the entity

parentPlanId
string | null

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.

Maximum string length: 255
defaultTrialConfig
DefaultTrialConfig · object | null

Default 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.

compatibleAddonIds
string[] | null

List of compatible addon IDs for this plan

Maximum string length: 255
charges
SetPackagePricingRequest · object

Pricing 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

data
Plan · object
required

Plan configuration object