Product Catalog

Update plan

Updates the details of the specified plan. Note you can't update the details of a plan once it's in use.

put/plans/{planId}

Request

Base URL
https://api.app.subskribe.com
URL
https://api.app.subskribe.com/plans/{planId}
Auth
API key in header X-API-Key

Path parameters

planIdstring required

id of the plan

Request body

idstring

System-generated unique identifier for the plan

entityIdsstring[]

Array of entity IDs associated with this plan

namestring required

Unique name of the plan

displayNamestring

Display name of the plan shown to customers

descriptionstring

Detailed description of the plan

status'DRAFT' | 'ACTIVE' | 'GRANDFATHERED' | 'ARCHIVED' | 'DEPRECATED' required

Status of the plan: DRAFT, ACTIVE, GRANDFATHERED, ARCHIVED, or DEPRECATED. Set the status to DRAFT when creating a new plan.

productIdstring required

ID of the product this plan is associated with

currencystring

Currency code for this plan (defaults to system default if not specified)

externalIdstring

External identifier for the plan, used for integration with other systems

templateIdsstring[]

List of template IDs associated with this plan

replacementPlanIdsstring[]

IDs of plans that can replace this plan during upgrades/downgrades

customFieldsobject

Map of custom fields associated with this plan

updatedOninteger

Timestamp of when the plan was last updated (in seconds since epoch)

eventObjectIdstring

Response

successful operation