---
title: "Retrieve an order"
method: GET
path: "/orders/{order_id}"
tags: ["Orders"]
---

# Retrieve an order

`GET /orders/{order_id}`

Retrieves the details of an order with the given `order_id`.

If you specify multiple order IDs in the request, the response will return an array with each order object.

## Path parameters

- `order_id` string, required

## Response `200`

OK

- GetOrdersById
  - `order` string — Unique order ID.
  - `id` string — Unique ID, same as order ID.
  - `reference` string — External reference number.
  - `buyerReference` string, nullable — Purchase order number used as a reference for the buyer.
  - `ipAddress` string, ipv4 — IP address of the buyer.
  - `completed` boolean — Indicates if the order is completed.
  - `changed` integer — Timestamp in milliseconds of last change.
  - `changedValue` integer — Unix timestamp in milliseconds for the changed value.
  - `changedInSeconds` integer — Unix timestamp in seconds indicating the last change.
  - `changedDisplay` string — Human-readable date format.
  - `changedDisplayISO8601` string, date — Date in ISO 8601 format.
  - `changedDisplayEmailEnhancements` string — Date in a format commonly used in emails.
  - `changedDisplayEmailEnhancementsWithTime` string — Date and time in a format commonly used in emails.
  - `language` string — Two-letter language code (<a href="https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes">ISO 639</a>) of the order language.
  - `live` boolean — Indicates if the order is a live order or a test order; 'true' indicates a live order and 'false' indicates a test order.
  - `currency` string — Three-letter currency code (<a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a>) used in the order.
  - `payoutCurrency` string — Currency used for payouts.
  - `quote` string — Sales estimate or proposal associated with the order. If no quote is applicable, this property returns a 'null' value.
  - `invoiceUrl` string — URL of the associated invoice.
  - `siteId` string — FastSpring-generated customer site or storefront ID.
  - `account` string — FastSpring-generated customer account ID.
  - `total` number, float — Total amount of the order.
  - `totalDisplay` string — Display format of the total amount.
  - `totalInPayoutCurrency` number, float — Total amount of the order in the payout currency.
  - `totalInPayoutCurrencyDisplay` string — Display format of the total amount in the payout currency.
  - `tax` number, float — Tax amount.
  - `taxDisplay` string — Display format of the tax amount.
  - `taxInPayoutCurrency` number, float — Tax amount of the order in the payout currency.
  - `taxInPayoutCurrencyDisplay` string — Display format of the tax amount in the payout currency.
  - `subtotal` number, float — Subtotal amount of the order.
  - `subtotalDisplay` string — Display format of the subtotal amount.
  - `subtotalInPayoutCurrency` number, float — Subtotal amount of the order in the payout currency.
  - `subtotalInPayoutCurrencyDisplay` string — Display format of the subtotal amount in the payout currency.
  - `discount` number, float — Total amount of all discounts associated with the order. This displays in the currency associated with the subscription instance.
  - `discountDisplay` string — Total amount of all discounts associated with the order, formatted for display in the associated currency.
  - `discountInPayoutCurrency` number, float — Total amount of all discounts associated with the order, in your disbursement currency.
  - `discountInPayoutCurrencyDisplay` string — Total amount of all discounts associated with the order, formatted for display in your FastSpring disbursements currency.
  - `discountWithTax` number, float — Discount amount, including tax.
  - `discountWithTaxDisplay` string — Discount amount including tax, formatted for display in the transaction's currency.
  - `discountWithTaxInPayoutCurrency` number, float — Discount amount including tax, in the currency of your FastSpring disbursements.
  - `discountWithTaxInPayoutCurrencyDisplay` string — Discount amount including tax, formatted for display in the currency of your FastSpring disbursements.
  - `billDescriptor` string — The description information sent to the payment account for display on the customer's statement.
  - `payment` object — Details about the transaction's payment method.
    - `type` string — Payment method used for the order, such as "paypal", "amazon", "applepay", "creditcard", "kakaopay", "test", "bank", "alipay", "purchase-order", or "free".
    - `creditcard` string — Appears when payment.type = creditcard. Type of credit or debit card used for the order, such as "visa", "mastercard", "amex", "discover", "jcb", "carteblanche", "dinersclub", or "unionpay".
    - `cardEnding` string — Appears when payment.type = bank. Type of bank transfer used to pay for the order, such as "wire", "brazilwire", "ideal", "giropay", "sofort", "ecard", "sepa", or "alipay".
    - `bank` string — Appears when payment.type = creditcard. Last four digits of the card number used for the order.
  - `customer` object
    - `first` string — Customer first name.
    - `last` string — Customer last name.
    - `email` string, email — Customer email address.
    - `phone` string — Customer phone number.
    - `subscribed` boolean — Indicates if customer is subscribed to updates.
  - `address` object — Address information associated with the order.
    - `city` string — City, district, suburb, town, or village.
    - `regionCode` string — Two-letter ISO code of the US state.
    - `regionDisplay` string — State or region, formatted for display.
    - `region` string — State or region.
    - `postalCode` string — ZIP or postal code.
    - `country` string — Two-letter country code.
    - `display` string — String of address information formatted for display.
  - `recipients` object[] — Customer and gift recipient information. This differs from customer and address information on gift purchases.
    - `recipient` object
      - `first` string — Recipient first name.
      - `last` string — Recipient last name.
      - `email` string — Recipient email address.
      - `company` string — Recipient associated company.
      - `phone` string — Recipient phone number.
      - `subscribed` boolean — Indicates if customer is subscribed to updates.
      - `account` string — FastSpring-generated customer account ID.
      - `address` object
        - `city` string — City, district, suburb, town, or village.
        - `regionCode` string — Two-letter ISO code of the US state.
        - `regionDisplay` string — State or region, formatted for display.
        - `region` string — State or region.
        - `postalCode` string — ZIP or postal code.
        - `country` string — Two-letter country code.
        - `display` string — String of address information formatted for display.
  - `notes` unknown[] — Internal order notes. You can add notes within the app.
    - unknown
  - `items` object[] — List of items in the order.
    - `product` string — Unique identifier for the product.
    - `quantity` integer — Quantity of the product ordered.
    - `display` string — Display name of the product.
    - `sku` string — Stock keeping unit (SKU) identifier if available.
    - `imageUrl` string — URL link to the product image.
    - `shortDisplay` string — Abbreviated or short display name for the product.
    - `subtotal` number — Subtotal amount for this product in the base currency.
    - `subtotalDisplay` string — Formatted display for subtotal.
    - `subtotalInPayoutCurrency` number — Subtotal amount in payout currency.
    - `subtotalInPayoutCurrencyDisplay` string — Formatted display for subtotal in payout currency.
    - `discount` number — Discount amount for the product in base currency.
    - `discountDisplay` string — Formatted display for the discount amount.
    - `discountInPayoutCurrency` number — Discount amount in payout currency.
    - `discountInPayoutCurrencyDisplay` string — Formatted display for the discount amount in payout currency.
    - `isAddon` boolean — Indicates if the item is an add-on product.
    - `fulfillments` object — Details about the fulfillment of the item.
    - `driver` object — Driver information for cross-sell or upsell features.
      - `type` string — Type of driver, such as cross-sell or upsell.
      - `path` string — Path or route identifier for the driver.
    - `withholdings` object — Details on withholdings applicable to the item.
      - `taxWithholdings` boolean — Indicates if tax withholdings apply.
    - `proratedItemChangeAmount` number — Prorated change amount for the item in base currency.
    - `proratedItemChangeAmountDisplay` string — Formatted display for prorated change amount.
    - `proratedItemChangeAmountInPayoutCurrency` number — Prorated change amount in payout currency.
    - `proratedItemChangeAmountInPayoutCurrencyDisplay` string — Formatted display for prorated change amount in payout currency.
    - `proratedItemProratedCharge` number — Prorated charge amount in base currency.
    - `proratedItemProratedChargeDisplay` string — Formatted display for prorated charge amount.
    - `proratedItemProratedChargeInPayoutCurrency` number — Prorated charge amount in payout currency.
    - `proratedItemProratedChargeInPayoutCurrencyDisplay` string — Formatted display for prorated charge amount in payout currency.
    - `proratedItemCreditAmount` number — Prorated credit amount in base currency.
    - `proratedItemCreditAmountDisplay` string — Formatted display for prorated credit amount.
    - `proratedItemCreditAmountInPayoutCurrency` number — Prorated credit amount in payout currency.
    - `proratedItemCreditAmountInPayoutCurrencyDisplay` string — Formatted display for prorated credit amount in payout currency.
    - `proratedItemTaxAmount` number — Prorated tax amount in base currency.
    - `proratedItemTaxAmountDisplay` string — Formatted display for prorated tax amount.
    - `proratedItemTaxAmountInPayoutCurrency` number — Prorated tax amount in payout currency.
    - `proratedItemTaxAmountInPayoutCurrencyDisplay` string — Formatted display for prorated tax amount in payout currency.
    - `proratedItemTotal` number — Total prorated amount in base currency.
    - `proratedItemTotalDisplay` string — Formatted display for prorated total amount.
    - `proratedItemTotalInPayoutCurrency` number — Total prorated amount in payout currency.
    - `proratedItemTotalInPayoutCurrencyDisplay` string — Formatted display for prorated total amount in payout currency.
  - `action` string — The action performed by the API.
  - `result` string — The result of the action (e.g., success or error).

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/fastspring/apis/fastspring-api-accounts.md) · [All operations](https://skmtc.dev/fastspring/apis/fastspring-api-accounts/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fastspring/fastspring-api-accounts/revisions/ae2f0b97db3e/schema)