Sign in
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
player_idstring required

The unique identifier for the player making the purchase.

emailstring

The player's email address.

status'created' | 'captured' | 'paid' | 'canceled' | 'refunded' | 'refund_requested' | 'reattempted' | 'disputed' required
created_atinteger required

Order creation date in Unix epoch time.

paid_atinteger

Order payment date in Unix epoch time.

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.

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