Skip to main content

Create subscription

Create subscription, by adding product plans to a bundle.

Path Parameters
bundleId uuid — REQUIRED
Header Parameters
organization-id uuid — REQUIRED

ID of organization context this request belongs to.

Request Body — REQUIRED
planIds uuid[]
Responses
200

Subscription successfully created

Schema — OPTIONAL
accesses object[] — OPTIONAL
accessExchangeType string — OPTIONAL

Possible values: [GENERATE_TOKEN, MANUAL_EXCHANGE]

accessStatus object[] — OPTIONAL
statusValue string — OPTIONAL

Possible values: [ACTIVATION_REQUESTED, ACTIVE, DEACTIVATION_REQUESTED, INACTIVE]

createdAt date-time — OPTIONAL
createdBy uuid — OPTIONAL
note string — OPTIONAL
authenticator — OPTIONAL
createdAt date-time — OPTIONAL
createdBy uuid — OPTIONAL
id uuid — OPTIONAL
name string — OPTIONAL
productIds uuid[] — OPTIONAL
approvals object[] — OPTIONAL
approvalStatus string — OPTIONAL

Possible values: [REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, IN_TERMINATION_CONFIRMED, TERMINATED, TERMINATED_CONFIRMED]

createdAt date-time — OPTIONAL
createdBy uuid — OPTIONAL
note string — OPTIONAL
bundleProducts object[] — OPTIONAL
accessDefinitionId uuid — OPTIONAL
colour string — OPTIONAL
createdAt date-time — OPTIONAL
description string — OPTIONAL
detailedDescription string — OPTIONAL
id uuid — OPTIONAL
name string — OPTIONAL
publiclyAvailable boolean — OPTIONAL
subscriptions object[] — OPTIONAL
approvals object[] — OPTIONAL
approvalStatus string — OPTIONAL

Possible values: [REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, IN_TERMINATION_CONFIRMED, TERMINATED, TERMINATED_CONFIRMED]

createdAt date-time — OPTIONAL
createdBy uuid — OPTIONAL
note string — OPTIONAL
id uuid — OPTIONAL
planDescription string — OPTIONAL
planId uuid — OPTIONAL
planName string — OPTIONAL
planType string — OPTIONAL

Possible values: [STATIC, DYNAMIC]

validUntil date-time — OPTIONAL
bundleStatus string — OPTIONAL

Possible values: [DRAFT, REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED]

Use: contractStatus

businessCases object[] — OPTIONAL
businessCaseKey string — OPTIONAL

Possible values: [USE_CASE, ADDED_VALUE, TRAFFIC]

pendingText string — OPTIONAL
text string — OPTIONAL
contact object — OPTIONAL
id uuid — OPTIONAL
createdAt date-time — OPTIONAL
createdById uuid — OPTIONAL
defaultContact boolean — OPTIONAL
email string — OPTIONAL
name string — OPTIONAL
phone string — OPTIONAL
contractStatus string — OPTIONAL

Possible values: [DRAFT, REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED]

createdAt date-time — OPTIONAL
createdById uuid — OPTIONAL
description string — OPTIONAL
iconPath string — OPTIONAL
id uuid — OPTIONAL
name string — OPTIONAL
organizationId uuid — OPTIONAL
accessStatus object — OPTIONAL
access boolean — OPTIONAL
accessNote string — OPTIONAL
providerId uuid — OPTIONAL
providerOrganization object — OPTIONAL
email string — OPTIONAL
id uuid — OPTIONAL
name string — OPTIONAL
provider boolean — OPTIONAL
active boolean — 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