Skip to navigation

Create a pricingGroup

Requires the PRICING_PLAN.UPDATE, QUOTE.PRICING_PLAN_SCHEDULE.UPDATE or PRICING_PLAN_SCHEDULE.UPDATE permission. Which one depends on what it belongs to, directly or through its pricing group: a pricing plan version requires PRICING_PLAN.UPDATE; the schedule of a QUOTE subscription requires QUOTE.PRICING_PLAN_SCHEDULE.UPDATE; the schedule of a BILLING subscription and the schedule of a TEMPLATE subscription require PRICING_PLAN_SCHEDULE.UPDATE.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
pricing_plan_version_idstring or nullOptional

Resource ID of type PRICING_PLAN_VERSION

pricing_plan_schedule_idstring or nullOptional

Resource ID of type PRICING_PLAN_SCHEDULE

namestring or nullOptional
product_typeenum or nullOptional
Allowed values:
selection_constraintenum or nullOptional
Allowed values:
display_orderinteger or nullOptional
pricingslist of objects or nullOptional

Response

Created
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
pricing_plan_version_idstring or nullOptional

Resource ID of type PRICING_PLAN_VERSION

pricing_plan_schedule_idstring or nullOptional

Resource ID of type PRICING_PLAN_SCHEDULE

namestring or nullOptional
product_typeenum or nullOptional
Allowed values:
selection_constraintenum or nullOptional
Allowed values:
display_orderinteger or nullOptional
pricingslist of objects or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error