Configuration APIPricing Plans

Update or create a pricing plan (upsert)

Requires the PRICING_PLAN.CREATE or PRICING_PLAN.UPDATE permission.

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.
referencestringRequiredformat: "^\S+$"0-256 characters
namestring or nullOptionalformat: "^.*$"0-256 characters
descriptionstring or nullOptionalformat: "^.*$"0-256 characters
customer_idstring or nullOptional
Resource ID of type CUSTOMER
typeenum or nullOptional
amount_typeenumOptional
Set to determine whether the pricings in this pricing plan are including or excluding tax. The default, if left empty, is excluding tax.
pricing_plan_selection_ruleslist of objects or nullOptional
pricing_currencieslist of enums or nullOptional
The default alphabetic currency code representing the type of currency that can be used for the pricings.

Response

Created
object_typestring or nullRead-only
idstring or nullRead-only
referencestringformat: "^\S+$"0-256 characters
namestring or nullformat: "^.*$"0-256 characters
descriptionstring or nullformat: "^.*$"0-256 characters
customer_idstring or null
Resource ID of type CUSTOMER
typeenum or null
amount_typeenum
Set to determine whether the pricings in this pricing plan are including or excluding tax. The default, if left empty, is excluding tax.
pricing_plan_version_infoslist of objects or nullRead-only
pricing_plan_selection_ruleslist of objects or null
pricing_currencieslist of enums or null
The default alphabetic currency code representing the type of currency that can be used for the pricings.
variantenum or nullRead-only

Errors

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