Skip to main content

Create a plan

Create a plan for given product

Path Parameters
productId uuid REQUIRED
Header Parameters
organization-id uuid

ID of organization context this request belongs to.

Request Body REQUIRED
description string

Possible values: length ≤ 255

name string REQUIRED

Possible values: 3 ≤ length ≤ 50

planType string REQUIRED

Possible values: [STATIC, DYNAMIC]

validity object
validFrom date-time
validUntil date-time
Responses
201

Plan created

Schema OPTIONAL
createdAt date-time OPTIONAL
createdBy uuid OPTIONAL
deleted boolean OPTIONAL
description string OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
planType string OPTIONAL

Possible values: [STATIC, DYNAMIC]

productId uuid OPTIONAL
updatedAt date-time OPTIONAL
updatedBy uuid OPTIONAL
validity object OPTIONAL
validFrom date-time OPTIONAL
validUntil date-time OPTIONAL
version string OPTIONAL
400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL