v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB

Session

Retrieve session

Retrieves the complete details and current state of an existing order session.

get/v2/checkouts/{checkoutPath}/sessions/{sessionId}

Path parameters

checkoutPathstring required

The unique identifier for the checkout instance, in the format store-id/checkout-id (e.g., fastspring/main).

Note: Target a specific checkout path to route the session to a single buyer experience and ensure accurate pricing. Stores frequently run multiple checkout variations simultaneously.

Example:fastspring/main

sessionIdstring required

The unique identifier of the order session.

Example:OS123456789012345ABC

Response

Successfully retrieved the session details.

idstring

The unique primary identifier representing the established session.

createdstring date-time

The ISO 8601 timestamp marking the exact moment the session was initialized.

expiresstring date-time

The ISO 8601 timestamp marking when the session data expires and requires recreation.

Describes the current lifecycle phase of the session.

localestring

The display language code currently applied to the session formatting.

countrystring

The 2-letter ISO country code denoting the buyer's billing location utilized for localized pricing.

currencystring

The active currency code utilized for all pricing calculations.

liveboolean

Indicates true if the session is currently transacting real funds against live merchant accounts.

orderTagsobject

A key-value map of custom metadata configured to attach to the finalized order record.

hidePaymentMethodsstring[]

A list identifying specific payment methods explicitly filtered or hidden from the interface.

checkoutStatusstring[]

Indicates the current rendering state of the checkout session.

READY_FOR_CHECKOUT: The session is fully populated and capable of processing.
PRODUCTS_REQUIRED: The checkout cannot render because no products have been added to the session.
CONCLUDED: The checkout session has been finalized.

Example response

