v1
latestOpenAPI 3.0.32026-07-24614422630.2 KBUpdate plan
Updates the details of the specified plan. Note you can't update the details of a plan once it's in use.
Path parameters
id of the plan
Request body
System-generated unique identifier for the plan
Array of entity IDs associated with this plan
Unique name of the plan
Display name of the plan shown to customers
Detailed description of the plan
Status of the plan: DRAFT, ACTIVE, GRANDFATHERED, ARCHIVED, or DEPRECATED. Set the status to DRAFT when creating a new plan.
ID of the product this plan is associated with
Currency code for this plan (defaults to system default if not specified)
External identifier for the plan, used for integration with other systems
List of template IDs associated with this plan
IDs of plans that can replace this plan during upgrades/downgrades
Map of custom fields associated with this plan
Timestamp of when the plan was last updated (in seconds since epoch)
Response
successful operation
System-generated unique identifier for the plan
Array of entity IDs associated with this plan
Unique name of the plan
Display name of the plan shown to customers
Detailed description of the plan
Status of the plan: DRAFT, ACTIVE, GRANDFATHERED, ARCHIVED, or DEPRECATED. Set the status to DRAFT when creating a new plan.
ID of the product this plan is associated with
Currency code for this plan (defaults to system default if not specified)
External identifier for the plan, used for integration with other systems
List of template IDs associated with this plan
IDs of plans that can replace this plan during upgrades/downgrades
Map of custom fields associated with this plan
Timestamp of when the plan was last updated (in seconds since epoch)