Get v1accountcheckout

The open checkout with a live quote. A customer has at most one, shared with the Telegram bot, so opening one in a browser supersedes one left open in a chat. 404 means none is open, which is an ordinary state rather than a failure.

GET /v1/account/checkout

cURL

cURL

curl --request GET \
  --url https://api.example.com/v1/account/checkout

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan": {
    "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "planVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": "<string>",
    "kind": "trial",
    "name": "<string>",
    "billingPeriod": "<string>",
    "durationSeconds": 123,
    "price": {
      "amountMinor": 123,
      "currency": "<string>"
    },
    "operations": [
      "purchase"
    ],
    "eligible": true,
    "description": "<string>",
    "sortOrder": 123,
    "gracePeriodSeconds": 123,
    "recurringCapable": true,
    "configurableSquads": true,
    "held": true,
    "ineligibleReason": "<string>",
    "trafficAllowanceBytes": 123,
    "deviceLimit": 123
  },
  "operation": "purchase",
  "currency": "<string>",
  "providers": [
    {
      "provider": "<string>",
      "currency": "<string>",
      "recurring": true,
      "amountMinor": 123
    }
  ],
  "applyWallet": true,
  "quote": {
    "currency": "<string>",
    "subtotalMinor": 123,
    "addonMinor": 123,
    "discountMinor": 123,
    "walletBalanceMinor": 123,
    "walletAppliedMinor": 123,
    "externalMinor": 123
  },
  "subscriptions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slot": 123,
      "plan": "<string>",
      "status": "<string>",
      "label": "<string>",
      "endsAt": "2023-11-07T05:31:56Z"
    }
  ],
  "targetRequired": true,
  "multiSubscription": true,
  "squads": {
    "selection": "<string>",
    "minimum": 123,
    "configurable": true,
    "offered": [
      {
        "squadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>"
      }
    ],
    "maximum": 123
  },
  "selectedSquadIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "squadSelection": {
    "required": true,
    "reason": "squad_selection_required"
  },
  "quoteAvailable": true,
  "addons": [
    {
      "addonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "addonVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "kind": "traffic",
      "name": "<string>",
      "maxQuantity": 123,
      "proration": "<string>",
      "price": {
        "amountMinor": 123,
        "currency": "<string>"
      },
      "description": "<string>",
      "squadCount": 123,
      "trafficBytes": 123,
      "deviceSlots": 123
    }
  ],
  "selectedAddons": [
    {
      "addonVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123
    }
  ],
  "provider": "<string>",
  "promoCode": "<string>",
  "promoRejection": "promo_unknown",
  "subscriptionId": "<string>",
  "newSubscription": true,
  "termsUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z"
}

Query Parameters

locale · enum<string>

Available options: ru, en

Response

200

application/json

Checkout

id · string<uuid> · required

planVersionId · string<uuid> · required

plan · object · required

Show child attributes

operation · enum<string> · required

Available options: purchase, renew, upgrade, downgrade

currency · string · required

providers · object[] · required

Show child attributes

applyWallet · boolean · required

quote · object · required

The exact application breakdown. Every figure is computed on the server, so the number a customer is asked to approve and the number they are charged cannot be arrived at two different ways.

Show child attributes

subscriptions · object[] · required

The subscriptions this checkout could target.

Show child attributes

targetRequired · boolean · required

A target must be named before this checkout can be confirmed.

multiSubscription · boolean · required

False means the panel renders no picker at all.

squads · object · required

Show child attributes

selectedSquadIds · string<uuid>[] · required

squadSelection · object · required

Whether the server choice still stands between this checkout and a price. A plan that asks the customer to choose servers opens with required: true and no quote rather than failing; reason is the commerce vocabulary the panel already explains.

Show child attributes

quoteAvailable · boolean · required

False while the quote is withheld; quote then carries only the currency.

addons · object[] · required

Show child attributes

selectedAddons · object[] · required

Show child attributes

provider · string

promoCode · string

promoRejection · enum<string>

Why the entered code does not apply. Present on a 200, not an error.

Available options: promo_unknown, promo_ineligible, promo_exhausted, promo_invalid

subscriptionId · string

newSubscription · boolean

termsUrl · string

expiresAt · string<date-time>