{"_id":"5a96ec9689442e002041119a","category":{"_id":"5a96ec9189442e0020411156","version":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5a96ec9189442e002041114d","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-02-28T17:53:21.809Z","releaseDate":"2018-02-28T17:53:21.809Z","categories":["5a96ec9189442e002041114e","5a96ec9189442e002041114f","5a96ec9189442e0020411150","5a96ec9189442e0020411151","5a96ec9189442e0020411152","5a96ec9189442e0020411153","5a96ec9189442e0020411154","5a96ec9189442e0020411155","5a96ec9189442e0020411156","5a96ec9189442e0020411157","5a96ec9189442e0020411158"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.24.2 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-24T16:21:20.969Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":51,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"1-0\": \"`currency`\",\n    \"1-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"1-3\": \"Currency code (ISO 4217).\\nSee [Currency codes](/docs/currency-codes).\",\n    \"1-2\": \"Optional\",\n    \"2-0\": \"`amount`\",\n    \"2-3\": \"Price of the SKU (contract). \\n\\nFor a 'one-time-charge' policy, you can enter a $0.00 amount. The sum $0.00 is intended for free or promotional items.\\n\\nFor all recurring charges or subscription type charge-policies, the amount must be greater than $1.00 (this is relevant for all currencies).\",\n    \"2-2\": \"Optional\",\n    \"2-1\": \"*decimal*\",\n    \"0-0\": \"`base-price`\",\n    \"0-1\": \"*boolean*\",\n    \"0-2\": \"Optional\",\n    \"0-3\": \"Determines whether the given price should be considered as the base price for currency conversion calculations.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`currency`\",\n    \"2-0\": \"`amount`\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*decimal*\",\n    \"1-2\": \"Currency code (ISO 4217).\\nSee [Currency codes](/docs/currency-codes).\",\n    \"2-2\": \"Price of the SKU (contract). \\n\\nFor a 'one-time-charge' policy, you can enter a $0.00 amount. The sum $0.00 is intended for free or promotional items.\\n\\nFor all recurring charges or subscription type charge-policies, the amount must be greater than $1.00 (this is relevant for all currencies).\",\n    \"0-0\": \"`base-price`\",\n    \"0-1\": \"*boolean*\",\n    \"0-2\": \"Determines whether the given price should be considered as the base price for currency conversion calculations.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"catalog-price","type":"basic","title":"catalog-price"}

Request

Property Name
Type
Required
Description

base-price

boolean

Optional

Determines whether the given price should be considered as the base price for currency conversion calculations.

currency

string

Optional

Currency code (ISO 4217).
See Currency codes.

amount

decimal

Optional

Price of the SKU (contract).

For a 'one-time-charge' policy, you can enter a $0.00 amount. The sum $0.00 is intended for free or promotional items.

For all recurring charges or subscription type charge-policies, the amount must be greater than $1.00 (this is relevant for all currencies).

Response

Property Name
Type
Description

base-price

boolean

Determines whether the given price should be considered as the base price for currency conversion calculations.

currency

string

Currency code (ISO 4217).
See Currency codes.

amount

decimal

Price of the SKU (contract).

For a 'one-time-charge' policy, you can enter a $0.00 amount. The sum $0.00 is intended for free or promotional items.

For all recurring charges or subscription type charge-policies, the amount must be greater than $1.00 (this is relevant for all currencies).