pricingPlanGroups

Archive a pricing plan group

Requires the PRICING_PLAN_GROUP.STATUS.UPDATE permission.

patch/v{version}/pricing-plan-groups/{resourceIdOrReference}/archive

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/pricing-plan-groups/{resourceIdOrReference}/archive
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdOrReferencestring required

The ID or reference of the resource.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
referencestring

Unique reference for this pricing plan group

namestring nullable

Optional name for this pricing plan group

status'DRAFT' | 'ACTIVE' | 'DEPRECATED' | 'ARCHIVED'

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

upgrade_type'IMMEDIATE' | 'IMMEDIATE_PRO_RATA' | 'NEXT_BILLING_PERIOD' | 'NOT_ALLOWED'

How an upgrade between member plans of this group is handled

downgrade_type'IMMEDIATE' | 'IMMEDIATE_PRO_RATA' | 'NEXT_BILLING_PERIOD' | 'NOT_ALLOWED'

How a downgrade between member plans of this group is handled

cancellation_type'IMMEDIATE' | 'IMMEDIATE_PRO_RATA' | 'NEXT_BILLING_PERIOD' | 'NOT_ALLOWED'

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

created_atstring nullable
updated_atstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.