The price object

A comprehensive list of the price resource's attributes and relationships

A price object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/prices endpoint.

Fields

Field	Type	Description
type	string	prices
id	string	The price unique identifier
links.self	string	The price endpoint URL
attributes.currency_code	string	The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated price list.
attributes.sku_code	string	The code of the associated SKU. When creating a price, either a valid sku_code or a SKU relationship must be present.
attributes.amount_cents	integer	The SKU price amount for the associated price list, in cents.
attributes.amount_float	float	The SKU price amount for the associated price list, float.
attributes.formatted_amount	string	The SKU price amount for the associated price list, formatted.
attributes.original_amount_cents	integer	The SKU price amount for the associated price list, in cents before any applied rule.
attributes.formatted_original_amount	string	The SKU price amount for the associated price list, in cents before any applied rule, formatted.
attributes.compare_at_amount_cents	integer	The compared price amount, in cents. Useful to display a percentage discount.
attributes.compare_at_amount_float	float	The compared price amount, float.
attributes.formatted_compare_at_amount	string	The compared price amount, formatted.
attributes.processed_at	datetime	Time at which the resource was processed by API.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.rules	object	The rules (using Rules Engine) to be applied.
attributes.rule_outcomes	object	The rule outcomes.
attributes.resource_payload	object	The payload used to evaluate the rules.
attributes.jwt_custom_claim	object	The custom_claim attached to the current JWT (if any).
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.price_list	object	The associated price list.
relationships.sku	object	The associated SKU. When creating a price, either a SKU relationship or a valid sku_code must be present.
relationships.price_tiers	array	The associated price tiers.
relationships.price_volume_tiers	array	The associated price volume tiers.
relationships.price_frequency_tiers	array	The associated price frequency tiers.
relationships.attachments	array	The associated attachments.
relationships.versions	array	The associated changes.
relationships.jwt_customer	object	The customer associated to the JWT.
relationships.jwt_markets	array	The markets associated to the JWT.
relationships.jwt_stock_locations	array	The stock locations associated to the JWT.
meta.mode	string	The resource environment (can be one of test or live)