query · Module: Pricing · Requires pricing:read
Arguments
| Argument | Type | Description |
|---|---|---|
type | String | Filter by type. |
status | String | Filter by status. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
PricingRuleList!
| Field | Type |
|---|---|
data | [PricingRule!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query PricingRules($limit: Int) {
pricingRules(limit: $limit) {
data {
id
object
name
type
status
livemode
created
updated
adjustment {
type
rate
amount {
amount
currency
}
basis
}
conditions {
accounts
levels
carriers
services
connections
destination_zones
}
floor {
margin {
type
rate
}
}
priority
visible
effective_from
effective_until
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"pricingRules": {
"data": [
{
"id": "prule_1a2B3c",
"object": "pricing_rule",
"name": "Example",
"type": "markup",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"adjustment": {
"type": "percentage",
"rate": 0.145,
"amount": {
"amount": 1299,
"currency": "usd"
},
"basis": "example"
},
"conditions": {
"accounts": [
"example"
],
"levels": [
"example"
],
"carriers": [
"example"
],
"services": [
"example"
],
"connections": [
"example"
],
"destination_zones": [
"example"
]
},
"floor": {
"margin": {
"type": "example",
"rate": 0.145
}
},
"priority": 100,
"visible": true,
"effective_from": "2026-10-07",
"effective_until": "2026-10-07"
}
],
"has_more": true
}
}
}