chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
co-authored by
olivermrbl
Shahed Nasser
parent
efdea04963
commit
658339767b
@@ -1,10 +1,11 @@
|
||||
title: Money Amount
|
||||
description: >-
|
||||
Money Amounts represents an amount that a given Product Variant can be
|
||||
purcased for. Each Money Amount either has a Currency or Region associated
|
||||
with it to indicate the pricing in a given Currency or, for fully region-based
|
||||
pricing, the given price in a specific Region. If region-based pricing is used
|
||||
the amount will be in the currency defined for the Reigon.
|
||||
A Money Amount represent a price amount, for example, a product variant's
|
||||
price or a price in a price list. Each Money Amount either has a Currency or
|
||||
Region associated with it to indicate the pricing in a given Currency or, for
|
||||
fully region-based pricing, the given price in a specific Region. If
|
||||
region-based pricing is used, the amount will be in the currency defined for
|
||||
the Region.
|
||||
type: object
|
||||
required:
|
||||
- amount
|
||||
@@ -24,14 +25,15 @@ properties:
|
||||
type: string
|
||||
example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
|
||||
currency_code:
|
||||
description: The 3 character currency code that the Money Amount is given in.
|
||||
description: The 3 character currency code that the money amount may belong to.
|
||||
type: string
|
||||
example: usd
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
description: The details of the currency that the money amount may belong to.
|
||||
x-expandable: currency
|
||||
nullable: true
|
||||
$ref: ./Currency.yaml
|
||||
amount:
|
||||
@@ -55,23 +57,23 @@ properties:
|
||||
type: integer
|
||||
example: 1
|
||||
price_list_id:
|
||||
description: The ID of the price list associated with the money amount
|
||||
description: The ID of the price list that the money amount may belong to.
|
||||
nullable: true
|
||||
type: string
|
||||
example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
|
||||
price_list:
|
||||
description: Available if the relation `price_list` is expanded.
|
||||
description: The details of the price list that the money amount may belong to.
|
||||
x-expandable: price_list
|
||||
nullable: true
|
||||
type: object
|
||||
variant_id:
|
||||
description: The id of the Product Variant contained in the Line Item.
|
||||
description: The ID of the Product Variant contained in the Line Item.
|
||||
nullable: true
|
||||
type: string
|
||||
example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
|
||||
variant:
|
||||
description: >-
|
||||
The Product Variant contained in the Line Item. Available if the relation
|
||||
`variant` is expanded.
|
||||
description: The details of the product variant that the money amount may belong to.
|
||||
x-expandable: variant
|
||||
nullable: true
|
||||
type: object
|
||||
region_id:
|
||||
@@ -80,7 +82,8 @@ properties:
|
||||
type: string
|
||||
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
||||
region:
|
||||
description: A region object. Available if the relation `region` is expanded.
|
||||
description: The details of the region that the money amount may belong to.
|
||||
x-expandable: region
|
||||
nullable: true
|
||||
type: object
|
||||
created_at:
|
||||
|
||||
Reference in New Issue
Block a user