Configuration APIPricings

Update 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
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

field_actionsmap from strings to stringsOptional
The list of actions for specific fields.

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
Allowed values:
namestring or nullOptional
product_typeenum or nullOptional
Allowed values:
display_orderinteger or nullOptional
entitlementslist of objects or nullOptional
itemslist of objects or nullOptional

Response

OK
product_idslist of strings
object_typestring or nullRead-only
idstring or nullRead-only
pricing_plan_version_idstring or null

Resource ID of type PRICING_PLAN_VERSION

pricing_plan_schedule_idstring or null

Resource ID of type PRICING_PLAN_SCHEDULE

pricing_group_idstring or null

Resource ID of type PRICING_GROUP

original_pricing_idstring or null
original_pricingobject or nullRead-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 null
Allowed values:
namestring or null
product_typeenum or null
Allowed values:
display_orderinteger or null
productslist of objects or nullRead-only
entitlementslist of objects or null
itemslist of objects or null

Errors

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