Archive a pricing plan group | Solvimon

Requires the PRICING_PLAN_GROUP.STATUS.UPDATE permission.

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

versionstringRequiredDefaults to 1

version

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl -X PATCH https://test.api.solvimon.com/v1/pricing-plan-groups//archive \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"object_type": "pricing_plan_group",
3	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4	"reference": "PPG-20240601-001",
5	"name": "Enterprise Subscription Plans",
6	"status": "ARCHIVED",
7	"upgrade_type": "IMMEDIATE",
8	"downgrade_type": "IMMEDIATE",
9	"cancellation_type": "IMMEDIATE",
10	"pricing_plans": [
11	{
12	"pricing_plan_id": "plan_9876543210abcdef",
13	"order": 1
14	}
15	],
16	"created_at": "2023-11-15T09:45:00Z",
17	"updated_at": "2024-06-01T12:00:00Z"
18	}