Get order settings

Return the account’s order settings — count flags for pending / voided orders, refund-date attribution, and the list of exclusion filters that drop matching orders from every analytics query.

Defaults are applied when the account has no stored orderSettings (countPendingOrders=false, countVoidedOrders=false, refundDateAttribution=refund_date, exclusionFilters=[]) so the response shape is always complete.

Required scope: account:read.

GET /accounts/api/account/settings/order

Get order settings

cURL

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/account/settings/order \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

200

{
  "orderSettings": {
    "countPendingOrders": true,
    "countVoidedOrders": true,
    "exclusionFilters": [
      {
        "name": "Exclude POS",
        "enabled": true,
        "conditionGroups": [
          {
            "conditions": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "value": "<string>"
              }
            ],
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

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

200

application/json

The current order settings.

orderSettings · object · required

Account-wide order analytics config. Drives every revenue, attribution, and cohort number across the dashboard and the public query API. Defaults when unset: countPendingOrders=false, countVoidedOrders=false, refundDateAttribution=refund_date, exclusionFilters=[].

PUT semantics are whole-object replace — any existing filter not present in the PUT body is deleted. Max 50 filters per account.

Show child attributes