Needs the read scope.
Call
- Tool:
get_order - Scope:
read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
order |
object |
Yes |
{
"type": "object",
"properties": {
"order": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"order"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
renewed_subscription_ids |
array of string |
Yes | The subscriptions it paid a later period of; empty for a first purchase, an upgrade or a fresh start. |
has_receipt |
boolean |
Yes | |
item_count |
number |
Yes | |
items |
array of object |
Yes | |
refunded |
number |
Yes | Every refund summed, past the preview. |
refund_status |
string or null |
Yes | How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing. |
refund_count |
number |
Yes | |
refunds |
array of object |
Yes | |
id |
string |
Yes | |
number |
number |
Yes | |
currency |
string |
Yes | |
exponent |
number or null |
Yes | |
amount |
number |
Yes | |
discount |
number |
Yes | |
total |
number |
Yes | |
source |
string |
Yes | |
note |
string or null |
Yes | |
statements |
object |
Yes | |
occurred_at |
string or null |
Yes |
The answer’s full shape is on its API reference page.