Configuration APIPricings

Create a pricing

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.
product_idslist of stringsRequired
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

pricing_group_idstring or nullOptional

Resource ID of type PRICING_GROUP

original_pricing_idstring or nullOptional
overrideenum or nullOptional
namestring or nullOptional
product_typeenum or nullOptional
display_orderinteger or nullOptional
entitlementslist of objects or nullOptional
itemslist 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

pricing_group_idstring or nullOptional

Resource ID of type PRICING_GROUP

original_pricing_idstring or nullOptional
original_pricingobject or nullOptionalRead-only

This property creates a circular reference in the Pricing schema. If you experience any issues with OpenAPI tools related to these circular references, you can try removing this property from the specification.

overrideenum or nullOptional
namestring or nullOptional
product_typeenum or nullOptional
product_idslist of stringsOptional
display_orderinteger or nullOptional
productslist of objects or nullOptionalRead-only
entitlementslist of objects or nullOptional
itemslist of objects or nullOptional

Errors

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