Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Orders

Retrieve an order

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.

get/orders/{order_id}

Path parameters

order_idstring required

Unique identifier for the order.

Response

OK

orderstring

Unique order ID.

idstring

Unique ID, same as order ID.

referencestring

External reference number.

buyerReferencestring nullable

Purchase order number used as a reference for the buyer.

ipAddressstring ipv4

IP address of the buyer.

completedboolean

Indicates if the order is completed.

changedinteger

Timestamp in milliseconds of last change.

changedValueinteger

Unix timestamp in milliseconds for the changed value.

changedInSecondsinteger

Unix timestamp in seconds indicating the last change.

changedDisplaystring

Human-readable date format.

changedDisplayISO8601string date

Date in ISO 8601 format.

changedDisplayEmailEnhancementsstring

Date in a format commonly used in emails.

changedDisplayEmailEnhancementsWithTimestring

Date and time in a format commonly used in emails.

languagestring

Two-letter language code (<a href="https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes">ISO 639</a>) of the order language.

liveboolean

Indicates if the order is a live order or a test order; 'true' indicates a live order and 'false' indicates a test order.

currencystring

Three-letter currency code (<a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a>) used in the order.

payoutCurrencystring

Currency used for payouts.

quotestring

Sales estimate or proposal associated with the order. If no quote is applicable, this property returns a 'null' value.

invoiceUrlstring

URL of the associated invoice.

siteIdstring

FastSpring-generated customer site or storefront ID.

accountstring

FastSpring-generated customer account ID.

totalnumber float

Total amount of the order.

totalDisplaystring

Display format of the total amount.

totalInPayoutCurrencynumber float

Total amount of the order in the payout currency.

totalInPayoutCurrencyDisplaystring

Display format of the total amount in the payout currency.

taxnumber float

Tax amount.

taxDisplaystring

Display format of the tax amount.

taxInPayoutCurrencynumber float

Tax amount of the order in the payout currency.

taxInPayoutCurrencyDisplaystring

Display format of the tax amount in the payout currency.

subtotalnumber float

Subtotal amount of the order.

subtotalDisplaystring

Display format of the subtotal amount.

subtotalInPayoutCurrencynumber float

Subtotal amount of the order in the payout currency.

subtotalInPayoutCurrencyDisplaystring

Display format of the subtotal amount in the payout currency.

discountnumber float

Total amount of all discounts associated with the order. This displays in the currency associated with the subscription instance.

discountDisplaystring

Total amount of all discounts associated with the order, formatted for display in the associated currency.

discountInPayoutCurrencynumber float

Total amount of all discounts associated with the order, in your disbursement currency.

discountInPayoutCurrencyDisplaystring

Total amount of all discounts associated with the order, formatted for display in your FastSpring disbursements currency.

discountWithTaxnumber float

Discount amount, including tax.

discountWithTaxDisplaystring

Discount amount including tax, formatted for display in the transaction's currency.

discountWithTaxInPayoutCurrencynumber float

Discount amount including tax, in the currency of your FastSpring disbursements.

discountWithTaxInPayoutCurrencyDisplaystring

Discount amount including tax, formatted for display in the currency of your FastSpring disbursements.

billDescriptorstring

The description information sent to the payment account for display on the customer's statement.

actionstring

The action performed by the API.

resultstring

The result of the action (e.g., success or error).

Example response

{
  "order": "abcDEFgHiJklM1N-3OP9q",
  "id": "abcDEFgHiJklM1N-3OP9q",
  "reference": "ABC1234567-8910-11121D",
  "ipAddress": "00.000.00.000",
  "completed": true,
  "changed": 1723838225894,
  "changedValue": 1723838225894,
  "changedInSeconds": 1723838225,
  "changedDisplay": "8/16/24",
  "changedDisplayISO8601": "2024-08-16",
  "changedDisplayEmailEnhancements": "Aug 16, 2024",
  "changedDisplayEmailEnhancementsWithTime": "Aug 16, 2024 07:57:05 PM",
  "language": "en",
  "currency": "USD",
  "payoutCurrency": "USD",
  "invoiceUrl": "https://yourexamplestore.onfastspring.com/account/order/YES191015-1265-35113/invoice",
  "siteId": "LDN5SX4KBZCI2",
  "account": "abcDEFgHiJklM1N-3OP9q",
  "total": 10,
  "totalDisplay": "$10.00",
  "totalInPayoutCurrency": 10,
  "totalInPayoutCurrencyDisplay": "$10.00",
  "taxDisplay": "$0.00",
  "taxInPayoutCurrencyDisplay": "$0.00",
  "subtotal": 10,
  "subtotalDisplay": "$10.00",
  "subtotalInPayoutCurrency": 10,
  "subtotalInPayoutCurrencyDisplay": "$10.00",
  "discountDisplay": "$0.00",
  "discountInPayoutCurrencyDisplay": "$0.00",
  "discountWithTaxDisplay": "$0.00",
  "discountWithTaxInPayoutCurrencyDisplay": "$0.00",
  "billDescriptor": "FS* fsprg.com",
  "payment": {
    "type": "test",
    "creditcard": "visa",
    "cardEnding": "wire",
    "bank": "4242"
  },
  "customer": {
    "first": "Jane",
    "last": "Doe",
    "email": "first.last@domain.com",
    "phone": "555-555-5555",
    "subscribed": true
  },
  "address": {
    "city": "Santa Barbara",
    "regionCode": "CA",
    "regionDisplay": "California",
    "region": "California",
    "country": "US",
    "display": "Santa Barbara, California, 93101, US"
  },
  "recipients": [
    {
      "recipient": {
        "first": "First",
        "last": "Last",
        "email": "first.last@domain.com",
        "company": "Company Name",
        "phone": "555-555-5555",
        "subscribed": true,
        "account": "abcDEFgHiJklM1N-3OP9q",
        "address": {
          "city": "Santa Barbara",
          "regionCode": "CA",
          "regionDisplay": "California",
          "region": "California",
          "country": "US",
          "display": "Santa Barbara, California, 93101, US"
        }
      }
    }
  ],
  "items": [
    {
      "product": "furious-falcon",
      "quantity": 1,
      "display": "Furious Falcon",
      "imageUrl": "https://image.com/furious-falcon-logo.png",
      "shortDisplay": "Furious Falcon",
      "subtotal": 10,
      "subtotalDisplay": "$10.00",
      "subtotalInPayoutCurrency": 10,
      "subtotalInPayoutCurrencyDisplay": "$10.00",
      "discountDisplay": "$0.00",
      "discountInPayoutCurrencyDisplay": "$0.00",
      "isAddon": true,
      "fulfillments": {},
      "driver": {
        "type": "cross-sell",
        "path": "example-monthly-subscription"
      },
      "proratedItemChangeAmountDisplay": "$0.00",
      "proratedItemChangeAmountInPayoutCurrencyDisplay": "$0.00",
      "proratedItemProratedChargeDisplay": "$0.00",
      "proratedItemProratedChargeInPayoutCurrencyDisplay": "$0.00",
      "proratedItemCreditAmountDisplay": "$0.00",
      "proratedItemCreditAmountInPayoutCurrencyDisplay": "$0.00",
      "proratedItemTaxAmountDisplay": "$0.00",
      "proratedItemTaxAmountInPayoutCurrencyDisplay": "$0.00",
      "proratedItemTotalDisplay": "$0.00",
      "proratedItemTotalInPayoutCurrencyDisplay": "$0.00"
    }
  ],
  "action": "order.get",
  "result": "success"
}