{"openapi":"3.1.0","info":{"title":"Akariq Partner API","version":"1.0.0"},"servers":[{"url":"/api/v1"}],"components":{"securitySchemes":{"PartnerKey":{"type":"http","scheme":"bearer","description":"Scoped Akariq API key. Obtain from your account administrator."}},"schemas":{"PartnerAccount":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"environment":{"type":"string","enum":["sandbox","production"]},"scopes":{"type":"array","items":{"type":"string"}},"keyExpiresAt":{"type":"string"},"webhookEnabled":{"type":"boolean"}},"required":["id","name","email","environment","scopes","keyExpiresAt","webhookEnabled"],"description":"Your own account identity and current key permissions. No credentials or signing secrets are returned."},"PartnerError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string"}},"required":["code","message","requestId"]}},"required":["error"]},"Plan":{"type":"object","properties":{"id":{"type":"string","description":"Stable purchasable plan ID, including its duration variant. Use the returned ID unchanged when ordering.","example":"p123-base"},"countryCode":{"type":"string","description":"Catalog destination code. Local plans use a two-letter country code such as DE. Use coverage for the actual countries covered by regional or global plans.","example":"DE"},"countryName":{"type":"string","description":"Display name of the catalog destination.","example":"Germany"},"scope":{"type":["string","null"],"description":"Coverage classification. Known values: local, regional, global. Null means the classification is unavailable; use coverage to determine included countries.","example":"local"},"region":{"type":["string","null"],"description":"Region slug from GET /regions, or null when the plan is not associated with a region.","example":null},"coverage":{"type":"array","items":{"type":"string"},"description":"Country codes covered by this plan. Use this list when explaining where a regional plan works.","example":["DE"]},"dataAmountMb":{"type":"integer","description":"Data allowance in MB; Akariq displays 1024 MB as 1 GB. For daily plans this is the daily allowance rather than a total for the trip. Read isDailyPlan and fupPolicy together; do not infer unlimited full-speed data.","example":1024},"validityDays":{"type":"integer","description":"Plan validity in days. The start event is described by activationType.","example":7},"priceCents":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Current Akariq purchase price for the authenticated partner, in USD cents. 103 means USD 1.03. This is not the reseller's consumer selling price. Pass this value as expectedPriceCents.","example":103},"currency":{"type":"string","enum":["USD"],"description":"Currency for priceCents. The API currently prices purchases in US dollars.","example":"USD"},"networkType":{"type":["string","null"],"description":"Reported network technology, such as 4G or 5G. Null means unavailable. This is not a guarantee of speed or signal at a location.","example":"5G"},"networks":{"type":["array","null"],"items":{"type":"string"},"description":"Reported mobile network names. Null means network information is unavailable; an empty array contains no listed networks.","example":["O2","Vodafone"]},"activationType":{"type":"string","enum":["first_install","first_network"],"description":"first_install: validity starts when the eSIM is installed. first_network: validity starts on the first connection to a supported mobile network.","example":"first_network"},"isDailyPlan":{"type":"boolean","description":"True when the data allowance is daily rather than a single allowance for the full validity period. Read fupPolicy for any reduced-speed conditions.","example":false},"fupPolicy":{"type":"string","description":"Fair-use policy text supplied with the plan, including any speed reduction. An empty string means no policy text is available, not a promise of unrestricted usage.","example":""},"periodNum":{"type":["integer","null"],"description":"Selected duration variant in days for a configurable daily plan; null for a base plan. Use the complete plan ID to order, rather than constructing a new ID from this field.","example":null}},"required":["id","countryCode","countryName","scope","region","coverage","dataAmountMb","validityDays","priceCents","currency","networkType","networks","activationType","isDailyPlan","fupPolicy","periodNum"],"description":"A currently available plan and the authenticated account's purchase price. Example values are illustrative, not a live offer."},"Balance":{"type":"object","properties":{"currency":{"type":"string","enum":["USD"]},"availableCents":{"type":"integer"},"reservedCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"lowBalance":{"type":"boolean"}},"required":["currency","availableCents","reservedCents","lowBalance"]},"BalanceTransaction":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"availableDeltaCents":{"type":"integer"},"reservedDeltaCents":{"type":"integer"},"reference":{"type":"string"},"createdAt":{"type":"string"}},"required":["id","type","availableDeltaCents","reservedDeltaCents","reference","createdAt"]},"CheckoutSession":{"type":"object","properties":{"id":{"type":"string"},"checkoutUrl":{"type":"string","format":"uri"}},"required":["id","checkoutUrl"]},"AcceptedOrder":{"type":"object","properties":{"orderId":{"type":"string"},"statusUrl":{"type":"string"}},"required":["orderId","statusUrl"]},"OrderRequest":{"type":"object","properties":{"planId":{"type":"string","pattern":"^p[1-9][0-9]*-(base|[1-9][0-9]*)$"},"expectedPriceCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"reference":{"type":"string","minLength":1,"maxLength":100}},"required":["planId","expectedPriceCents","reference"],"additionalProperties":false},"Order":{"type":"object","properties":{"id":{"type":"string"},"reference":{"type":"string"},"status":{"type":"string"},"priceCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"currency":{"type":"string","enum":["USD"]},"createdAt":{"type":"string"},"esimId":{"type":["string","null"]}},"required":["id","reference","status","priceCents","currency","createdAt","esimId"]},"Installation":{"type":"object","properties":{"esimId":{"type":"string"},"iccid":{"type":"string"},"activationCode":{"type":"string"},"qrCodeSvg":{"type":"string"},"universalLink":{"type":["string","null"]}},"required":["esimId","iccid","activationCode","qrCodeSvg","universalLink"]},"CheckoutRequest":{"allOf":[{"$ref":"#/components/schemas/OrderRequest"},{"type":"object","properties":{"email":{"type":"string","format":"email"}},"required":["email"],"additionalProperties":false}]}},"parameters":{}},"paths":{"/account":{"get":{"tags":["Account"],"summary":"Read your dashboard account details","operationId":"getAccount","security":[{"PartnerKey":[]}],"description":"Requires balance:read. Private responses are never shared-cacheable.","x-required-scope":"balance:read","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerAccount"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/countries":{"get":{"tags":["Catalog"],"summary":"List available countries","operationId":"listCountries","security":[{"PartnerKey":[]}],"description":"Requires catalog:read. Private responses are never shared-cacheable.","x-required-scope":"catalog:read","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"countryCode":{"type":"string"},"countryName":{"type":"string"}},"required":["countryCode","countryName"]}}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/regions":{"get":{"tags":["Catalog"],"summary":"List available regions","operationId":"listRegions","security":[{"PartnerKey":[]}],"description":"Requires catalog:read. Private responses are never shared-cacheable.","x-required-scope":"catalog:read","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"coverage":{"type":"array","items":{"type":"string"}}},"required":["slug","name","coverage"]}}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/plans":{"get":{"tags":["Catalog"],"summary":"Browse plans and account prices","operationId":"listPlans","security":[{"PartnerKey":[]}],"description":"Requires catalog:read. Private responses are never shared-cacheable.","x-required-scope":"catalog:read","parameters":[{"schema":{"type":"string","maxLength":100,"description":"Cursor returned as nextCursor by the preceding page. Omit for the first page; retain the same filters."},"required":false,"description":"Cursor returned as nextCursor by the preceding page. Omit for the first page; retain the same filters.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Maximum results per page, from 1 to 100.","example":25},"required":false,"description":"Maximum results per page, from 1 to 100.","name":"limit","in":"query"},{"schema":{"type":"string","pattern":"^[A-Z]{2}$","description":"Filter by catalog country code. This filters the destination, not membership in a regional plan's coverage list.","example":"DE"},"required":false,"description":"Filter by catalog country code. This filters the destination, not membership in a regional plan's coverage list.","name":"country","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":80,"description":"Filter by a region slug returned by GET /regions. If both country and region are supplied, both filters apply."},"required":false,"description":"Filter by a region slug returned by GET /regions. If both country and region are supplied, both filters apply.","name":"region","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Plan"}},"nextCursor":{"type":["string","null"]}},"required":["data","nextCursor"]}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/plans/{id}":{"get":{"tags":["Catalog"],"summary":"Get a plan and its current price","operationId":"getPlan","security":[{"PartnerKey":[]}],"description":"Requires catalog:read. Private responses are never shared-cacheable.","x-required-scope":"catalog:read","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plan"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/balance":{"get":{"tags":["Wallet"],"summary":"Read your available and reserved credit","operationId":"getBalance","security":[{"PartnerKey":[]}],"description":"Requires balance:read. Private responses are never shared-cacheable.","x-required-scope":"balance:read","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/balance/transactions":{"get":{"tags":["Wallet"],"summary":"List balance transactions","operationId":"listBalanceTransactions","security":[{"PartnerKey":[]}],"description":"Requires balance:read. Private responses are never shared-cacheable.","x-required-scope":"balance:read","parameters":[{"schema":{"type":"string","maxLength":100,"description":"Cursor returned as nextCursor by the preceding page. Omit for the first page; retain the same filters."},"required":false,"description":"Cursor returned as nextCursor by the preceding page. Omit for the first page; retain the same filters.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Maximum results per page, from 1 to 100.","example":25},"required":false,"description":"Maximum results per page, from 1 to 100.","name":"limit","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BalanceTransaction"}},"nextCursor":{"type":["string","null"]}},"required":["data","nextCursor"]}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/balance/topups":{"post":{"tags":["Wallet"],"summary":"Create a wallet funding checkout","operationId":"createBalanceTopup","security":[{"PartnerKey":[]}],"description":"Requires balance:write. Private responses are never shared-cacheable.","x-required-scope":"balance:write","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{8,128}$"},"required":true,"name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountCents":{"type":"integer","minimum":1000,"maximum":100000}},"required":["amountCents"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSession"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/orders":{"post":{"tags":["Orders"],"summary":"Purchase an eSIM","operationId":"createOrder","security":[{"PartnerKey":[]}],"description":"Requires orders:write. Private responses are never shared-cacheable.","x-required-scope":"orders:write","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{8,128}$"},"required":true,"name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequest"}}}},"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedOrder"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}},"get":{"tags":["Orders"],"summary":"List your orders","operationId":"listOrders","security":[{"PartnerKey":[]}],"description":"Requires orders:read. Private responses are never shared-cacheable.","x-required-scope":"orders:read","parameters":[{"schema":{"type":"string","maxLength":100,"description":"Cursor returned as nextCursor by the preceding page. Omit for the first page; retain the same filters."},"required":false,"description":"Cursor returned as nextCursor by the preceding page. Omit for the first page; retain the same filters.","name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"description":"Maximum results per page, from 1 to 100.","example":25},"required":false,"description":"Maximum results per page, from 1 to 100.","name":"limit","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"nextCursor":{"type":["string","null"]}},"required":["data","nextCursor"]}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/orders/{id}":{"get":{"tags":["Orders"],"summary":"Check an order status","operationId":"getOrder","security":[{"PartnerKey":[]}],"description":"Requires orders:read. Private responses are never shared-cacheable.","x-required-scope":"orders:read","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/esims/{id}/installation":{"get":{"tags":["Delivery"],"summary":"Retrieve eSIM installation details","operationId":"getInstallation","security":[{"PartnerKey":[]}],"description":"Requires esims:install. Private responses are never shared-cacheable.","x-required-scope":"esims:install","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installation"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}},"/checkout-sessions":{"post":{"tags":["Checkout"],"summary":"Create a customer checkout link","operationId":"createCheckout","security":[{"PartnerKey":[]}],"description":"Requires checkout:write. Private responses are never shared-cacheable.","x-required-scope":"checkout:write","parameters":[{"schema":{"type":"string","pattern":"^[A-Za-z0-9._:-]{8,128}$"},"required":true,"name":"Idempotency-Key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutRequest"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutSession"}}}},"400":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"401":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"403":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"404":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"409":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"429":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"500":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}},"503":{"description":"Request failed; inspect error.code. Retry-After accompanies 429.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerError"}}}}}}}},"webhooks":{}}