--- title: "Get payout breakdown" method: GET path: "/payouts/{payoutId}/breakdown" tags: ["Payouts"] --- # Get payout breakdown `GET /payouts/{payoutId}/breakdown` ## Path parameters - `payoutId` string, required — Unique identifier of the payout for which to retrieve the detailed breakdown of orders and financial calculations. ## Response `200` OK - object - `total` object, required — Summary totals for all orders included in this payout breakdown, including aggregated financial calculations. - `orders` number, required — Total number of orders included in this payout breakdown. - `price` object, required — Aggregated price information for all orders included in this payout, showing total revenue, fees, refunds, and disputes. - `net` integer, required — Total amount to pay to promoter in cents. Calculated as: total + booking + refunded + dispute - `total` integer, required — Total amount the customer should pay in cents. Calculated as: gross + discount - `gross` integer, required — Total amount before refunds and discounts in cents. Calculated as: base + booking + shipping - `base` integer, required — Total ticket price in cents - `booking` integer, required — Total booking fees in cents (non-refundable) - `shipping` integer, required — Total shipping amount in cents - `sms` integer — SMS delivery fee in cents (customer-facing price in event currency) - `refunded` integer, required — Total amount refunded in cents (negative value) - `discount` integer, required — Total amount discounted in cents (negative value) - `gateway` integer, required — Total absorbed payment gateway fees in cents (negative value) - `dispute` integer, required — Total non-absorbed payment gateway fees in cents (negative value) - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code in ISO 4217 format - `split` object, required — How the total payout amount is split between different beneficiaries (tenant, venue, promoter, etc.) in cents. - `tenant` number, required — Amount allocated to the tenant (platform) in cents. This represents the platform's share of the revenue. - `venue` number, required — Amount allocated to the venue in cents. This represents the venue's share of the revenue from events held at their location. - `team` number, required — Amount allocated to the team in cents. This represents the team's share of the revenue after fees and other deductions. - `sessions` number, required — Amount allocated to Sessions platform commission in cents. This represents the platform's service fees. - `tickets` number, required — Amount allocated to ticketing fees in cents. This represents fees charged for ticket processing and management. - `structure` string, required — Fee structure identifier that was used to calculate the payout split and allocations. - `orders` object[], required — Detailed breakdown of individual orders included in this payout, showing how each order contributes to the total. - `order` object, required — Complete order information including customer details, items, and payment status. - `id` string, required — A unique identifier for this order. - `createdAt` string, date-time, required — Timestamp in ISO 8601 format when this order was created. - `updatedAt` string, date-time, required — Timestamp in ISO 8601 format when this order was last updated. - `status` 'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'DISPUTED' | 'ABANDONED', required — Current payment lifecycle status. PENDING: awaiting payment. PROCESSING: payment in progress. SUCCESSFUL: payment confirmed. DISPUTED: chargeback filed. ABANDONED: expired or cancelled. - `payment` object — Payment gateway details including method, card brand, and transaction identifiers. Absent for free orders. - `method` 'FREE' | 'AIRWALLEX' | 'STRIPE', required — Payment gateway used to process this order: FREE for no-cost orders, AIRWALLEX or STRIPE for paid orders - `source` 'ACH_DIRECT_DEBIT' | 'ACSS_DEBIT' | 'AFFIRM' | 'AFTERPAY' | 'ALFAMART' | 'ALIPAY' | 'ALIPAYCN' | 'ALIPAYHK' | 'ALMA' | 'AMEX_EXPRESS_CHECKOUT' | 'AMAZON_PAY' | 'APPLEPAY' | 'ATOME' | 'BACS_DIRECT_DEBIT' | 'BANCONTACT' | 'BANK_TRANSFER' | 'BECS_DIRECT_DEBIT' | 'BILLIE' | 'BITPAY' | 'BLIK' | 'BOLETO' | 'BOOST' | 'CARD' | 'CARD_PRESENT' | 'CASHAPP' | 'CRYPTO' | 'CUSTOM' | 'CUSTOMER_BALANCE' | 'DANA' | 'DOKU_EWALLET' | 'DRAGONPAY' | 'DUIT_NOW' | 'EFT_DIRECT_DEBIT' | 'EPS' | 'ESUN' | 'FAMILY_MART' | 'FPX' | 'FPS' | 'GCASH' | 'GIROPAY' | 'GOOGLEPAY' | 'GO_PAY' | 'GRABPAY' | 'HI_LIFE' | 'IDEAL' | 'INDOMARET' | 'INTERAC_PRESENT' | 'JENIUS_PAY' | 'KAKAOPAY' | 'KLARNA' | 'KONBINI' | 'KOREAN_LOCAL_CARD' | 'LINK' | 'LINKAJA' | 'MASTERPASS' | 'MAXIMA' | 'MB_WAY' | 'MOBILEPAY' | 'MULTIBANCO' | 'MYBANK' | 'NARVESEN' | 'NAVER_PAY' | 'NZ_BANK_ACCOUNT' | 'ONLINE_BANKING' | 'OVO' | 'OXXO' | 'P24' | 'PAYBYBANKAPP' | 'PAYCO' | 'PAYEASY' | 'PAYPAL' | 'PAYPAY' | 'PAYSAFECASH' | 'PAYSAFECARD' | 'PAYSERA' | 'PAY_NOW' | 'PERLAS_TERMINALS' | 'PIX' | 'PROMPTPAY' | 'RABBIT_LINE_PAY' | 'REVOLUT_PAY' | 'SAMSUNG_PAY' | 'SATISPAY' | 'SEPA_DIRECT_DEBIT' | 'SEVEN_ELEVEN' | 'SHOPEE_PAY' | 'SKRILL' | 'SOFORT' | 'SWISH' | 'TNG' | 'TOSS_PAY' | 'TRUEMONEY' | 'TRUSTLY' | 'TWINT' | 'VERKKOPANKKI' | 'VISA_CHECKOUT' | 'WECHATPAY' | 'ZIP' — Payment method used by the customer such as ApplePay, GooglePay, or card-based payments - `brand` 'AMERICAN_EXPRESS' | 'CARTES_BANCAIRES' | 'CHINA_UNION_PAY' | 'DINERS_CLUB_INTERNATIONAL' | 'DISCOVER' | 'EFTPOS_AUSTRALIA' | 'INTERAC' | 'JCB' | 'LINK' | 'MAESTRO' | 'MASTERCARD' | 'OTHER' | 'UNKNOWN' | 'UNION_PAY' | 'VISA' — Card brand when source is CARD (Visa, Mastercard, American Express, etc.) - `last4` string — Last 4 digits of the card number when source is CARD - `stripeId` string — Stripe payment intent identifier when using Stripe gateway - `stripeClientSecret` string — Stripe PaymentIntent client secret associated with the order, used to complete the payment flow - `stripeCustomerSessionClientSecret` string — Stripe CustomerSession client secret used by the Payment Element to offer and redisplay saved payment methods - `stripeAccountId` string — Connected Stripe account ID for direct charges. When present, payment is processed directly on the connected account rather than the platform account. - `airwallexId` string — Airwallex payment intent identifier when using Airwallex gateway - `airwallexClientSecret` string — Airwallex client secret used to authenticate requests for payment initialization - `airwallexCustomerId` string — Airwallex customer ID attached to the PaymentIntent for saved cards functionality - `airwallexCustomerClientSecret` string — Airwallex customer client secret for accessing saved payment methods in the Drop-in Element - `items` object[], required — Line items in this order, each with a ticket type, quantity, and price breakdown. - `id` string, required — Unique identifier for this order item - `kind` 'ADMISSION' | 'ADDON', required — Type of item: ADMISSION for tickets, ADDON for additional products or services - `quantity` integer, required — Number of items purchased (minimum 1) - `admissionId` string — Unique identifier of the admission ticket type, required for ADMISSION items - `sectionId` string — Unique identifier of the venue section for this admission - `admission` Admission — Admission represents a specific type or category of ticket available for an event - `id` string, required — A unique identifier for this admission - `name` string, required — The display name of the admission type shown to customers - `subtitle` string — Short supporting text shown below the admission name - `description` string — Detailed information shown when customers expand 'More info' - `capacity` number — Maximum number of tickets that can be sold for this admission type. A value of -1 indicates unlimited - `limit` number — Maximum number of tickets of this admission type that can be purchased in a single order. A value of -1 indicates unlimited - `available` number, required — Current number of tickets available for purchase, calculated as capacity minus sold minus reserved. A value of -1 indicates unlimited - `sold` number, required — Total number of tickets of this admission type that have been purchased - `reserved` number, required — Number of tickets held for customers during checkout and not available to others - `order` number, required — Determines the position in which this admission type appears when listed. Lower values appear first - `createdAt` string, date-time, required — Timestamp in ISO 8601 format when this admission type was created - `updatedAt` string, date-time, required — Timestamp in ISO 8601 format when this admission type was last updated - `entryStartsAt` string, required — Wall clock time from which tickets of this type are valid for entry (no timezone) - `entryEndsAt` string, required — Wall clock time until which tickets of this type are valid for entry (no timezone) - `saleStartsAt` string, required — Wall clock time when ticket sales for this admission type begin (no timezone) - `saleEndsAt` string, required — Wall clock time when ticket sales for this admission type end (no timezone) - `saleEndsBehavior` 'SALE_ENDED' | 'SOLD_OUT' | 'DOOR' — Label to display for this admission after ticket sales have ended - `price` object, required — Pricing details for this admission type, including base cost and fees in cents, and currency - `base` integer, required — Base cost of a ticket for this admission type before fees, in cents - `booking` integer, required — Additional booking fee applied to the ticket price, in cents - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Three-letter ISO 4217 currency code for the ticket price - `override` object — Optional pricing override used to calculate derived fee amounts. - … - `visibility` 'ALWAYS' | 'HIDDEN' | 'AFTER_ADMISSION' — Controls whether this admission type is shown publicly, revealed by a scoped coupon, or unlocked after another admission. - `visibleAfterAdmissionId` string, nullable — Unique admission identifier - `sectionId` string, nullable — Unique section identifier - `teamId` string, required — Team that owns this admission. Denormalized for efficient queries. - `promoterId` string, required — Identifier of the promoter responsible for this admission type - `eventId` string, required — Identifier of the event to which this admission type is linked - `eventSlug` string, required — URL-friendly slug for the event associated with this admission type - `section` Section — A section represents a distinct area or tier within an event venue with its own capacity and pricing - `id` string, required — Unique identifier for the section - `createdAt` string, date-time, required — Timestamp when the section was created in ISO 8601 format - `updatedAt` string, date-time, required — Timestamp when the section was last updated in ISO 8601 format - `name` string, required — Display name of the section (e.g., 'VIP Area', 'General Admission') - `capacity` number — Maximum number of attendees for this section. Use -1 for unlimited capacity - `limit` number — Maximum number of tickets for this section that can be purchased in a single order. A value of -1 indicates unlimited - `available` number, required — Number of tickets currently available for purchase in this section. Use -1 when capacity is unlimited - `sold` number, required — Number of tickets sold for this section - `reserved` number, required — Number of tickets currently reserved (in pending orders) for this section - `order` number, required — Display order of the section. Lower numbers appear first in listings - `visibility` 'ALWAYS' | 'STACKED' | 'HIDDEN' — Controls how this section is shown: always list all visible admissions, stack to show the cheapest available admission, or hide until a scoped coupon reveals it. - `location` object, required — Physical location details for the section - `id` string, required — Location identifier - `googlePlaceId` string — Google Place ID for this location - `createdAt` string, date-time, required — Timestamp in ISO 8601 format when the location was created - `updatedAt` string, date-time, required — Timestamp in ISO 8601 format when the location was last updated - `name` string, required — Location name - `address` string, required — Formatted address - `city` string — City name - `state` string — State or region - `postcode` string — Postal code - `country` string, required — Country name - `latitude` number, required — Latitude coordinate - `longitude` number, required — Longitude coordinate - `timeZone` string, required — IANA timezone identifier (e.g., 'America/New_York', 'Europe/London', 'Australia/Sydney', 'UTC'). Must be validated against the IANA timezone database where used. - `types` string[] — Google Place types indicating the category and nature of this location - `description` string — AI-generated description of the place, when available - `image` object — Primary location photo - … - `venueId` string — Venue identifier if this location is a managed venue on the platform - `teamId` string, required — Team that owns this section. Denormalized for efficient queries. - `promoterId` string, required — Unique identifier of the promoter who owns this section - `eventId` string, required — Unique identifier of the event this section belongs to - `eventSlug` string, required — URL-friendly identifier of the event this section belongs to - `price` object, required — Pricing breakdown for this order item including all fees and discounts - `net` integer, required — Total amount to pay to promoter in cents. Calculated as: total - booking - refunded - `total` integer, required — Total amount the customer should pay in cents. Calculated as: gross - discount - `gross` integer, required — Total amount before refunds and discounts in cents. Calculated as: base + booking - `base` integer, required — Total ticket price in cents - `booking` integer, required — Total booking fees in cents (non-refundable) - `refunded` integer, required — Total amount refunded in cents - `discount` integer, required — Total amount discounted in cents - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code in ISO 4217 format. - `fees` object[], required — Gateway fees recorded against this order from settlement processing (e.g. payment processing fees, dispute fees). - `id` string, required — Unique identifier for this order fee - `createdAt` string, date-time, required — Timestamp in ISO 8601 format when this fee was created - `reason` string, required — Description explaining why this fee was applied to the order - `amount` number, required — Fee amount in cents (positive value indicates charge to customer, negative value indicates credit or discount) - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code in ISO 4217 format - `requestId` string, required — External payment processor request identifier for tracking this fee - `kind` 'GATEWAY' | 'SHIPPING' | 'SMS_DELIVERY' — Type of fee for categorization and reporting - `price` object, required — Price breakdown in the event currency. This reflects what the customer was charged. - `net` integer, required — Total amount to pay to promoter in cents. Calculated as: total + booking + refunded + dispute - `total` integer, required — Total amount the customer should pay in cents. Calculated as: gross + discount - `gross` integer, required — Total amount before refunds and discounts in cents. Calculated as: base + booking + shipping - `base` integer, required — Total ticket price in cents - `booking` integer, required — Total booking fees in cents (non-refundable) - `shipping` integer, required — Total shipping amount in cents - `sms` integer — SMS delivery fee in cents (customer-facing price in event currency) - `refunded` integer, required — Total amount refunded in cents (negative value) - `discount` integer, required — Total amount discounted in cents (negative value) - `gateway` integer, required — Total absorbed payment gateway fees in cents (negative value) - `dispute` integer, required — Total non-absorbed payment gateway fees in cents (negative value) - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code in ISO 4217 format - `settlement` object — Price breakdown in the payout currency with the exchange rate applied. When the event currency differs from the settlement currency, all amounts are converted. For same-currency orders the values match the order price with an exchange rate of 1.0. - `net` integer, required — Total amount to pay to promoter in cents. Calculated as: total + booking + refunded + dispute - `total` integer, required — Total amount the customer should pay in cents. Calculated as: gross + discount - `gross` integer, required — Total amount before refunds and discounts in cents. Calculated as: base + booking + shipping - `base` integer, required — Total ticket price in cents - `booking` integer, required — Total booking fees in cents (non-refundable) - `shipping` integer, required — Total shipping amount in cents - `sms` integer — SMS delivery fee in cents (customer-facing price in event currency) - `refunded` integer, required — Total amount refunded in cents (negative value) - `discount` integer, required — Total amount discounted in cents (negative value) - `gateway` integer, required — Total absorbed payment gateway fees in cents (negative value) - `dispute` integer, required — Total non-absorbed payment gateway fees in cents (negative value) - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code in ISO 4217 format - `exchangeRate` number, required — Conversion rate applied from the original payment currency to the settlement currency. 1.0 when both currencies are the same - `couponCode` object — Coupon code applied to this order for discount calculation. - `id` string, required — Unique identifier of the coupon code used in the order - `name` string, required — The coupon code string that was entered by the customer - `couponId` string, required — Unique identifier of the parent coupon configuration - `customer` object — Customer who placed this order. Absent for guest checkouts before customer details are captured. - `id` string, required — Unique identifier of the customer who placed the order - `firstName` string, required — First name of the customer - `lastName` string, required — Last name of the customer - `email` string, email, required — Email address of the customer - `phone` string — Customer phone number in E.164 format for SMS delivery - `marketingConsent` object — Marketing opt-in choices captured during checkout. - `promoter` boolean, required - `tenant` boolean, required - `timeline` object[] — Chronological audit trail of events for this order (payments, refunds, emails, scans). - `id` string, required — Unique identifier of the timeline entry - `createdAt` string, date-time, required — Timestamp in ISO 8601 format when this timeline entry was created - `status` string — Order status associated with this timeline entry, when applicable. - `kind` 'ORDER_STATUS_UPDATED' | 'ORDER_EXPIRED' | 'ORDER_COMPLETED' | 'PAYMENT_INITIATED' | 'PAYMENT_PROCESSING' | 'PAYMENT_FAILED' | 'PAYMENT_SUCCEEDED' | 'REFUND_INITIATED' | 'REFUND_PROCESSING' | 'REFUND_SUCCEEDED' | 'REFUND_SETTLED' | 'REFUND_FAILED' | 'CHARGEBACK_INITIATED' | 'CHARGEBACK_EVIDENCE_SUBMITTED' | 'CHARGEBACK_WON' | 'CHARGEBACK_LOST' | 'CHARGEBACK_FUNDS_WITHDRAWN' | 'TICKETS_GENERATED' | 'TICKET_ADDED' | 'TICKETS_SCANNED' | 'TICKET_EDITED' | 'TICKET_STATUS_CHANGED' | 'EMAIL_SENT' | 'EMAIL_DELIVERED' | 'EMAIL_OPENED' | 'EMAIL_BOUNCED' | 'EMAIL_COMPLAINED' | 'EMAIL_FAILED' | 'SMS_SENT' | 'SMS_DELIVERED' | 'SMS_FAILED' | 'NOTE', required — Type of timeline event (ORDER_COMPLETED, PAYMENT_SUCCEEDED, REFUND_INITIATED, etc.) - `editable` boolean, required — Whether this timeline entry can be edited by users - `pinned` boolean, required — Whether this timeline entry is pinned to the top of the timeline - `description` string, required — Human-readable description of what happened in this timeline event - `author` string, required — Name of the user or system that created this timeline entry - `userId` string — Identifier of the user who created this timeline entry, when available. - `externalId` string — External idempotency key for deduplication (e.g., SES messageId + eventType) - `refunds` object[] — Refunds processed for this order including pending, succeeded, and failed attempts. - `id` string, required — Unique identifier for this refund - `request` object — Request metadata supplied by Sessions or API callers - `idempotencyKey` string — Client-provided key to prevent duplicate refund processing - `status` 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'FAILED', required — Current processing status. PENDING: awaiting gateway confirmation or async processing (e.g., bank transfers). PROCESSING: gateway confirmed, ticket cancellation in progress. SUCCEEDED/FAILED: terminal states. - `acceptedAt` string, date-time — Timestamp when the payment gateway accepted the refund - `failedAt` string, date-time — Timestamp when the refund failed - `failure` object — Failure details when the refund failed - `reason` string, required — Gateway or system failure reason - `message` string — User-facing failure message when available - `price` object, required — Refund amount breakdown - `currency` string, required — Currency used for all refund amounts - `total` integer, required — Total refund amount in cents, including ticket, shipping, and fee portions. - `items` integer, required — Ticket item portion of the refund in cents - `shipping` integer, required — Shipping portion of the refund in cents - `fees` integer, required — Fee portion of the refund in cents - `reason` 'CUSTOMER_REQUEST' | 'DUPLICATE' | 'EVENT_CANCELLED' | 'OTHER', required — Categorized reason for the refund used for analytics - `note` string — Free-form notes explaining the refund - `items` object[], required — Line items included in this refund with quantities and amounts - `orderItemId` string, required — Identifier of the order item being refunded - `quantity` integer, required — Number of units refunded for this item - `amount` integer, required — Refund amount for this item in cents (base price only, excludes booking fee) - `ticketIds` string[], required — Specific ticket identifiers that were refunded (selected via FIFO) - `tickets` object, required — Ticket cancellation state for the refund - `cancelRequested` boolean, required — Whether ticket cancellation was requested for the refund - `cancelled` boolean, required — Whether tickets were cancelled as part of this refund - `cancelledCount` integer, required — Number of tickets that were cancelled - `gateway` object, required — Gateway refund identifiers - `provider` 'FREE' | 'AIRWALLEX' | 'STRIPE', required — Payment gateway used to process the refund - `refundId` string — Refund identifier from the payment gateway - `idempotencyKey` string — Idempotency key sent to the payment gateway - `actor` object, required — Refund initiator - `type` 'USER' | 'GATEWAY' | 'SYSTEM', required — Who initiated the refund - `userId` string — Identifier of the user who initiated the refund - `metadata` object — Custom key-value pairs passed through to the payment gateway - `notification` object, required — Refund confirmation notification state - `requested` boolean, required — Whether a customer refund confirmation email was requested. - `sentAt` string, date-time — Timestamp when the refund confirmation email was sent. - `createdAt` string, date-time, required — Timestamp when the refund was created - `offers` object[] — Pre-computed add-on offers available during checkout (e.g. SMS ticket delivery). - `kind` 'SMS_DELIVERY', required — Discriminator identifying the type of offer - `label` string, required — Human-readable label for the offer - `price` object, required — Pre-computed price for this offer - `amount` integer, required — Offer price in the smallest currency unit (e.g. cents) - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Three-letter ISO 4217 currency code - `customerId` string — Identifier of the customer who placed this order. - `createdBy` object — Admin user who created this order on behalf of the customer. - `id` string, required — Unique identifier of the customer who placed the order - `firstName` string, required — First name of the customer - `lastName` string, required — Last name of the customer - `email` string, email, required — Email address of the customer - `phone` string — Customer phone number in E.164 format for SMS delivery - `teamId` string, required — Team that owns this order. - `promoterId` string, required — Promoter managing this order. - `event` object, required — Snapshot of the event at time of purchase (name, slug, location). - `id` string, required — Unique identifier of the event associated with the order - `name` string, required — Display name of the event - `slug` string, required — URL-friendly slug of the event - `location` string — Name of the venue or location where the event takes place - `locationAddress` string — Full venue address, available once the event location is revealed. - `locationLatitude` number — Venue latitude, available once the event location is revealed. - `locationLongitude` number — Venue longitude, available once the event location is revealed. - `entryInstructions` string — Latest entry instructions for customers once the event location is revealed. - `payoutIds` string[], required — Payout identifiers for settlements that included this order. - `eventId` string, required — Identifier of the event this order belongs to. - `checkoutUrl` string — Derived checkout URL where the customer can complete payment for this order. - `returnUrl` string — URL to redirect to after successful payment completion. - `channel` object — Channel metadata captured at order creation to identify origin and redirect context. - `name` string, required — Free-form channel identifier describing where the order originated. - `referrer` string — Optional referrer URL captured at order creation for redirect routing and attribution. - `utmSource` string — Optional UTM source captured from the originating URL. - `utmMedium` string — Optional UTM medium captured from the originating URL. - `utmCampaign` string — Optional UTM campaign captured from the originating URL. - `deviceType` 'MOBILE' | 'TABLET' | 'DESKTOP' — Optional analytics device classification captured at order creation. - `browser` string — Optional analytics browser classification captured at order creation. - `country` string — Optional viewer country captured at order creation for analytics attribution. - `region` string — Optional viewer region captured at order creation for analytics attribution. - `sessionId` string — Session ID captured at order creation for client/server analytics linking. - `anonymousId` string — Browser anonymous ID captured at order creation for attribution linking. - `reservedAt` string, date-time — Timestamp when inventory was reserved for this order. Used for checkout countdown timer. - `price` object, required — Settled price information for this specific order, showing final amounts after refunds and adjustments. - `net` integer, required — Total amount to pay to promoter in cents. Calculated as: total + booking + refunded + dispute - `total` integer, required — Total amount the customer should pay in cents. Calculated as: gross + discount - `gross` integer, required — Total amount before refunds and discounts in cents. Calculated as: base + booking + shipping - `base` integer, required — Total ticket price in cents - `booking` integer, required — Total booking fees in cents (non-refundable) - `shipping` integer, required — Total shipping amount in cents - `sms` integer — SMS delivery fee in cents (customer-facing price in event currency) - `refunded` integer, required — Total amount refunded in cents (negative value) - `discount` integer, required — Total amount discounted in cents (negative value) - `gateway` integer, required — Total absorbed payment gateway fees in cents (negative value) - `dispute` integer, required — Total non-absorbed payment gateway fees in cents (negative value) - `currency` 'AED' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SRD' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code in ISO 4217 format - `split` object, required — How this individual order's revenue is split between different beneficiaries in cents. - `tenant` number, required — Amount allocated to the tenant (platform) in cents. This represents the platform's share of the revenue. - `venue` number, required — Amount allocated to the venue in cents. This represents the venue's share of the revenue from events held at their location. - `team` number, required — Amount allocated to the team in cents. This represents the team's share of the revenue after fees and other deductions. - `sessions` number, required — Amount allocated to Sessions platform commission in cents. This represents the platform's service fees. - `tickets` number, required — Amount allocated to ticketing fees in cents. This represents fees charged for ticket processing and management. - `structure` string, required — Fee structure identifier used to calculate the split for this order. ## Other responses - `400` — 400 - `401` — 401 - `403` — 403 - `404` — 404 - `409` — 409 - `412` — 412 - `422` — 422 - `429` — 429 - `500` — 500 - `501` — 501 - `503` — 503 --- [API](https://skmtc.net/session/apis/session-services-api.md) · [All operations](https://skmtc.net/session/apis/session-services-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/session/session-services-api/versions/a1bb6f6c8a2e/schema)