productItems

Create a product item

Requires the PRODUCT_ITEM.CREATE permission.

post/v{version}/product-items

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/product-items
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
product_idstring nullable required

The resource ID of the product, that belongs to the product item.

namestring nullable required
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'
referencestring required
descriptionstring nullable
type'REVENUE' | 'DEDUCTION'

The type of the product item.

model_type'USAGE_BASED' | 'USAGE_BASED_CONVERSION' | 'RECURRING' | 'ONE_OFF' | 'PER_SEAT' | 'CREDITS' required
meter_value_calculation_idstring nullable

The linked meter value calculation, in case of a USAGE_BASED charge type.

report_meter_value_calculation_idsstring[] nullable

Optional reporting meter value calculations, in case of a USAGE_BASED charge type.

tax_category'STANDARD' | 'NO_TAX' | 'EXEMPT'

The default tax category applied to the product item.

display_orderinteger nullable
customer_idstring nullable

Response

Created

object_typestring nullable
idstring nullable
product_idstring nullable

The resource ID of the product, that belongs to the product item.

namestring nullable
status'DRAFT' | 'ACTIVE' | 'ARCHIVED' | 'DEPRECATED'
referencestring
descriptionstring nullable
type'REVENUE' | 'DEDUCTION'

The type of the product item.

model_type'USAGE_BASED' | 'USAGE_BASED_CONVERSION' | 'RECURRING' | 'ONE_OFF' | 'PER_SEAT' | 'CREDITS'
meter_value_calculation_idstring nullable

The linked meter value calculation, in case of a USAGE_BASED charge type.

report_meter_value_calculation_idsstring[] nullable

Optional reporting meter value calculations, in case of a USAGE_BASED charge type.

tax_category'STANDARD' | 'NO_TAX' | 'EXEMPT'

The default tax category applied to the product item.

display_orderinteger nullable
customer_idstring nullable

Changes

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