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

Update Order

Updates the order.

patch/v1/orders/{order_id}

Path parameters

order_idstring required

Request body

handled_by_clientboolean

Whether the order was handled/consumed by the client or not.

Response

Successful Response

idstring required

The unique ID of the order.

receipt_numberstring

The number of the payment in receipt

amountinteger required

The amount of the order.

amount_before_discountinteger required

The amount of the order before discount.

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.

player_idstring required

The unique identifier for the player making the purchase.

emailstring

The player's email address.

created_atinteger required

Order creation date in Unix epoch time.

paid_atinteger

Order payment date in Unix epoch time.

opened_atinteger nullable

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

metadataobject

The metadata object structured as key-value pairs to store additional information about the order.

expires_atinteger

Order expiration date in Unix epoch time (seconds). Orders cannot be paid after this date.

checkout_urlstring uri required

The URL to redirect the player to complete the purchase.

coupons_enabledboolean

Whether coupons are enabled for the order.

save_payment_method_enabledboolean

Whether the player is allowed to save a payment method (card, wallet) for future purchases on this order. Enabled by default.

applied_reward_pointsinteger

The applied reward points for the order that allowed you to receive a discount.

eligible_for_reward_pointsinteger

The number of reward points the player is eligible to receive for this order.

eligible_for_loyalty_pointsinteger

The number of loyalty points the player is eligible to receive for this order.

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

Example response

{
  "checkout_url": "https://pay.aghanim.com/order/ord_XXXXXXX",
  "created_at": 1690000000,
  "id": "ord_XXXXXXX",
  "items": [
    {
      "sku": "crystal"
    }
  ],
  "metadata": {
    "key": "value"
  },
  "paid_at": 1690000100,
  "player_id": "r2d2-c3po",
  "status": "paid"
}

Changes

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

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, 2026fb9750c99d0a1See the full diff
- ●
  for the path request parameter order_id, the maxLength was set to 32
  request-parameter-max-length-set
Sep 4, 20262fecf8a6aa0b1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Sep 3, 2026ff170234e3c11See the full diff
- ○
  added the required property to the response with the status
  response-required-property-added
Aug 18, 2026ef61f771db1d1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 2026a14f6ce6d18710See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 2026fd2c63d975cd1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history