{
  "id": "OS123456789012345ABC",
  "created": "2026-03-20T10:49:51.000Z",
  "expires": "2026-03-21T10:49:51.000Z",
  "status": "OPEN",
  "locale": "en",
  "country": "US",
  "currency": "USD",
  "live": true,
  "customer": {
    "accountId": "ABC1234567890",
    "externalAccountId": "EXT-98765",
    "savedPaymentMethod": {
      "paymentMethodType": "CARD",
      "display": "VISA - 4242"
    },
    "billToContact": {
      "email": "support@fastspring.com",
      "firstName": "John",
      "lastName": "Doe",
      "company": "FastSpring",
      "phoneNumber": "555-555-5555"
    },
    "billToAddress": {
      "addressLine1": "801 Garden Street",
      "addressLine2": "suite 201",
      "city": "Santa Barbara",
      "region": "CA",
      "postalCode": "93101"
    },
    "shipToContact": {
      "email": "support@fastspring.com",
      "firstName": "John",
      "lastName": "Doe",
      "company": "FastSpring",
      "phoneNumber": "555-555-5555"
    },
    "shipToAddress": {
      "addressLine1": "801 Garden Street",
      "addressLine2": "suite 201",
      "city": "Santa Barbara",
      "region": "CA",
      "postalCode": "93101"
    },
    "accountTags": {
      "customerType": "VIP"
    },
    "taxId": "DE123456789",
    "taxIdRegion": "CA"
  },
  "orderTags": {
    "campaign": "Q1_Social"
  },
  "cart": {
    "couponCode": "10_OFF",
    "couponHasApplied": true,
    "lineItems": [
      {
        "productPath": "gold-tier",
        "quantity": 2,
        "quantityBehavior": "ALLOW",
        "quantityDefault": 1,
        "price": {
          "unitNetPrice": 90,
          "unitNetPriceDisplay": "$90.00",
          "unitListPrice": 100,
          "unitListPriceDisplay": "$100.00",
          "unitDiscount": 10,
          "unitDiscountDisplay": "$10.00",
          "extendedTotalDiscount": 20,
          "extendedTotalDiscountDisplay": "$20.00",
          "extendedNetTotal": 180,
          "extendedNetTotalDisplay": "$180.00",
          "extendedListTotal": 200,
          "extendedListTotalDisplay": "$200.00",
          "taxIncluded": "TAXES_INCLUDED_IN_PRICE",
          "unitTaxAmount": 10,
          "unitTaxAmountDisplay": "$10.00",
          "extendedTaxTotal": 20,
          "extendedTaxTotalDisplay": "$20.00",
          "taxPercent": 10,
          "productDiscountDuration": 100,
          "couponDiscountDuration": 100
        },
        "productType": "ONE_TIME",
        "removable": true,
        "descriptions": {
          "display": {
            "ar": "Arabic",
            "cs": "Czech",
            "da": "Danish",
            "de": "German",
            "es": "Spanish",
            "en": "English",
            "fi": "Finnish",
            "fr": "French",
            "hr": "Croatian",
            "it": "Italian",
            "iw": "Hebrew",
            "ja": "Japanese",
            "ko": "Korean",
            "nl": "Dutch",
            "no": "Norwegian",
            "pl": "Polish",
            "pt": "Portuguese",
            "ru": "Russian",
            "sk": "Slovak",
            "sv": "Swedish",
            "tr": "Turkish",
            "zh": "Chinese"
          },
          "instructions": {
            "ar": "Arabic",
            "cs": "Czech",
            "da": "Danish",
            "de": "German",
            "es": "Spanish",
            "en": "English",
            "fi": "Finnish",
            "fr": "French",
            "hr": "Croatian",
            "it": "Italian",
            "iw": "Hebrew",
            "ja": "Japanese",
            "ko": "Korean",
            "nl": "Dutch",
            "no": "Norwegian",
            "pl": "Polish",
            "pt": "Portuguese",
            "ru": "Russian",
            "sk": "Slovak",
            "sv": "Swedish",
            "tr": "Turkish",
            "zh": "Chinese"
          },
          "summary": {
            "ar": "Arabic",
            "cs": "Czech",
            "da": "Danish",
            "de": "German",
            "es": "Spanish",
            "en": "English",
            "fi": "Finnish",
            "fr": "French",
            "hr": "Croatian",
            "it": "Italian",
            "iw": "Hebrew",
            "ja": "Japanese",
            "ko": "Korean",
            "nl": "Dutch",
            "no": "Norwegian",
            "pl": "Polish",
            "pt": "Portuguese",
            "ru": "Russian",
            "sk": "Slovak",
            "sv": "Swedish",
            "tr": "Turkish",
            "zh": "Chinese"
          },
          "imageUrl": "https://cdn.onfastspring.com/themes/images/default-store-logo.png"
        },
        "productFormat": "DIGITAL",
        "attributes": {
          "licenseKey": "ABC-123"
        },
        "subscription": {
          "billingFrequency": {
            "intervalUnit": "MONTH",
            "intervalLength": 1,
            "intervalCount": 1
          },
          "trialDays": 14
        }
      }
    ],
    "netTotal": 90,
    "netTotalDisplay": "$90.00",
    "listTotal": 100,
    "listTotalDisplay": "$100.00",
    "withTaxNetTotal": 90,
    "withTaxNetTotalDisplay": "$90.00",
    "withTaxListTotal": 100,
    "withTaxListTotalDisplay": "$100.00",
    "withoutTaxNetTotal": 70,
    "withoutTaxNetTotalDisplay": "$70.00",
    "withoutTaxListTotal": 80,
    "withoutTaxListTotalDisplay": "$80.00",
    "discountTotal": 10,
    "discountTotalDisplay": "$10.00",
    "couponDiscountTotal": 10,
    "couponDiscountTotalDisplay": "$10.00",
    "productDiscountTotalDisplay": "$0.00",
    "taxIncluded": "TAXES_INCLUDED_IN_PRICE",
    "taxTotal": 20,
    "taxTotalDisplay": "$20.00",
    "taxRate": 28.57
  },
  "paymentMethods": [
    {
      "id": "CARD",
      "description": "PaymentMethodType.CreditCard",
      "variants": [
        "VISA",
        "MASTER_CARD",
        "AMEX"
      ]
    }
  ],
  "hidePaymentMethods": [
    "WIRE"
  ],
  "checkoutUrls": {
    "webcheckoutUrl": "https://example.onfastspring.com/checkout/session/OS123456789012345ABC"
  },
  "warnings": [
    {
      "code": "INVALID_PROMO_CODE",
      "field": "promoCode",
      "message": "The promo code you entered is invalid and was not applied. Please check the code."
    }
  ],
  "checkoutStatus": [
    "PRODUCTS_REQUIRED"
  ]
}