Skip to main content
GET
Get order settings
Required scope: account:read Call this in two situations:
  • Before you run API queries, so your numbers match the dashboard. The web app applies these settings to every revenue, attribution, and cohort figure, but the query endpoints only use the orderSettings you send them. Pass this endpoint’s orderSettings object as-is to Run an analytics query or Run a cohort analysis.
  • Before you change the settings. Replace order settings overwrites the whole object, so read it here, edit it, and send it all back.

What you get back

  • All four fields, always. An account that never saved settings gets the defaults: countPendingOrders: false, countVoidedOrders: false, refundDateAttribution: "refund_date", and no exclusion filters.
  • Every filter, condition group, and condition with its id, plus each filter’s createdAt and updatedAt.

How exclusion filters match

An order is excluded when it matches any enabled filter. A filter matches when any one of its condition groups matches, and a group joins its conditions with its own logic (and or or). Disabled filters are kept but have no effect.

Authorizations

x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

x-pixel-id
string
header
required

The pixel id the request targets.

Response

The current order settings.

orderSettings
object
required

Which orders count, how refunds are dated, and which orders are excluded. The web app applies these to every revenue, attribution, and cohort figure it shows. The API query endpoints don't read them, so pass them in each query's orderSettings.