CheckoutResponse

Aggregate result of a checkout — every order created under one reference.

Reuses :class:~src.schemas.data_plane.PurchaseResponse for each created order so a checkout position is byte-for-byte identical to a single POST /orders result.

currencyCurrencyrequired

Currency code of the cart total.

orders object[]required

Per-position results — one PurchaseResponse per created order.

Array [

createdAt object

Order creation time in shop-service (ISO 8601, UTC). Absent for orders created before the field was introduced and for pending responses that precede order creation.

anyOf

• string<date-time>
• null

string<date-time>

currencyCurrencyrequired

orderIdOrderidrequired

pricePricerequired

result object

anyOf

• PurchaseResult
• null

attributes object

anyOf

• object
• null

object

esim object

eSIM activation payload returned for ordersType=esim purchases (see EsimActivation). Pass-through from the supplier; clients must tolerate additive fields. Absent for voucher / DTU orders.

anyOf

• EsimActivation
• object
• null

Typed view of the supplier eSIM activation payload (B4).

The payload remains a tolerant pass-through: extra="allow" keeps every unknown supplier field, declared-but-absent fields are NOT invented on the wire (parents serialize with exclude_unset), and a payload without a usable qrCodeText falls back to the raw dict in PurchaseResult.esim / TransactionListItem.esim instead of failing the response.

activationCode object

anyOf

• string
• null

string

androidInstallUrl object

anyOf

• string
• null

string

iccid object

anyOf

• string
• null

string

iosInstallUrl object

anyOf

• string
• null

string

qrCodeTextQrcodetextrequired

smdpAddress object

anyOf

• string
• null

string

steamGift object

Steam Gift delivery snapshot for ordersType=steam-gift purchases. Safe fields only (no bot credentials, Steam transids, or raw errors). Absent for voucher / DTU / eSIM orders.

anyOf

• SteamGiftDelivery
• null

Steam-specific delivery snapshot attached to purchase/list responses.

Safe fields only — no bot login, Steam session, or raw transid.

deliveryState object

Service delivery state (e.g. dispatch_pending, in_progress, manual_review, completed, failed, requote_required).

anyOf

• string
• null

string

editionName object

anyOf

• string
• null

string

errorCode object

Normalized public error code. Never a raw Steam error body.

anyOf

• string
• null

string

giftState object

Recipient gift state when known (pending/accepted/declined).

anyOf

• string
• null

string

productName object

anyOf

• string
• null

string

recipientRegion object

anyOf

• string
• null

string

requiresCustomerActionRequirescustomeraction

Default value: false

resolutionRequiredResolutionrequired

True when ops/manual review is required (e.g. unknown finalize).

Default value: false

retryableRetryable

Default value: false

updatedAt object

anyOf

• string<date-time>
• null

string<date-time>

vouchers object

anyOf

• object[]
• null

Array [

expiration object

anyOf

• string<date-time>
• null

string<date-time>

pinPinrequired

serialNumber object

anyOf

• string
• null

string

]

statusTransactionStatusrequired

Possible values: [SUCCESS, IN_PROGRESS, PARTIALLY_COMPLETED, CANCELLED]

]

referenceIdReferenceidrequired

The cart id / idempotency key of this checkout.

statusTransactionStatusrequired

Aggregate checkout status across all created orders.

Possible values: [SUCCESS, IN_PROGRESS, PARTIALLY_COMPLETED, CANCELLED]

totalPriceTotalpricerequired

Sum of all order prices (the cart total).

CheckoutResponse

{
  "currency": "string",
  "orders": [
    {
      "createdAt": "2024-07-29T15:51:28.071Z",
      "currency": "string",
      "orderId": "string",
      "price": 0,
      "result": {
        "attributes": {},
        "esim": {
          "activationCode": "string",
          "androidInstallUrl": "string",
          "iccid": "string",
          "iosInstallUrl": "string",
          "qrCodeText": "string",
          "smdpAddress": "string"
        },
        "steamGift": {
          "deliveryState": "string",
          "editionName": "string",
          "errorCode": "string",
          "giftState": "string",
          "productName": "string",
          "recipientRegion": "string",
          "requiresCustomerAction": false,
          "resolutionRequired": false,
          "retryable": false,
          "updatedAt": "2024-07-29T15:51:28.071Z"
        },
        "vouchers": [
          {
            "expiration": "2024-07-29T15:51:28.071Z",
            "pin": "string",
            "serialNumber": "string"
          }
        ]
      },
      "status": "SUCCESS"
    }
  ],
  "referenceId": "string",
  "status": "SUCCESS",
  "totalPrice": 0
}