Create a pricing plan group

POST

/v:version/pricing-plan-groups

POST

/v:version/pricing-plan-groups

$ curl -X POST https://test.api.solvimon.com/v1/pricing-plan-groups \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "reference": "pricing_plan_group_test_reference",
>   "upgrade_type": "NEXT_BILLING_PERIOD",
>   "downgrade_type": "NEXT_BILLING_PERIOD",
>   "cancellation_type": "NEXT_BILLING_PERIOD",
>   "name": "Pricing Plan Group Test",
>   "status": "ACTIVE",
>   "pricing_plans": [
>     {
>       "pricing_plan_id": "ppla_hwDeeN0v4ZDbaIAZAQ1r",
>       "order": 1
>     },
>     {
>       "pricing_plan_id": "ppla_cwDeeN0v4ZDaN8ASBT1k",
>       "order": 2
>     }
>   ]
> }'

1 {
2   "object_type": "string",
3   "id": "string",
4   "reference": "string",
5   "name": "string",
6   "status": "DRAFT",
7   "upgrade_type": "IMMEDIATE",
8   "downgrade_type": "IMMEDIATE",
9   "cancellation_type": "IMMEDIATE",
10   "pricing_plans": [
11     {
12       "pricing_plan_id": "string",
13       "order": 1
14     }
15   ],
16   "created_at": "string",
17   "updated_at": "string"
18 }

Requires the PRICING_PLAN_GROUP.CREATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

referencestringRequiredformat: "^\S+$"0-256 characters

Unique reference for this pricing plan group

upgrade_typeenum or nullRequired

How an upgrade between member plans of this group is handled

downgrade_typeenum or nullRequired

How a downgrade between member plans of this group is handled

cancellation_typeenum or nullRequired

How the cancellation of a member plan of this group is handled

namestring or nullOptional

Optional name for this pricing plan group

statusenum or nullOptional

The status of the pricing plan group. Customers can only upgrade/downgrade between member plans while the group is ACTIVE.

pricing_planslist of objects or nullOptional

The ordered set of pricing plans that are members of this group

Response

Created

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

referencestringOptionalformat: "^\S+$"0-256 characters

Unique reference for this pricing plan group

namestring or nullOptional

Optional name for this pricing plan group

statusenum or nullOptional

The status of the pricing plan group. Customers can only upgrade/downgrade between member plans while the group is ACTIVE.

upgrade_typeenum or nullOptional

How an upgrade between member plans of this group is handled

downgrade_typeenum or nullOptional

How a downgrade between member plans of this group is handled

cancellation_typeenum or nullOptional

How the cancellation of a member plan of this group is handled

pricing_planslist of objects or nullOptional

The ordered set of pricing plans that are members of this group

created_atstring or nullOptionalRead-only

updated_atstring or nullOptionalRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors