Plans

Create plan

Creates a new plan in draft status.

post/api/v1/plans

Request body

idstring required

The unique identifier for the entity

displayNamestring required

The display name of the package

descriptionstring nullable

The description of the package

productIdstring required

The product ID to associate the plan with

parentPlanIdstring nullable

The ID of the parent plan, if applicable

pricingType'FREE' | 'PAID' | 'CUSTOM' nullable

The pricing type of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

status'DRAFT' | 'PUBLISHED' | 'ARCHIVED'

The status of the package

metadataobject

Metadata associated with the entity

Response

The newly created plan object.

Changes