Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
23 lines
888 B
Plaintext
23 lines
888 B
Plaintext
---
|
|
displayed_sidebar: pricingReference
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# PricingContext
|
|
|
|
The context to calculate prices. For example, you can specify the currency code to calculate prices in.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "context",
|
|
"type": "Record<`string`, `string` \\| `number`\\>",
|
|
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in. Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"children": []
|
|
}
|
|
]} />
|