Achievements7

Coupons7

Creators8

Daily Rewards6

Disputes1

Fraud Alerts1

GDPR Requests2

Item Categories7

Items9

Leaderboards8

LiveOps10

Locales5

Loyalty Program5

News7

Orders6

Pages8

Payments1

Payments' Dispute Evidence3

Players6

Players' Marketing Consents2

Players' Store Items1

Players' Subscriptions5

Price Points1

Price Templates5

Segmentation11

Store Promotions9

Stores15

Translation Glossaries5

Users6

Videos5

Webhooks7

Orders

Get Orders

Returns a list of orders.

get/v1/orders

Query parameters

start_atinteger

Optional start of the time range to filter by order creation time, in Unix timestamp format (seconds)

end_atinteger

Optional end of the time range to filter by order creation time, in Unix timestamp format (seconds)

platform'any' | 'ios' | 'android' | 'other'

Optional platform to filter orders by (e.g. ios, android, other).

limitinteger

A limit on the number of objects to be returned

offsetinteger

Deprecated, use start_after_id. The number of objects to skip

start_after_idstring

The id of the last object of the previous page. The response starts with the object that follows it.

Response

Successful Response

idstring required

The unique ID of the order.

player_idstring required

The unique identifier for the player who placed the order.

amountinteger required

The amount of the order in minor currency units.

currency'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC' required

amount_usdinteger nullable

The amount of the order in USD cents. Before payment it is an estimate converted from the order currency and may change once the order is paid.

emailstring nullable

The player's email address.

locale'cs' | 'de' | 'en' | 'es' | 'fr' | 'fr-CA' | 'hi' | 'id' | 'it' | 'ja' | 'ko' | 'ms' | 'nl' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ru' | 'sv' | 'th' | 'tr' | 'uk' | 'vi' | 'zh' | 'zh-Hant'

Language codes according to ISO 639-1.

countrystring nullable

The two-letter country code (ISO 3166-1 alpha-2) of the order.

ip_addressstring nullable

The IP address of the player who placed the order.

payment_numberstring nullable

The payment number associated with the order.

platform'any' | 'ios' | 'android' | 'other'

sales_channel'game_hub' | 'checkout' | 'android_sdk' | 'checkout_link' required

created_atinteger required

Order creation date in Unix epoch time.

opened_atinteger nullable

The date the player first opened the order's checkout page, in Unix epoch time (seconds).

Changes

Changed in 7 of the 28 revisions of this API.411

Sep 23, 20261816e2044c071See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 18, 2026fb9750c99d0a4See the full diff
- ●
  for the query request parameter start_after_id, the maxLength was set to 32
  request-parameter-max-length-set
- ●
  for the query request parameter limit, the max was set to 300.00
  request-parameter-max-set
- ●
  for the query request parameter limit, the min was set to 1.00
  request-parameter-min-set
- ●
  for the query request parameter offset, the min was set to 0.00
  request-parameter-min-set
Sep 16, 20266d6269f8cab62See the full diff
- ○
  added the new optional query request parameter start_after_id
  new-optional-request-parameter
- ○
  query request parameter offset was deprecated
  request-parameter-deprecated
Sep 4, 20262fecf8a6aa0b1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 3, 2026ff170234e3c12See the full diff
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
Aug 27, 2026d8b885323f9e4See the full diff
- ○
  added the new optional query request parameter end_at
  new-optional-request-parameter
- ○
  added the new optional query request parameter platform
  new-optional-request-parameter
- ○
  added the new optional query request parameter start_at
  new-optional-request-parameter
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Aug 7, 20266402c25762c81See the full diff
- ○
  endpoint added
  endpoint-added

Full history