Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.
Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.
Information about the payment method stored on the checkout session.
Show child attributes
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Gr4vy","colors":{"primary":"#0066CC","light":"#0099FF","dark":"#0066CC"},"logo":{"light":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99","dark":"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/dark.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=7a09594217c27f95e0d127250c4cc958"},"favicon":"https://mintcdn.com/flexxbuy/39tfKGesfNHyX7HE/assets/favicon.png?fit=max\u0026auto=format\u0026n=39tfKGesfNHyX7HE\u0026q=85\u0026s=fc89afd637da9116e218f41f2c6b1105","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["csharp","go","java","php","python","javascript","curl"]},"mdx":{"auth":{"method":"bearer"},"server":["https://api.sandbox.flexxbuy.gr4vy.app","https://api.flexxbuy.gr4vy.app"]}},"navbar":{"links":[{"icon":"bell","href":"https://status.gr4vy.com","label":"Status"},{"icon":"github","href":"https://github.com/gr4vy","label":"GitHub"}],"primary":{"type":"button","label":"Gr4vy","href":"https://gr4vy.com/#form-contact"}},"footer":{"socials":{"website":"https://gr4vy.com","twitter":"https://twitter.com/Gr4vyInc","github":"https://github.com/gr4vy","linkedin":"https://www.linkedin.com/company/gr4vy-inc"},"links":[{"header":"About","items":[{"label":"Payment orchestration","href":"https://gr4vy.com/payment-orchestration"},{"label":"Gr4vy for merchants","href":"https://gr4vy.com/merchants"},{"label":"Gr4vy for platforms","href":"https://gr4vy.com/platforms"},{"label":"Increasing your revenue","href":"https://gr4vy.com/revenue"}]},{"header":"Developers","items":[{"label":"GitHub","href":"https://github.com/gr4vy"},{"label":"Latest news","href":"https://docs.gr4vy.com/updates"},{"label":"System status","href":"https://status.gr4vy.com"},{"label":"Customer support","href":"https://support.gr4vy.com"}]}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"gtm":{"tagId":"G-9CX4E9QWKQ"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexxbuy","hasAudioNarration":false,"actualSubdomain":"flexxbuy","customDomains":["docs.byzly.com"],"gitSource":{"type":"github","owner":"gr4vy","repo":"flexxbuy-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf64bc3d6319f7be041995","collectionId":"bdb65d06-a21b-40ca-800b-8b423f379e82","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf64bc3d6319f7be041995"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf64bc3d6319f7be041995","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Build","count":195},{"language":"default","tag":"API Reference","count":171},{"language":"default","tag":"Connections","count":168},{"language":"default","tag":"Methods","count":141},{"language":"default","tag":"Features","count":95},{"language":"default","tag":"Integration guides","count":91},{"language":"default","tag":"Banking","count":46},{"language":"default","tag":"Dashboard","count":44},{"language":"default","tag":"Other","count":39},{"language":"default","tag":"Embed","count":38}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".payment-service-definition{background-color:#fff!important;border:1px solid #0a0e0d1a;border-radius:16px;padding:2em;vertical-align:middle}.payment-service-definition img{margin:0 1em 0 0;max-width:3em;display:inline-block}.payment-service-definition h2{margin:0;display:inline-block;position:relative;top:.1em}#sidebar-title{text-transform:uppercase}#sidebar-group .group{flex-direction:row-reverse}#footer .max-w-36{max-width:40rem}"}],"page":{"pagePath":"reference/checkout-sessions/new-checkout-session","slug":"/reference/checkout-sessions/new-checkout-session","pageMetadata":{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","description":"Create a new checkout session.","href":"/reference/checkout-sessions/new-checkout-session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new checkout session.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`This endpoint requires the `,_jsx(_components.code,{children:`checkout-sessions.write`}),` scope.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","description":"Create a new checkout session.","href":"/reference/checkout-sessions/new-checkout-session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Checkout sessions"],"summary":"Create checkout session","description":"Create a new checkout session.","operationId":"create_checkout_session","parameters":["2e941988-9b5b-4810-b7a0-2a8f5842072f"],"requestBody":"f5758ab3-7f44-4338-9af0-bf7e5db35c5f","responses":{"201":"d2f75d6e-8f8e-4686-a1ed-61b8cdb47c72","400":"30eb68b3-0b40-4b81-9fff-df9e25795a47","401":"f44ce367-1cba-4cdc-8d00-1a5f9aedfbbc","403":"90a6a540-db7e-49c5-a5d6-eac4475a2d6f","404":"d5d3ea14-8453-4a72-af83-a43bae634922","405":"25a620d1-7341-429a-a5cf-61bff9b1bb7a","409":"d6f195db-022c-4001-8112-f7021e0145dd","422":"8ba9a125-dd41-4385-aefd-aa8beed9a5fb","425":"6266f95e-820d-4c4e-a8ab-085b3da7ff5e","429":"3c9e7b1a-12b8-44cd-a299-433c51d703f0","500":"ed8316be-123f-4111-a971-524830b99041","502":"07614aff-8e71-4381-88c9-1990a9840622","504":"d65c73cd-8371-42d8-8e32-d4be49a684ee"},"x-speakeasy-name-override":"create","x-speakeasy-group":"checkout-sessions","x-codeSamples":[{"lang":"go","label":"Go","source":"package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tgr4vygo \"github.com/gr4vy/gr4vy-go\"\n\t\"github.com/gr4vy/gr4vy-go/models/components\"\n\t\"github.com/gr4vy/gr4vy-go/types\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := gr4vygo.New(\n gr4vygo.WithMerchantAccountID(\"default\"),\n gr4vygo.WithSecurity(os.Getenv(\"GR4VY_BEARER_AUTH\")),\n )\n\n res, err := s.CheckoutSessions.Create(ctx, nil, \u0026components.CheckoutSessionCreate{\n CartItems: []components.CartItem{\n components.CartItem{\n Name: \"GoPro HD\",\n Quantity: 2,\n UnitAmount: 1299,\n DiscountAmount: gr4vygo.Pointer[int64](0),\n TaxAmount: gr4vygo.Pointer[int64](0),\n ExternalIdentifier: gr4vygo.Pointer(\"goprohd\"),\n Sku: gr4vygo.Pointer(\"GPHD1078\"),\n ProductURL: gr4vygo.Pointer(\"https://example.com/catalog/go-pro-hd\"),\n ImageURL: gr4vygo.Pointer(\"https://example.com/images/go-pro-hd.jpg\"),\n Categories: []string{\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType: components.ProductTypePhysical.ToPointer(),\n SellerCountry: gr4vygo.Pointer(\"US\"),\n },\n components.CartItem{\n Name: \"GoPro HD\",\n Quantity: 2,\n UnitAmount: 1299,\n DiscountAmount: gr4vygo.Pointer[int64](0),\n TaxAmount: gr4vygo.Pointer[int64](0),\n ExternalIdentifier: gr4vygo.Pointer(\"goprohd\"),\n Sku: gr4vygo.Pointer(\"GPHD1078\"),\n ProductURL: gr4vygo.Pointer(\"https://example.com/catalog/go-pro-hd\"),\n ImageURL: gr4vygo.Pointer(\"https://example.com/images/go-pro-hd.jpg\"),\n Categories: []string{\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType: components.ProductTypePhysical.ToPointer(),\n SellerCountry: gr4vygo.Pointer(\"US\"),\n },\n },\n Metadata: map[string]string{\n \"cohort\": \"cohort-a\",\n \"order_id\": \"order-12345\",\n },\n Buyer: nil,\n Airline: \u0026components.Airline{\n BookingCode: gr4vygo.Pointer(\"X36Q9C\"),\n IsCardholderTraveling: gr4vygo.Pointer(true),\n IssuedAddress: gr4vygo.Pointer(\"123 Broadway, New York\"),\n IssuedAt: types.MustNewTimeFromString(\"2013-07-16T19:23:00.000+00:00\"),\n IssuingCarrierCode: gr4vygo.Pointer(\"649\"),\n IssuingCarrierName: gr4vygo.Pointer(\"Air Transat A.T. Inc\"),\n IssuingIataDesignator: gr4vygo.Pointer(\"TS\"),\n IssuingIcaoCode: gr4vygo.Pointer(\"TSC\"),\n Legs: []components.AirlineLeg{\n components.AirlineLeg{\n ArrivalAirport: gr4vygo.Pointer(\"LAX\"),\n ArrivalAt: types.MustNewTimeFromString(\"2013-07-16T19:23:00.000+00:00\"),\n ArrivalCity: gr4vygo.Pointer(\"Los Angeles\"),\n ArrivalCountry: gr4vygo.Pointer(\"US\"),\n CarrierCode: gr4vygo.Pointer(\"649\"),\n CarrierName: gr4vygo.Pointer(\"Air Transat A.T. Inc\"),\n IataDesignator: gr4vygo.Pointer(\"TS\"),\n IcaoCode: gr4vygo.Pointer(\"TSC\"),\n CouponNumber: gr4vygo.Pointer(\"15885566\"),\n DepartureAirport: gr4vygo.Pointer(\"LHR\"),\n DepartureAt: types.MustNewTimeFromString(\"2013-07-16T19:23:00.000+00:00\"),\n DepartureCity: gr4vygo.Pointer(\"London\"),\n DepartureCountry: gr4vygo.Pointer(\"GB\"),\n DepartureTaxAmount: gr4vygo.Pointer[int64](1200),\n FareAmount: gr4vygo.Pointer[int64](129900),\n FareBasisCode: gr4vygo.Pointer(\"FY\"),\n FeeAmount: gr4vygo.Pointer[int64](1200),\n FlightClass: gr4vygo.Pointer(\"E\"),\n FlightNumber: gr4vygo.Pointer(\"101\"),\n RouteType: components.RouteTypeRoundTrip.ToPointer(),\n SeatClass: gr4vygo.Pointer(\"F\"),\n StopOver: gr4vygo.Pointer(false),\n TaxAmount: gr4vygo.Pointer[int64](1200),\n },\n },\n PassengerNameRecord: gr4vygo.Pointer(\"JOHN L\"),\n Passengers: []components.AirlinePassenger{\n components.AirlinePassenger{\n AgeGroup: components.AgeGroupAdult.ToPointer(),\n DateOfBirth: types.MustNewDateFromString(\"2013-07-16\"),\n EmailAddress: gr4vygo.Pointer(\"john@example.com\"),\n FirstName: gr4vygo.Pointer(\"John\"),\n FrequentFlyerNumber: gr4vygo.Pointer(\"15885566\"),\n LastName: gr4vygo.Pointer(\"Luhn\"),\n PassportNumber: gr4vygo.Pointer(\"11117700225\"),\n PhoneNumber: gr4vygo.Pointer(\"+1234567890\"),\n TicketNumber: gr4vygo.Pointer(\"BA1236699999\"),\n Title: gr4vygo.Pointer(\"Mr.\"),\n CountryCode: gr4vygo.Pointer(\"US\"),\n },\n components.AirlinePassenger{\n AgeGroup: components.AgeGroupAdult.ToPointer(),\n DateOfBirth: types.MustNewDateFromString(\"2013-07-16\"),\n EmailAddress: gr4vygo.Pointer(\"john@example.com\"),\n FirstName: gr4vygo.Pointer(\"John\"),\n FrequentFlyerNumber: gr4vygo.Pointer(\"15885566\"),\n LastName: gr4vygo.Pointer(\"Luhn\"),\n PassportNumber: gr4vygo.Pointer(\"11117700225\"),\n PhoneNumber: gr4vygo.Pointer(\"+1234567890\"),\n TicketNumber: gr4vygo.Pointer(\"BA1236699999\"),\n Title: gr4vygo.Pointer(\"Mr.\"),\n CountryCode: gr4vygo.Pointer(\"US\"),\n },\n },\n ReservationSystem: gr4vygo.Pointer(\"Amadeus\"),\n RestrictedTicket: gr4vygo.Pointer(false),\n TicketDeliveryMethod: components.TicketDeliveryMethodElectronic.ToPointer(),\n TicketNumber: gr4vygo.Pointer(\"123-1234-151555\"),\n TravelAgencyCode: gr4vygo.Pointer(\"12345\"),\n TravelAgencyInvoiceNumber: gr4vygo.Pointer(\"EG15555155\"),\n TravelAgencyName: gr4vygo.Pointer(\"ACME Agency\"),\n TravelAgencyPlanName: gr4vygo.Pointer(\"B733\"),\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n // handle response\n }\n}"},{"lang":"javascript","label":"TypeScript","source":"import { Gr4vy, withToken } from \"@gr4vy/sdk\";\nimport fs from \"fs\";\n\nconst gr4vy = new Gr4vy({\n id: \"example\",\n server: \"sandbox\",\n merchantAccountId: \"default\",\n bearerAuth: withToken({\n privateKey: fs.readFileSync(\"private_key.pem\", \"utf8\"),\n }),\n});\n\nasync function run() {\n const result = await gr4vy.checkoutSessions.create();\n\n console.log(result);\n}\n\nrun();"},{"lang":"java","label":"Java","source":"package hello.world;\n\nimport com.gr4vy.sdk.Gr4vy;\nimport com.gr4vy.sdk.models.components.*;\nimport com.gr4vy.sdk.models.errors.*;\nimport com.gr4vy.sdk.models.operations.CreateCheckoutSessionResponse;\nimport java.lang.Exception;\nimport java.time.LocalDate;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\nimport org.openapitools.jackson.nullable.JsonNullable;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Gr4vy sdk = Gr4vy.builder()\n .merchantAccountId(\"default\")\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n CreateCheckoutSessionResponse res = sdk.checkoutSessions().create()\n .checkoutSessionCreate(CheckoutSessionCreate.builder()\n .cartItems(List.of(\n CartItem.builder()\n .name(\"GoPro HD\")\n .quantity(2L)\n .unitAmount(1299L)\n .discountAmount(0L)\n .taxAmount(0L)\n .externalIdentifier(\"goprohd\")\n .sku(\"GPHD1078\")\n .productUrl(\"https://example.com/catalog/go-pro-hd\")\n .imageUrl(\"https://example.com/images/go-pro-hd.jpg\")\n .categories(List.of(\n \"camera\",\n \"travel\",\n \"gear\"))\n .productType(ProductType.PHYSICAL)\n .sellerCountry(\"US\")\n .build(),\n CartItem.builder()\n .name(\"GoPro HD\")\n .quantity(2L)\n .unitAmount(1299L)\n .discountAmount(0L)\n .taxAmount(0L)\n .externalIdentifier(\"goprohd\")\n .sku(\"GPHD1078\")\n .productUrl(\"https://example.com/catalog/go-pro-hd\")\n .imageUrl(\"https://example.com/images/go-pro-hd.jpg\")\n .categories(List.of(\n \"camera\",\n \"travel\",\n \"gear\"))\n .productType(ProductType.PHYSICAL)\n .sellerCountry(\"US\")\n .build()))\n .metadata(Map.ofEntries(\n Map.entry(\"cohort\", \"cohort-a\"),\n Map.entry(\"order_id\", \"order-12345\")))\n .buyer(JsonNullable.of(null))\n .airline(Airline.builder()\n .bookingCode(\"X36Q9C\")\n .isCardholderTraveling(true)\n .issuedAddress(\"123 Broadway, New York\")\n .issuedAt(OffsetDateTime.parse(\"2013-07-16T19:23:00.000+00:00\"))\n .issuingCarrierCode(\"649\")\n .issuingCarrierName(\"Air Transat A.T. Inc\")\n .issuingIataDesignator(\"TS\")\n .issuingIcaoCode(\"TSC\")\n .legs(List.of(\n AirlineLeg.builder()\n .arrivalAirport(\"LAX\")\n .arrivalAt(OffsetDateTime.parse(\"2013-07-16T19:23:00.000+00:00\"))\n .arrivalCity(\"Los Angeles\")\n .arrivalCountry(\"US\")\n .carrierCode(\"649\")\n .carrierName(\"Air Transat A.T. Inc\")\n .iataDesignator(\"TS\")\n .icaoCode(\"TSC\")\n .couponNumber(\"15885566\")\n .departureAirport(\"LHR\")\n .departureAt(OffsetDateTime.parse(\"2013-07-16T19:23:00.000+00:00\"))\n .departureCity(\"London\")\n .departureCountry(\"GB\")\n .departureTaxAmount(1200L)\n .fareAmount(129900L)\n .fareBasisCode(\"FY\")\n .feeAmount(1200L)\n .flightClass(\"E\")\n .flightNumber(\"101\")\n .routeType(RouteType.ROUND_TRIP)\n .seatClass(\"F\")\n .stopOver(false)\n .taxAmount(1200L)\n .build()))\n .passengerNameRecord(\"JOHN L\")\n .passengers(List.of(\n AirlinePassenger.builder()\n .ageGroup(AgeGroup.ADULT)\n .dateOfBirth(LocalDate.parse(\"2013-07-16\"))\n .emailAddress(\"john@example.com\")\n .firstName(\"John\")\n .frequentFlyerNumber(\"15885566\")\n .lastName(\"Luhn\")\n .passportNumber(\"11117700225\")\n .phoneNumber(\"+1234567890\")\n .ticketNumber(\"BA1236699999\")\n .title(\"Mr.\")\n .countryCode(\"US\")\n .build(),\n AirlinePassenger.builder()\n .ageGroup(AgeGroup.ADULT)\n .dateOfBirth(LocalDate.parse(\"2013-07-16\"))\n .emailAddress(\"john@example.com\")\n .firstName(\"John\")\n .frequentFlyerNumber(\"15885566\")\n .lastName(\"Luhn\")\n .passportNumber(\"11117700225\")\n .phoneNumber(\"+1234567890\")\n .ticketNumber(\"BA1236699999\")\n .title(\"Mr.\")\n .countryCode(\"US\")\n .build()))\n .reservationSystem(\"Amadeus\")\n .restrictedTicket(false)\n .ticketDeliveryMethod(TicketDeliveryMethod.ELECTRONIC)\n .ticketNumber(\"123-1234-151555\")\n .travelAgencyCode(\"12345\")\n .travelAgencyInvoiceNumber(\"EG15555155\")\n .travelAgencyName(\"ACME Agency\")\n .travelAgencyPlanName(\"B733\")\n .build())\n .build())\n .call();\n\n if (res.checkoutSession().isPresent()) {\n System.out.println(res.checkoutSession().get());\n }\n }\n}"},{"lang":"python","label":"Python","source":"from datetime import date\nfrom gr4vy import Gr4vy, models\nfrom gr4vy.utils import parse_datetime\nimport os\n\n\nwith Gr4vy(\n id=\"example\",\n server=\"sandbox\",\n merchant_account_id=\"default\",\n bearer_auth=auth.with_token(open(\"./private_key.pem\").read())\n) as g_client:\n\n res = g_client.checkout_sessions.create(checkout_session_create=models.CheckoutSessionCreate(\n cart_items=[\n models.CartItem(\n name=\"GoPro HD\",\n quantity=2,\n unit_amount=1299,\n discount_amount=0,\n tax_amount=0,\n external_identifier=\"goprohd\",\n sku=\"GPHD1078\",\n product_url=\"https://example.com/catalog/go-pro-hd\",\n image_url=\"https://example.com/images/go-pro-hd.jpg\",\n categories=[\n \"camera\",\n \"travel\",\n \"gear\",\n ],\n product_type=\"physical\",\n seller_country=\"GB\",\n ),\n models.CartItem(\n name=\"GoPro HD\",\n quantity=2,\n unit_amount=1299,\n discount_amount=0,\n tax_amount=0,\n external_identifier=\"goprohd\",\n sku=\"GPHD1078\",\n product_url=\"https://example.com/catalog/go-pro-hd\",\n image_url=\"https://example.com/images/go-pro-hd.jpg\",\n categories=[\n \"camera\",\n \"travel\",\n \"gear\",\n ],\n product_type=\"physical\",\n seller_country=\"GB\",\n ),\n models.CartItem(\n name=\"GoPro HD\",\n quantity=2,\n unit_amount=1299,\n discount_amount=0,\n tax_amount=0,\n external_identifier=\"goprohd\",\n sku=\"GPHD1078\",\n product_url=\"https://example.com/catalog/go-pro-hd\",\n image_url=\"https://example.com/images/go-pro-hd.jpg\",\n categories=[\n \"camera\",\n \"travel\",\n \"gear\",\n ],\n product_type=\"physical\",\n seller_country=\"GB\",\n ),\n ],\n metadata={\n \"cohort\": \"cohort-a\",\n \"order_id\": \"order-12345\",\n },\n buyer=models.GuestBuyer(\n display_name=\"John Doe\",\n external_identifier=\"buyer-12345\",\n billing_details=models.BillingDetails(\n first_name=\"John\",\n last_name=\"Doe\",\n email_address=\"john@example.com\",\n phone_number=\"+1234567890\",\n address=models.Address(\n city=\"San Jose\",\n country=\"US\",\n postal_code=\"94560\",\n state=\"California\",\n state_code=\"US-CA\",\n house_number_or_name=\"10\",\n line1=\"Stafford Appartments\",\n line2=\"29th Street\",\n organization=\"Gr4vy\",\n ),\n tax_id=models.TaxID(\n value=\"12345678931\",\n kind=\"ar.cuit\",\n ),\n ),\n shipping_details=models.ShippingDetailsCreate(\n first_name=\"John\",\n last_name=\"Doe\",\n email_address=\"john@example.com\",\n phone_number=\"+1234567890\",\n address=models.Address(\n city=\"San Jose\",\n country=\"US\",\n postal_code=\"94560\",\n state=\"California\",\n state_code=\"US-CA\",\n house_number_or_name=\"10\",\n line1=\"Stafford Appartments\",\n line2=\"29th Street\",\n organization=\"Gr4vy\",\n ),\n ),\n ),\n airline=models.Airline(\n booking_code=\"X36Q9C\",\n is_cardholder_traveling=True,\n issued_address=\"123 Broadway, New York\",\n issued_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n issuing_carrier_code=\"649\",\n issuing_carrier_name=\"Air Transat A.T. Inc\",\n issuing_iata_designator=\"TS\",\n issuing_icao_code=\"TSC\",\n legs=[\n models.AirlineLeg(\n arrival_airport=\"LAX\",\n arrival_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n arrival_city=\"Los Angeles\",\n arrival_country=\"US\",\n carrier_code=\"649\",\n carrier_name=\"Air Transat A.T. Inc\",\n iata_designator=\"TS\",\n icao_code=\"TSC\",\n coupon_number=\"15885566\",\n departure_airport=\"LHR\",\n departure_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n departure_city=\"London\",\n departure_country=\"GB\",\n departure_tax_amount=1200,\n fare_amount=129900,\n fare_basis_code=\"FY\",\n fee_amount=1200,\n flight_class=\"E\",\n flight_number=\"101\",\n route_type=\"round_trip\",\n seat_class=\"F\",\n stop_over=False,\n tax_amount=1200,\n ),\n models.AirlineLeg(\n arrival_airport=\"LAX\",\n arrival_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n arrival_city=\"Los Angeles\",\n arrival_country=\"US\",\n carrier_code=\"649\",\n carrier_name=\"Air Transat A.T. Inc\",\n iata_designator=\"TS\",\n icao_code=\"TSC\",\n coupon_number=\"15885566\",\n departure_airport=\"LHR\",\n departure_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n departure_city=\"London\",\n departure_country=\"GB\",\n departure_tax_amount=1200,\n fare_amount=129900,\n fare_basis_code=\"FY\",\n fee_amount=1200,\n flight_class=\"E\",\n flight_number=\"101\",\n route_type=\"round_trip\",\n seat_class=\"F\",\n stop_over=False,\n tax_amount=1200,\n ),\n models.AirlineLeg(\n arrival_airport=\"LAX\",\n arrival_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n arrival_city=\"Los Angeles\",\n arrival_country=\"US\",\n carrier_code=\"649\",\n carrier_name=\"Air Transat A.T. Inc\",\n iata_designator=\"TS\",\n icao_code=\"TSC\",\n coupon_number=\"15885566\",\n departure_airport=\"LHR\",\n departure_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n departure_city=\"London\",\n departure_country=\"GB\",\n departure_tax_amount=1200,\n fare_amount=129900,\n fare_basis_code=\"FY\",\n fee_amount=1200,\n flight_class=\"E\",\n flight_number=\"101\",\n route_type=\"round_trip\",\n seat_class=\"F\",\n stop_over=False,\n tax_amount=1200,\n ),\n ],\n passenger_name_record=\"JOHN L\",\n passengers=[\n models.AirlinePassenger(\n age_group=\"adult\",\n date_of_birth=date.fromisoformat(\"2013-07-16\"),\n email_address=\"john@example.com\",\n first_name=\"John\",\n frequent_flyer_number=\"15885566\",\n last_name=\"Luhn\",\n passport_number=\"11117700225\",\n phone_number=\"+1234567890\",\n ticket_number=\"BA1236699999\",\n title=\"Mr.\",\n country_code=\"US\",\n ),\n models.AirlinePassenger(\n age_group=\"adult\",\n date_of_birth=date.fromisoformat(\"2013-07-16\"),\n email_address=\"john@example.com\",\n first_name=\"John\",\n frequent_flyer_number=\"15885566\",\n last_name=\"Luhn\",\n passport_number=\"11117700225\",\n phone_number=\"+1234567890\",\n ticket_number=\"BA1236699999\",\n title=\"Mr.\",\n country_code=\"US\",\n ),\n ],\n reservation_system=\"Amadeus\",\n restricted_ticket=False,\n ticket_delivery_method=\"electronic\",\n ticket_number=\"123-1234-151555\",\n travel_agency_code=\"12345\",\n travel_agency_invoice_number=\"EG15555155\",\n travel_agency_name=\"ACME Agency\",\n travel_agency_plan_name=\"B733\",\n ),\n ))\n\n # Handle response\n print(res)"},{"lang":"csharp","label":"C#","source":"using Gr4vy;\nusing Gr4vy.Models.Components;\nusing NodaTime;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new Gr4vySDK(\n id: \"example\",\n server: SDKConfig.Server.Sandbox,\n bearerAuthSource: Auth.WithToken(privateKey),\n merchantAccountId: \"default\"\n);\n\nvar res = await sdk.CheckoutSessions.CreateAsync(checkoutSessionCreate: new CheckoutSessionCreate() {\n CartItems = new List\u003cCartItem>() {\n new CartItem() {\n Name = \"GoPro HD\",\n Quantity = 2,\n UnitAmount = 1299,\n DiscountAmount = 0,\n TaxAmount = 0,\n ExternalIdentifier = \"goprohd\",\n Sku = \"GPHD1078\",\n ProductUrl = \"https://example.com/catalog/go-pro-hd\",\n ImageUrl = \"https://example.com/images/go-pro-hd.jpg\",\n Categories = new List\u003cstring>() {\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType = ProductType.Physical,\n SellerCountry = \"GB\",\n },\n new CartItem() {\n Name = \"GoPro HD\",\n Quantity = 2,\n UnitAmount = 1299,\n DiscountAmount = 0,\n TaxAmount = 0,\n ExternalIdentifier = \"goprohd\",\n Sku = \"GPHD1078\",\n ProductUrl = \"https://example.com/catalog/go-pro-hd\",\n ImageUrl = \"https://example.com/images/go-pro-hd.jpg\",\n Categories = new List\u003cstring>() {\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType = ProductType.Physical,\n SellerCountry = \"GB\",\n },\n new CartItem() {\n Name = \"GoPro HD\",\n Quantity = 2,\n UnitAmount = 1299,\n DiscountAmount = 0,\n TaxAmount = 0,\n ExternalIdentifier = \"goprohd\",\n Sku = \"GPHD1078\",\n ProductUrl = \"https://example.com/catalog/go-pro-hd\",\n ImageUrl = \"https://example.com/images/go-pro-hd.jpg\",\n Categories = new List\u003cstring>() {\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType = ProductType.Physical,\n SellerCountry = \"US\",\n },\n },\n Metadata = new Dictionary\u003cstring, string>() {\n { \"cohort\", \"cohort-a\" },\n { \"order_id\", \"order-12345\" },\n },\n Buyer = new GuestBuyer() {\n DisplayName = \"John Doe\",\n ExternalIdentifier = \"buyer-12345\",\n BillingDetails = new BillingDetails() {\n FirstName = \"John\",\n LastName = \"Doe\",\n EmailAddress = \"john@example.com\",\n PhoneNumber = \"+1234567890\",\n Address = new Address() {\n City = \"San Jose\",\n Country = \"US\",\n PostalCode = \"94560\",\n State = \"California\",\n StateCode = \"US-CA\",\n HouseNumberOrName = \"10\",\n Line1 = \"Stafford Appartments\",\n Line2 = \"29th Street\",\n Organization = \"Gr4vy\",\n },\n TaxId = new TaxId() {\n Value = \"12345678931\",\n Kind = TaxIdKind.ArCuit,\n },\n },\n ShippingDetails = new ShippingDetailsCreate() {\n FirstName = \"John\",\n LastName = \"Doe\",\n EmailAddress = \"john@example.com\",\n PhoneNumber = \"+1234567890\",\n Address = new Address() {\n City = \"San Jose\",\n Country = \"US\",\n PostalCode = \"94560\",\n State = \"California\",\n StateCode = \"US-CA\",\n HouseNumberOrName = \"10\",\n Line1 = \"Stafford Appartments\",\n Line2 = \"29th Street\",\n Organization = \"Gr4vy\",\n },\n },\n },\n Airline = new Airline() {\n BookingCode = \"X36Q9C\",\n IsCardholderTraveling = true,\n IssuedAddress = \"123 Broadway, New York\",\n IssuedAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n IssuingCarrierCode = \"649\",\n IssuingCarrierName = \"Air Transat A.T. Inc\",\n IssuingIataDesignator = \"TS\",\n IssuingIcaoCode = \"TSC\",\n Legs = new List\u003cAirlineLeg>() {\n new AirlineLeg() {\n ArrivalAirport = \"LAX\",\n ArrivalAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n ArrivalCity = \"Los Angeles\",\n ArrivalCountry = \"US\",\n CarrierCode = \"649\",\n CarrierName = \"Air Transat A.T. Inc\",\n IataDesignator = \"TS\",\n IcaoCode = \"TSC\",\n CouponNumber = \"15885566\",\n DepartureAirport = \"LHR\",\n DepartureAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n DepartureCity = \"London\",\n DepartureCountry = \"GB\",\n DepartureTaxAmount = 1200,\n FareAmount = 129900,\n FareBasisCode = \"FY\",\n FeeAmount = 1200,\n FlightClass = \"E\",\n FlightNumber = \"101\",\n RouteType = RouteType.RoundTrip,\n SeatClass = \"F\",\n StopOver = false,\n TaxAmount = 1200,\n },\n new AirlineLeg() {\n ArrivalAirport = \"LAX\",\n ArrivalAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n ArrivalCity = \"Los Angeles\",\n ArrivalCountry = \"US\",\n CarrierCode = \"649\",\n CarrierName = \"Air Transat A.T. Inc\",\n IataDesignator = \"TS\",\n IcaoCode = \"TSC\",\n CouponNumber = \"15885566\",\n DepartureAirport = \"LHR\",\n DepartureAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n DepartureCity = \"London\",\n DepartureCountry = \"GB\",\n DepartureTaxAmount = 1200,\n FareAmount = 129900,\n FareBasisCode = \"FY\",\n FeeAmount = 1200,\n FlightClass = \"E\",\n FlightNumber = \"101\",\n RouteType = RouteType.RoundTrip,\n SeatClass = \"F\",\n StopOver = false,\n TaxAmount = 1200,\n },\n new AirlineLeg() {\n ArrivalAirport = \"LAX\",\n ArrivalAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n ArrivalCity = \"Los Angeles\",\n ArrivalCountry = \"US\",\n CarrierCode = \"649\",\n CarrierName = \"Air Transat A.T. Inc\",\n IataDesignator = \"TS\",\n IcaoCode = \"TSC\",\n CouponNumber = \"15885566\",\n DepartureAirport = \"LHR\",\n DepartureAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n DepartureCity = \"London\",\n DepartureCountry = \"GB\",\n DepartureTaxAmount = 1200,\n FareAmount = 129900,\n FareBasisCode = \"FY\",\n FeeAmount = 1200,\n FlightClass = \"E\",\n FlightNumber = \"101\",\n RouteType = RouteType.RoundTrip,\n SeatClass = \"F\",\n StopOver = false,\n TaxAmount = 1200,\n },\n },\n PassengerNameRecord = \"JOHN L\",\n Passengers = new List\u003cAirlinePassenger>() {\n new AirlinePassenger() {\n AgeGroup = AgeGroup.Adult,\n DateOfBirth = LocalDate.FromDateTime(System.DateTime.Parse(\"2013-07-16\")),\n EmailAddress = \"john@example.com\",\n FirstName = \"John\",\n FrequentFlyerNumber = \"15885566\",\n LastName = \"Luhn\",\n PassportNumber = \"11117700225\",\n PhoneNumber = \"+1234567890\",\n TicketNumber = \"BA1236699999\",\n Title = \"Mr.\",\n CountryCode = \"US\",\n },\n new AirlinePassenger() {\n AgeGroup = AgeGroup.Adult,\n DateOfBirth = LocalDate.FromDateTime(System.DateTime.Parse(\"2013-07-16\")),\n EmailAddress = \"john@example.com\",\n FirstName = \"John\",\n FrequentFlyerNumber = \"15885566\",\n LastName = \"Luhn\",\n PassportNumber = \"11117700225\",\n PhoneNumber = \"+1234567890\",\n TicketNumber = \"BA1236699999\",\n Title = \"Mr.\",\n CountryCode = \"US\",\n },\n },\n ReservationSystem = \"Amadeus\",\n RestrictedTicket = false,\n TicketDeliveryMethod = TicketDeliveryMethod.Electronic,\n TicketNumber = \"123-1234-151555\",\n TravelAgencyCode = \"12345\",\n TravelAgencyInvoiceNumber = \"EG15555155\",\n TravelAgencyName = \"ACME Agency\",\n TravelAgencyPlanName = \"B733\",\n },\n});\n\n// handle response"},{"lang":"php","label":"PHP","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Brick\\DateTime\\LocalDate;\nuse Gr4vy;\nuse Gr4vy\\Utils;\n\n$sdk = Gr4vy\\SDK::builder()\n ->setId('example')\n ->setServer('sandbox')\n ->setSecuritySource(Auth::withToken($privateKey))\n ->setMerchantAccountId('default')\n ->build();\n\n$checkoutSessionCreate = new Gr4vy\\CheckoutSessionCreate(\n cartItems: [\n new Gr4vy\\CartItem(\n name: 'GoPro HD',\n quantity: 2,\n unitAmount: 1299,\n discountAmount: 0,\n taxAmount: 0,\n externalIdentifier: 'goprohd',\n sku: 'GPHD1078',\n productUrl: 'https://example.com/catalog/go-pro-hd',\n imageUrl: 'https://example.com/images/go-pro-hd.jpg',\n categories: [\n 'camera',\n 'travel',\n 'gear',\n ],\n productType: 'physical',\n sellerCountry: 'US',\n ),\n new Gr4vy\\CartItem(\n name: 'GoPro HD',\n quantity: 2,\n unitAmount: 1299,\n discountAmount: 0,\n taxAmount: 0,\n externalIdentifier: 'goprohd',\n sku: 'GPHD1078',\n productUrl: 'https://example.com/catalog/go-pro-hd',\n imageUrl: 'https://example.com/images/go-pro-hd.jpg',\n categories: [\n 'camera',\n 'travel',\n 'gear',\n ],\n productType: 'physical',\n sellerCountry: 'US',\n ),\n ],\n metadata: [\n 'cohort' => 'cohort-a',\n 'order_id' => 'order-12345',\n ],\n buyer: new Gr4vy\\GuestBuyer(\n displayName: 'John Doe',\n externalIdentifier: 'buyer-12345',\n billingDetails: new Gr4vy\\BillingDetails(\n firstName: 'John',\n lastName: 'Doe',\n emailAddress: 'john@example.com',\n phoneNumber: '+1234567890',\n address: new Gr4vy\\Address(\n city: 'San Jose',\n country: 'US',\n postalCode: '94560',\n state: 'California',\n stateCode: 'US-CA',\n houseNumberOrName: '10',\n line1: 'Stafford Appartments',\n line2: '29th Street',\n organization: 'Gr4vy',\n ),\n taxId: new Gr4vy\\TaxId(\n value: '12345678931',\n kind: 'my.frp',\n ),\n ),\n shippingDetails: new Gr4vy\\ShippingDetailsCreate(\n firstName: 'John',\n lastName: 'Doe',\n emailAddress: 'john@example.com',\n phoneNumber: '+1234567890',\n address: null,\n ),\n ),\n airline: new Gr4vy\\Airline(\n bookingCode: 'X36Q9C',\n isCardholderTraveling: true,\n issuedAddress: '123 Broadway, New York',\n issuedAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n issuingCarrierCode: '649',\n issuingCarrierName: 'Air Transat A.T. Inc',\n issuingIataDesignator: 'TS',\n issuingIcaoCode: 'TSC',\n legs: [\n new Gr4vy\\AirlineLeg(\n arrivalAirport: 'LAX',\n arrivalAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n arrivalCity: 'Los Angeles',\n arrivalCountry: 'US',\n carrierCode: '649',\n carrierName: 'Air Transat A.T. Inc',\n iataDesignator: 'TS',\n icaoCode: 'TSC',\n couponNumber: '15885566',\n departureAirport: 'LHR',\n departureAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n departureCity: 'London',\n departureCountry: 'GB',\n departureTaxAmount: 1200,\n fareAmount: 129900,\n fareBasisCode: 'FY',\n feeAmount: 1200,\n flightClass: 'E',\n flightNumber: '101',\n routeType: 'round_trip',\n seatClass: 'F',\n stopOver: false,\n taxAmount: 1200,\n ),\n new Gr4vy\\AirlineLeg(\n arrivalAirport: 'LAX',\n arrivalAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n arrivalCity: 'Los Angeles',\n arrivalCountry: 'US',\n carrierCode: '649',\n carrierName: 'Air Transat A.T. Inc',\n iataDesignator: 'TS',\n icaoCode: 'TSC',\n couponNumber: '15885566',\n departureAirport: 'LHR',\n departureAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n departureCity: 'London',\n departureCountry: 'GB',\n departureTaxAmount: 1200,\n fareAmount: 129900,\n fareBasisCode: 'FY',\n feeAmount: 1200,\n flightClass: 'E',\n flightNumber: '101',\n routeType: 'round_trip',\n seatClass: 'F',\n stopOver: false,\n taxAmount: 1200,\n ),\n new Gr4vy\\AirlineLeg(\n arrivalAirport: 'LAX',\n arrivalAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n arrivalCity: 'Los Angeles',\n arrivalCountry: 'US',\n carrierCode: '649',\n carrierName: 'Air Transat A.T. Inc',\n iataDesignator: 'TS',\n icaoCode: 'TSC',\n couponNumber: '15885566',\n departureAirport: 'LHR',\n departureAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n departureCity: 'London',\n departureCountry: 'GB',\n departureTaxAmount: 1200,\n fareAmount: 129900,\n fareBasisCode: 'FY',\n feeAmount: 1200,\n flightClass: 'E',\n flightNumber: '101',\n routeType: 'round_trip',\n seatClass: 'F',\n stopOver: false,\n taxAmount: 1200,\n ),\n ],\n passengerNameRecord: 'JOHN L',\n passengers: [\n new Gr4vy\\AirlinePassenger(\n ageGroup: 'adult',\n dateOfBirth: LocalDate::parse('2013-07-16'),\n emailAddress: 'john@example.com',\n firstName: 'John',\n frequentFlyerNumber: '15885566',\n lastName: 'Luhn',\n passportNumber: '11117700225',\n phoneNumber: '+1234567890',\n ticketNumber: 'BA1236699999',\n title: 'Mr.',\n countryCode: 'US',\n ),\n new Gr4vy\\AirlinePassenger(\n ageGroup: 'adult',\n dateOfBirth: LocalDate::parse('2013-07-16'),\n emailAddress: 'john@example.com',\n firstName: 'John',\n frequentFlyerNumber: '15885566',\n lastName: 'Luhn',\n passportNumber: '11117700225',\n phoneNumber: '+1234567890',\n ticketNumber: 'BA1236699999',\n title: 'Mr.',\n countryCode: 'US',\n ),\n ],\n reservationSystem: 'Amadeus',\n restrictedTicket: false,\n ticketDeliveryMethod: 'electronic',\n ticketNumber: '123-1234-151555',\n travelAgencyCode: '12345',\n travelAgencyInvoiceNumber: 'EG15555155',\n travelAgencyName: 'ACME Agency',\n travelAgencyPlanName: 'B733',\n ),\n);\n\n$response = $sdk->checkoutSessions->create(\n checkoutSessionCreate: $checkoutSessionCreate\n);\n\nif ($response->checkoutSession !== null) {\n // handle response\n}"}],"method":"post","type":"path","servers":["0048b136-b0cb-4528-8f3a-95ce1a20d337","b15a1711-bb6b-4cdf-9106-1a445dacccf7"],"security":["1c94c691-caf6-424e-b0d4-912fcc945a19"],"path":"/checkout/sessions","baseUrlOptions":["https://api.sandbox.{id}.gr4vy.app","https://api.{id}.gr4vy.app"],"title":"Create checkout session","codeSamples":[{"label":"Go","lang":"go","source":"package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tgr4vygo \"github.com/gr4vy/gr4vy-go\"\n\t\"github.com/gr4vy/gr4vy-go/models/components\"\n\t\"github.com/gr4vy/gr4vy-go/types\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := gr4vygo.New(\n gr4vygo.WithMerchantAccountID(\"default\"),\n gr4vygo.WithSecurity(os.Getenv(\"GR4VY_BEARER_AUTH\")),\n )\n\n res, err := s.CheckoutSessions.Create(ctx, nil, \u0026components.CheckoutSessionCreate{\n CartItems: []components.CartItem{\n components.CartItem{\n Name: \"GoPro HD\",\n Quantity: 2,\n UnitAmount: 1299,\n DiscountAmount: gr4vygo.Pointer[int64](0),\n TaxAmount: gr4vygo.Pointer[int64](0),\n ExternalIdentifier: gr4vygo.Pointer(\"goprohd\"),\n Sku: gr4vygo.Pointer(\"GPHD1078\"),\n ProductURL: gr4vygo.Pointer(\"https://example.com/catalog/go-pro-hd\"),\n ImageURL: gr4vygo.Pointer(\"https://example.com/images/go-pro-hd.jpg\"),\n Categories: []string{\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType: components.ProductTypePhysical.ToPointer(),\n SellerCountry: gr4vygo.Pointer(\"US\"),\n },\n components.CartItem{\n Name: \"GoPro HD\",\n Quantity: 2,\n UnitAmount: 1299,\n DiscountAmount: gr4vygo.Pointer[int64](0),\n TaxAmount: gr4vygo.Pointer[int64](0),\n ExternalIdentifier: gr4vygo.Pointer(\"goprohd\"),\n Sku: gr4vygo.Pointer(\"GPHD1078\"),\n ProductURL: gr4vygo.Pointer(\"https://example.com/catalog/go-pro-hd\"),\n ImageURL: gr4vygo.Pointer(\"https://example.com/images/go-pro-hd.jpg\"),\n Categories: []string{\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType: components.ProductTypePhysical.ToPointer(),\n SellerCountry: gr4vygo.Pointer(\"US\"),\n },\n },\n Metadata: map[string]string{\n \"cohort\": \"cohort-a\",\n \"order_id\": \"order-12345\",\n },\n Buyer: nil,\n Airline: \u0026components.Airline{\n BookingCode: gr4vygo.Pointer(\"X36Q9C\"),\n IsCardholderTraveling: gr4vygo.Pointer(true),\n IssuedAddress: gr4vygo.Pointer(\"123 Broadway, New York\"),\n IssuedAt: types.MustNewTimeFromString(\"2013-07-16T19:23:00.000+00:00\"),\n IssuingCarrierCode: gr4vygo.Pointer(\"649\"),\n IssuingCarrierName: gr4vygo.Pointer(\"Air Transat A.T. Inc\"),\n IssuingIataDesignator: gr4vygo.Pointer(\"TS\"),\n IssuingIcaoCode: gr4vygo.Pointer(\"TSC\"),\n Legs: []components.AirlineLeg{\n components.AirlineLeg{\n ArrivalAirport: gr4vygo.Pointer(\"LAX\"),\n ArrivalAt: types.MustNewTimeFromString(\"2013-07-16T19:23:00.000+00:00\"),\n ArrivalCity: gr4vygo.Pointer(\"Los Angeles\"),\n ArrivalCountry: gr4vygo.Pointer(\"US\"),\n CarrierCode: gr4vygo.Pointer(\"649\"),\n CarrierName: gr4vygo.Pointer(\"Air Transat A.T. Inc\"),\n IataDesignator: gr4vygo.Pointer(\"TS\"),\n IcaoCode: gr4vygo.Pointer(\"TSC\"),\n CouponNumber: gr4vygo.Pointer(\"15885566\"),\n DepartureAirport: gr4vygo.Pointer(\"LHR\"),\n DepartureAt: types.MustNewTimeFromString(\"2013-07-16T19:23:00.000+00:00\"),\n DepartureCity: gr4vygo.Pointer(\"London\"),\n DepartureCountry: gr4vygo.Pointer(\"GB\"),\n DepartureTaxAmount: gr4vygo.Pointer[int64](1200),\n FareAmount: gr4vygo.Pointer[int64](129900),\n FareBasisCode: gr4vygo.Pointer(\"FY\"),\n FeeAmount: gr4vygo.Pointer[int64](1200),\n FlightClass: gr4vygo.Pointer(\"E\"),\n FlightNumber: gr4vygo.Pointer(\"101\"),\n RouteType: components.RouteTypeRoundTrip.ToPointer(),\n SeatClass: gr4vygo.Pointer(\"F\"),\n StopOver: gr4vygo.Pointer(false),\n TaxAmount: gr4vygo.Pointer[int64](1200),\n },\n },\n PassengerNameRecord: gr4vygo.Pointer(\"JOHN L\"),\n Passengers: []components.AirlinePassenger{\n components.AirlinePassenger{\n AgeGroup: components.AgeGroupAdult.ToPointer(),\n DateOfBirth: types.MustNewDateFromString(\"2013-07-16\"),\n EmailAddress: gr4vygo.Pointer(\"john@example.com\"),\n FirstName: gr4vygo.Pointer(\"John\"),\n FrequentFlyerNumber: gr4vygo.Pointer(\"15885566\"),\n LastName: gr4vygo.Pointer(\"Luhn\"),\n PassportNumber: gr4vygo.Pointer(\"11117700225\"),\n PhoneNumber: gr4vygo.Pointer(\"+1234567890\"),\n TicketNumber: gr4vygo.Pointer(\"BA1236699999\"),\n Title: gr4vygo.Pointer(\"Mr.\"),\n CountryCode: gr4vygo.Pointer(\"US\"),\n },\n components.AirlinePassenger{\n AgeGroup: components.AgeGroupAdult.ToPointer(),\n DateOfBirth: types.MustNewDateFromString(\"2013-07-16\"),\n EmailAddress: gr4vygo.Pointer(\"john@example.com\"),\n FirstName: gr4vygo.Pointer(\"John\"),\n FrequentFlyerNumber: gr4vygo.Pointer(\"15885566\"),\n LastName: gr4vygo.Pointer(\"Luhn\"),\n PassportNumber: gr4vygo.Pointer(\"11117700225\"),\n PhoneNumber: gr4vygo.Pointer(\"+1234567890\"),\n TicketNumber: gr4vygo.Pointer(\"BA1236699999\"),\n Title: gr4vygo.Pointer(\"Mr.\"),\n CountryCode: gr4vygo.Pointer(\"US\"),\n },\n },\n ReservationSystem: gr4vygo.Pointer(\"Amadeus\"),\n RestrictedTicket: gr4vygo.Pointer(false),\n TicketDeliveryMethod: components.TicketDeliveryMethodElectronic.ToPointer(),\n TicketNumber: gr4vygo.Pointer(\"123-1234-151555\"),\n TravelAgencyCode: gr4vygo.Pointer(\"12345\"),\n TravelAgencyInvoiceNumber: gr4vygo.Pointer(\"EG15555155\"),\n TravelAgencyName: gr4vygo.Pointer(\"ACME Agency\"),\n TravelAgencyPlanName: gr4vygo.Pointer(\"B733\"),\n },\n })\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n // handle response\n }\n}"},{"label":"TypeScript","lang":"javascript","source":"import { Gr4vy, withToken } from \"@gr4vy/sdk\";\nimport fs from \"fs\";\n\nconst gr4vy = new Gr4vy({\n id: \"example\",\n server: \"sandbox\",\n merchantAccountId: \"default\",\n bearerAuth: withToken({\n privateKey: fs.readFileSync(\"private_key.pem\", \"utf8\"),\n }),\n});\n\nasync function run() {\n const result = await gr4vy.checkoutSessions.create();\n\n console.log(result);\n}\n\nrun();"},{"label":"Java","lang":"java","source":"package hello.world;\n\nimport com.gr4vy.sdk.Gr4vy;\nimport com.gr4vy.sdk.models.components.*;\nimport com.gr4vy.sdk.models.errors.*;\nimport com.gr4vy.sdk.models.operations.CreateCheckoutSessionResponse;\nimport java.lang.Exception;\nimport java.time.LocalDate;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\nimport org.openapitools.jackson.nullable.JsonNullable;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Gr4vy sdk = Gr4vy.builder()\n .merchantAccountId(\"default\")\n .bearerAuth(System.getenv().getOrDefault(\"BEARER_AUTH\", \"\"))\n .build();\n\n CreateCheckoutSessionResponse res = sdk.checkoutSessions().create()\n .checkoutSessionCreate(CheckoutSessionCreate.builder()\n .cartItems(List.of(\n CartItem.builder()\n .name(\"GoPro HD\")\n .quantity(2L)\n .unitAmount(1299L)\n .discountAmount(0L)\n .taxAmount(0L)\n .externalIdentifier(\"goprohd\")\n .sku(\"GPHD1078\")\n .productUrl(\"https://example.com/catalog/go-pro-hd\")\n .imageUrl(\"https://example.com/images/go-pro-hd.jpg\")\n .categories(List.of(\n \"camera\",\n \"travel\",\n \"gear\"))\n .productType(ProductType.PHYSICAL)\n .sellerCountry(\"US\")\n .build(),\n CartItem.builder()\n .name(\"GoPro HD\")\n .quantity(2L)\n .unitAmount(1299L)\n .discountAmount(0L)\n .taxAmount(0L)\n .externalIdentifier(\"goprohd\")\n .sku(\"GPHD1078\")\n .productUrl(\"https://example.com/catalog/go-pro-hd\")\n .imageUrl(\"https://example.com/images/go-pro-hd.jpg\")\n .categories(List.of(\n \"camera\",\n \"travel\",\n \"gear\"))\n .productType(ProductType.PHYSICAL)\n .sellerCountry(\"US\")\n .build()))\n .metadata(Map.ofEntries(\n Map.entry(\"cohort\", \"cohort-a\"),\n Map.entry(\"order_id\", \"order-12345\")))\n .buyer(JsonNullable.of(null))\n .airline(Airline.builder()\n .bookingCode(\"X36Q9C\")\n .isCardholderTraveling(true)\n .issuedAddress(\"123 Broadway, New York\")\n .issuedAt(OffsetDateTime.parse(\"2013-07-16T19:23:00.000+00:00\"))\n .issuingCarrierCode(\"649\")\n .issuingCarrierName(\"Air Transat A.T. Inc\")\n .issuingIataDesignator(\"TS\")\n .issuingIcaoCode(\"TSC\")\n .legs(List.of(\n AirlineLeg.builder()\n .arrivalAirport(\"LAX\")\n .arrivalAt(OffsetDateTime.parse(\"2013-07-16T19:23:00.000+00:00\"))\n .arrivalCity(\"Los Angeles\")\n .arrivalCountry(\"US\")\n .carrierCode(\"649\")\n .carrierName(\"Air Transat A.T. Inc\")\n .iataDesignator(\"TS\")\n .icaoCode(\"TSC\")\n .couponNumber(\"15885566\")\n .departureAirport(\"LHR\")\n .departureAt(OffsetDateTime.parse(\"2013-07-16T19:23:00.000+00:00\"))\n .departureCity(\"London\")\n .departureCountry(\"GB\")\n .departureTaxAmount(1200L)\n .fareAmount(129900L)\n .fareBasisCode(\"FY\")\n .feeAmount(1200L)\n .flightClass(\"E\")\n .flightNumber(\"101\")\n .routeType(RouteType.ROUND_TRIP)\n .seatClass(\"F\")\n .stopOver(false)\n .taxAmount(1200L)\n .build()))\n .passengerNameRecord(\"JOHN L\")\n .passengers(List.of(\n AirlinePassenger.builder()\n .ageGroup(AgeGroup.ADULT)\n .dateOfBirth(LocalDate.parse(\"2013-07-16\"))\n .emailAddress(\"john@example.com\")\n .firstName(\"John\")\n .frequentFlyerNumber(\"15885566\")\n .lastName(\"Luhn\")\n .passportNumber(\"11117700225\")\n .phoneNumber(\"+1234567890\")\n .ticketNumber(\"BA1236699999\")\n .title(\"Mr.\")\n .countryCode(\"US\")\n .build(),\n AirlinePassenger.builder()\n .ageGroup(AgeGroup.ADULT)\n .dateOfBirth(LocalDate.parse(\"2013-07-16\"))\n .emailAddress(\"john@example.com\")\n .firstName(\"John\")\n .frequentFlyerNumber(\"15885566\")\n .lastName(\"Luhn\")\n .passportNumber(\"11117700225\")\n .phoneNumber(\"+1234567890\")\n .ticketNumber(\"BA1236699999\")\n .title(\"Mr.\")\n .countryCode(\"US\")\n .build()))\n .reservationSystem(\"Amadeus\")\n .restrictedTicket(false)\n .ticketDeliveryMethod(TicketDeliveryMethod.ELECTRONIC)\n .ticketNumber(\"123-1234-151555\")\n .travelAgencyCode(\"12345\")\n .travelAgencyInvoiceNumber(\"EG15555155\")\n .travelAgencyName(\"ACME Agency\")\n .travelAgencyPlanName(\"B733\")\n .build())\n .build())\n .call();\n\n if (res.checkoutSession().isPresent()) {\n System.out.println(res.checkoutSession().get());\n }\n }\n}"},{"label":"Python","lang":"python","source":"from datetime import date\nfrom gr4vy import Gr4vy, models\nfrom gr4vy.utils import parse_datetime\nimport os\n\n\nwith Gr4vy(\n id=\"example\",\n server=\"sandbox\",\n merchant_account_id=\"default\",\n bearer_auth=auth.with_token(open(\"./private_key.pem\").read())\n) as g_client:\n\n res = g_client.checkout_sessions.create(checkout_session_create=models.CheckoutSessionCreate(\n cart_items=[\n models.CartItem(\n name=\"GoPro HD\",\n quantity=2,\n unit_amount=1299,\n discount_amount=0,\n tax_amount=0,\n external_identifier=\"goprohd\",\n sku=\"GPHD1078\",\n product_url=\"https://example.com/catalog/go-pro-hd\",\n image_url=\"https://example.com/images/go-pro-hd.jpg\",\n categories=[\n \"camera\",\n \"travel\",\n \"gear\",\n ],\n product_type=\"physical\",\n seller_country=\"GB\",\n ),\n models.CartItem(\n name=\"GoPro HD\",\n quantity=2,\n unit_amount=1299,\n discount_amount=0,\n tax_amount=0,\n external_identifier=\"goprohd\",\n sku=\"GPHD1078\",\n product_url=\"https://example.com/catalog/go-pro-hd\",\n image_url=\"https://example.com/images/go-pro-hd.jpg\",\n categories=[\n \"camera\",\n \"travel\",\n \"gear\",\n ],\n product_type=\"physical\",\n seller_country=\"GB\",\n ),\n models.CartItem(\n name=\"GoPro HD\",\n quantity=2,\n unit_amount=1299,\n discount_amount=0,\n tax_amount=0,\n external_identifier=\"goprohd\",\n sku=\"GPHD1078\",\n product_url=\"https://example.com/catalog/go-pro-hd\",\n image_url=\"https://example.com/images/go-pro-hd.jpg\",\n categories=[\n \"camera\",\n \"travel\",\n \"gear\",\n ],\n product_type=\"physical\",\n seller_country=\"GB\",\n ),\n ],\n metadata={\n \"cohort\": \"cohort-a\",\n \"order_id\": \"order-12345\",\n },\n buyer=models.GuestBuyer(\n display_name=\"John Doe\",\n external_identifier=\"buyer-12345\",\n billing_details=models.BillingDetails(\n first_name=\"John\",\n last_name=\"Doe\",\n email_address=\"john@example.com\",\n phone_number=\"+1234567890\",\n address=models.Address(\n city=\"San Jose\",\n country=\"US\",\n postal_code=\"94560\",\n state=\"California\",\n state_code=\"US-CA\",\n house_number_or_name=\"10\",\n line1=\"Stafford Appartments\",\n line2=\"29th Street\",\n organization=\"Gr4vy\",\n ),\n tax_id=models.TaxID(\n value=\"12345678931\",\n kind=\"ar.cuit\",\n ),\n ),\n shipping_details=models.ShippingDetailsCreate(\n first_name=\"John\",\n last_name=\"Doe\",\n email_address=\"john@example.com\",\n phone_number=\"+1234567890\",\n address=models.Address(\n city=\"San Jose\",\n country=\"US\",\n postal_code=\"94560\",\n state=\"California\",\n state_code=\"US-CA\",\n house_number_or_name=\"10\",\n line1=\"Stafford Appartments\",\n line2=\"29th Street\",\n organization=\"Gr4vy\",\n ),\n ),\n ),\n airline=models.Airline(\n booking_code=\"X36Q9C\",\n is_cardholder_traveling=True,\n issued_address=\"123 Broadway, New York\",\n issued_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n issuing_carrier_code=\"649\",\n issuing_carrier_name=\"Air Transat A.T. Inc\",\n issuing_iata_designator=\"TS\",\n issuing_icao_code=\"TSC\",\n legs=[\n models.AirlineLeg(\n arrival_airport=\"LAX\",\n arrival_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n arrival_city=\"Los Angeles\",\n arrival_country=\"US\",\n carrier_code=\"649\",\n carrier_name=\"Air Transat A.T. Inc\",\n iata_designator=\"TS\",\n icao_code=\"TSC\",\n coupon_number=\"15885566\",\n departure_airport=\"LHR\",\n departure_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n departure_city=\"London\",\n departure_country=\"GB\",\n departure_tax_amount=1200,\n fare_amount=129900,\n fare_basis_code=\"FY\",\n fee_amount=1200,\n flight_class=\"E\",\n flight_number=\"101\",\n route_type=\"round_trip\",\n seat_class=\"F\",\n stop_over=False,\n tax_amount=1200,\n ),\n models.AirlineLeg(\n arrival_airport=\"LAX\",\n arrival_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n arrival_city=\"Los Angeles\",\n arrival_country=\"US\",\n carrier_code=\"649\",\n carrier_name=\"Air Transat A.T. Inc\",\n iata_designator=\"TS\",\n icao_code=\"TSC\",\n coupon_number=\"15885566\",\n departure_airport=\"LHR\",\n departure_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n departure_city=\"London\",\n departure_country=\"GB\",\n departure_tax_amount=1200,\n fare_amount=129900,\n fare_basis_code=\"FY\",\n fee_amount=1200,\n flight_class=\"E\",\n flight_number=\"101\",\n route_type=\"round_trip\",\n seat_class=\"F\",\n stop_over=False,\n tax_amount=1200,\n ),\n models.AirlineLeg(\n arrival_airport=\"LAX\",\n arrival_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n arrival_city=\"Los Angeles\",\n arrival_country=\"US\",\n carrier_code=\"649\",\n carrier_name=\"Air Transat A.T. Inc\",\n iata_designator=\"TS\",\n icao_code=\"TSC\",\n coupon_number=\"15885566\",\n departure_airport=\"LHR\",\n departure_at=parse_datetime(\"2013-07-16T19:23:00.000+00:00\"),\n departure_city=\"London\",\n departure_country=\"GB\",\n departure_tax_amount=1200,\n fare_amount=129900,\n fare_basis_code=\"FY\",\n fee_amount=1200,\n flight_class=\"E\",\n flight_number=\"101\",\n route_type=\"round_trip\",\n seat_class=\"F\",\n stop_over=False,\n tax_amount=1200,\n ),\n ],\n passenger_name_record=\"JOHN L\",\n passengers=[\n models.AirlinePassenger(\n age_group=\"adult\",\n date_of_birth=date.fromisoformat(\"2013-07-16\"),\n email_address=\"john@example.com\",\n first_name=\"John\",\n frequent_flyer_number=\"15885566\",\n last_name=\"Luhn\",\n passport_number=\"11117700225\",\n phone_number=\"+1234567890\",\n ticket_number=\"BA1236699999\",\n title=\"Mr.\",\n country_code=\"US\",\n ),\n models.AirlinePassenger(\n age_group=\"adult\",\n date_of_birth=date.fromisoformat(\"2013-07-16\"),\n email_address=\"john@example.com\",\n first_name=\"John\",\n frequent_flyer_number=\"15885566\",\n last_name=\"Luhn\",\n passport_number=\"11117700225\",\n phone_number=\"+1234567890\",\n ticket_number=\"BA1236699999\",\n title=\"Mr.\",\n country_code=\"US\",\n ),\n ],\n reservation_system=\"Amadeus\",\n restricted_ticket=False,\n ticket_delivery_method=\"electronic\",\n ticket_number=\"123-1234-151555\",\n travel_agency_code=\"12345\",\n travel_agency_invoice_number=\"EG15555155\",\n travel_agency_name=\"ACME Agency\",\n travel_agency_plan_name=\"B733\",\n ),\n ))\n\n # Handle response\n print(res)"},{"label":"C#","lang":"csharp","source":"using Gr4vy;\nusing Gr4vy.Models.Components;\nusing NodaTime;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new Gr4vySDK(\n id: \"example\",\n server: SDKConfig.Server.Sandbox,\n bearerAuthSource: Auth.WithToken(privateKey),\n merchantAccountId: \"default\"\n);\n\nvar res = await sdk.CheckoutSessions.CreateAsync(checkoutSessionCreate: new CheckoutSessionCreate() {\n CartItems = new List\u003cCartItem>() {\n new CartItem() {\n Name = \"GoPro HD\",\n Quantity = 2,\n UnitAmount = 1299,\n DiscountAmount = 0,\n TaxAmount = 0,\n ExternalIdentifier = \"goprohd\",\n Sku = \"GPHD1078\",\n ProductUrl = \"https://example.com/catalog/go-pro-hd\",\n ImageUrl = \"https://example.com/images/go-pro-hd.jpg\",\n Categories = new List\u003cstring>() {\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType = ProductType.Physical,\n SellerCountry = \"GB\",\n },\n new CartItem() {\n Name = \"GoPro HD\",\n Quantity = 2,\n UnitAmount = 1299,\n DiscountAmount = 0,\n TaxAmount = 0,\n ExternalIdentifier = \"goprohd\",\n Sku = \"GPHD1078\",\n ProductUrl = \"https://example.com/catalog/go-pro-hd\",\n ImageUrl = \"https://example.com/images/go-pro-hd.jpg\",\n Categories = new List\u003cstring>() {\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType = ProductType.Physical,\n SellerCountry = \"GB\",\n },\n new CartItem() {\n Name = \"GoPro HD\",\n Quantity = 2,\n UnitAmount = 1299,\n DiscountAmount = 0,\n TaxAmount = 0,\n ExternalIdentifier = \"goprohd\",\n Sku = \"GPHD1078\",\n ProductUrl = \"https://example.com/catalog/go-pro-hd\",\n ImageUrl = \"https://example.com/images/go-pro-hd.jpg\",\n Categories = new List\u003cstring>() {\n \"camera\",\n \"travel\",\n \"gear\",\n },\n ProductType = ProductType.Physical,\n SellerCountry = \"US\",\n },\n },\n Metadata = new Dictionary\u003cstring, string>() {\n { \"cohort\", \"cohort-a\" },\n { \"order_id\", \"order-12345\" },\n },\n Buyer = new GuestBuyer() {\n DisplayName = \"John Doe\",\n ExternalIdentifier = \"buyer-12345\",\n BillingDetails = new BillingDetails() {\n FirstName = \"John\",\n LastName = \"Doe\",\n EmailAddress = \"john@example.com\",\n PhoneNumber = \"+1234567890\",\n Address = new Address() {\n City = \"San Jose\",\n Country = \"US\",\n PostalCode = \"94560\",\n State = \"California\",\n StateCode = \"US-CA\",\n HouseNumberOrName = \"10\",\n Line1 = \"Stafford Appartments\",\n Line2 = \"29th Street\",\n Organization = \"Gr4vy\",\n },\n TaxId = new TaxId() {\n Value = \"12345678931\",\n Kind = TaxIdKind.ArCuit,\n },\n },\n ShippingDetails = new ShippingDetailsCreate() {\n FirstName = \"John\",\n LastName = \"Doe\",\n EmailAddress = \"john@example.com\",\n PhoneNumber = \"+1234567890\",\n Address = new Address() {\n City = \"San Jose\",\n Country = \"US\",\n PostalCode = \"94560\",\n State = \"California\",\n StateCode = \"US-CA\",\n HouseNumberOrName = \"10\",\n Line1 = \"Stafford Appartments\",\n Line2 = \"29th Street\",\n Organization = \"Gr4vy\",\n },\n },\n },\n Airline = new Airline() {\n BookingCode = \"X36Q9C\",\n IsCardholderTraveling = true,\n IssuedAddress = \"123 Broadway, New York\",\n IssuedAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n IssuingCarrierCode = \"649\",\n IssuingCarrierName = \"Air Transat A.T. Inc\",\n IssuingIataDesignator = \"TS\",\n IssuingIcaoCode = \"TSC\",\n Legs = new List\u003cAirlineLeg>() {\n new AirlineLeg() {\n ArrivalAirport = \"LAX\",\n ArrivalAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n ArrivalCity = \"Los Angeles\",\n ArrivalCountry = \"US\",\n CarrierCode = \"649\",\n CarrierName = \"Air Transat A.T. Inc\",\n IataDesignator = \"TS\",\n IcaoCode = \"TSC\",\n CouponNumber = \"15885566\",\n DepartureAirport = \"LHR\",\n DepartureAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n DepartureCity = \"London\",\n DepartureCountry = \"GB\",\n DepartureTaxAmount = 1200,\n FareAmount = 129900,\n FareBasisCode = \"FY\",\n FeeAmount = 1200,\n FlightClass = \"E\",\n FlightNumber = \"101\",\n RouteType = RouteType.RoundTrip,\n SeatClass = \"F\",\n StopOver = false,\n TaxAmount = 1200,\n },\n new AirlineLeg() {\n ArrivalAirport = \"LAX\",\n ArrivalAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n ArrivalCity = \"Los Angeles\",\n ArrivalCountry = \"US\",\n CarrierCode = \"649\",\n CarrierName = \"Air Transat A.T. Inc\",\n IataDesignator = \"TS\",\n IcaoCode = \"TSC\",\n CouponNumber = \"15885566\",\n DepartureAirport = \"LHR\",\n DepartureAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n DepartureCity = \"London\",\n DepartureCountry = \"GB\",\n DepartureTaxAmount = 1200,\n FareAmount = 129900,\n FareBasisCode = \"FY\",\n FeeAmount = 1200,\n FlightClass = \"E\",\n FlightNumber = \"101\",\n RouteType = RouteType.RoundTrip,\n SeatClass = \"F\",\n StopOver = false,\n TaxAmount = 1200,\n },\n new AirlineLeg() {\n ArrivalAirport = \"LAX\",\n ArrivalAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n ArrivalCity = \"Los Angeles\",\n ArrivalCountry = \"US\",\n CarrierCode = \"649\",\n CarrierName = \"Air Transat A.T. Inc\",\n IataDesignator = \"TS\",\n IcaoCode = \"TSC\",\n CouponNumber = \"15885566\",\n DepartureAirport = \"LHR\",\n DepartureAt = System.DateTime.Parse(\"2013-07-16T19:23:00.000+00:00\").ToUniversalTime(),\n DepartureCity = \"London\",\n DepartureCountry = \"GB\",\n DepartureTaxAmount = 1200,\n FareAmount = 129900,\n FareBasisCode = \"FY\",\n FeeAmount = 1200,\n FlightClass = \"E\",\n FlightNumber = \"101\",\n RouteType = RouteType.RoundTrip,\n SeatClass = \"F\",\n StopOver = false,\n TaxAmount = 1200,\n },\n },\n PassengerNameRecord = \"JOHN L\",\n Passengers = new List\u003cAirlinePassenger>() {\n new AirlinePassenger() {\n AgeGroup = AgeGroup.Adult,\n DateOfBirth = LocalDate.FromDateTime(System.DateTime.Parse(\"2013-07-16\")),\n EmailAddress = \"john@example.com\",\n FirstName = \"John\",\n FrequentFlyerNumber = \"15885566\",\n LastName = \"Luhn\",\n PassportNumber = \"11117700225\",\n PhoneNumber = \"+1234567890\",\n TicketNumber = \"BA1236699999\",\n Title = \"Mr.\",\n CountryCode = \"US\",\n },\n new AirlinePassenger() {\n AgeGroup = AgeGroup.Adult,\n DateOfBirth = LocalDate.FromDateTime(System.DateTime.Parse(\"2013-07-16\")),\n EmailAddress = \"john@example.com\",\n FirstName = \"John\",\n FrequentFlyerNumber = \"15885566\",\n LastName = \"Luhn\",\n PassportNumber = \"11117700225\",\n PhoneNumber = \"+1234567890\",\n TicketNumber = \"BA1236699999\",\n Title = \"Mr.\",\n CountryCode = \"US\",\n },\n },\n ReservationSystem = \"Amadeus\",\n RestrictedTicket = false,\n TicketDeliveryMethod = TicketDeliveryMethod.Electronic,\n TicketNumber = \"123-1234-151555\",\n TravelAgencyCode = \"12345\",\n TravelAgencyInvoiceNumber = \"EG15555155\",\n TravelAgencyName = \"ACME Agency\",\n TravelAgencyPlanName = \"B733\",\n },\n});\n\n// handle response"},{"label":"PHP","lang":"php","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Brick\\DateTime\\LocalDate;\nuse Gr4vy;\nuse Gr4vy\\Utils;\n\n$sdk = Gr4vy\\SDK::builder()\n ->setId('example')\n ->setServer('sandbox')\n ->setSecuritySource(Auth::withToken($privateKey))\n ->setMerchantAccountId('default')\n ->build();\n\n$checkoutSessionCreate = new Gr4vy\\CheckoutSessionCreate(\n cartItems: [\n new Gr4vy\\CartItem(\n name: 'GoPro HD',\n quantity: 2,\n unitAmount: 1299,\n discountAmount: 0,\n taxAmount: 0,\n externalIdentifier: 'goprohd',\n sku: 'GPHD1078',\n productUrl: 'https://example.com/catalog/go-pro-hd',\n imageUrl: 'https://example.com/images/go-pro-hd.jpg',\n categories: [\n 'camera',\n 'travel',\n 'gear',\n ],\n productType: 'physical',\n sellerCountry: 'US',\n ),\n new Gr4vy\\CartItem(\n name: 'GoPro HD',\n quantity: 2,\n unitAmount: 1299,\n discountAmount: 0,\n taxAmount: 0,\n externalIdentifier: 'goprohd',\n sku: 'GPHD1078',\n productUrl: 'https://example.com/catalog/go-pro-hd',\n imageUrl: 'https://example.com/images/go-pro-hd.jpg',\n categories: [\n 'camera',\n 'travel',\n 'gear',\n ],\n productType: 'physical',\n sellerCountry: 'US',\n ),\n ],\n metadata: [\n 'cohort' => 'cohort-a',\n 'order_id' => 'order-12345',\n ],\n buyer: new Gr4vy\\GuestBuyer(\n displayName: 'John Doe',\n externalIdentifier: 'buyer-12345',\n billingDetails: new Gr4vy\\BillingDetails(\n firstName: 'John',\n lastName: 'Doe',\n emailAddress: 'john@example.com',\n phoneNumber: '+1234567890',\n address: new Gr4vy\\Address(\n city: 'San Jose',\n country: 'US',\n postalCode: '94560',\n state: 'California',\n stateCode: 'US-CA',\n houseNumberOrName: '10',\n line1: 'Stafford Appartments',\n line2: '29th Street',\n organization: 'Gr4vy',\n ),\n taxId: new Gr4vy\\TaxId(\n value: '12345678931',\n kind: 'my.frp',\n ),\n ),\n shippingDetails: new Gr4vy\\ShippingDetailsCreate(\n firstName: 'John',\n lastName: 'Doe',\n emailAddress: 'john@example.com',\n phoneNumber: '+1234567890',\n address: null,\n ),\n ),\n airline: new Gr4vy\\Airline(\n bookingCode: 'X36Q9C',\n isCardholderTraveling: true,\n issuedAddress: '123 Broadway, New York',\n issuedAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n issuingCarrierCode: '649',\n issuingCarrierName: 'Air Transat A.T. Inc',\n issuingIataDesignator: 'TS',\n issuingIcaoCode: 'TSC',\n legs: [\n new Gr4vy\\AirlineLeg(\n arrivalAirport: 'LAX',\n arrivalAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n arrivalCity: 'Los Angeles',\n arrivalCountry: 'US',\n carrierCode: '649',\n carrierName: 'Air Transat A.T. Inc',\n iataDesignator: 'TS',\n icaoCode: 'TSC',\n couponNumber: '15885566',\n departureAirport: 'LHR',\n departureAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n departureCity: 'London',\n departureCountry: 'GB',\n departureTaxAmount: 1200,\n fareAmount: 129900,\n fareBasisCode: 'FY',\n feeAmount: 1200,\n flightClass: 'E',\n flightNumber: '101',\n routeType: 'round_trip',\n seatClass: 'F',\n stopOver: false,\n taxAmount: 1200,\n ),\n new Gr4vy\\AirlineLeg(\n arrivalAirport: 'LAX',\n arrivalAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n arrivalCity: 'Los Angeles',\n arrivalCountry: 'US',\n carrierCode: '649',\n carrierName: 'Air Transat A.T. Inc',\n iataDesignator: 'TS',\n icaoCode: 'TSC',\n couponNumber: '15885566',\n departureAirport: 'LHR',\n departureAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n departureCity: 'London',\n departureCountry: 'GB',\n departureTaxAmount: 1200,\n fareAmount: 129900,\n fareBasisCode: 'FY',\n feeAmount: 1200,\n flightClass: 'E',\n flightNumber: '101',\n routeType: 'round_trip',\n seatClass: 'F',\n stopOver: false,\n taxAmount: 1200,\n ),\n new Gr4vy\\AirlineLeg(\n arrivalAirport: 'LAX',\n arrivalAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n arrivalCity: 'Los Angeles',\n arrivalCountry: 'US',\n carrierCode: '649',\n carrierName: 'Air Transat A.T. Inc',\n iataDesignator: 'TS',\n icaoCode: 'TSC',\n couponNumber: '15885566',\n departureAirport: 'LHR',\n departureAt: Utils\\Utils::parseDateTime('2013-07-16T19:23:00.000+00:00'),\n departureCity: 'London',\n departureCountry: 'GB',\n departureTaxAmount: 1200,\n fareAmount: 129900,\n fareBasisCode: 'FY',\n feeAmount: 1200,\n flightClass: 'E',\n flightNumber: '101',\n routeType: 'round_trip',\n seatClass: 'F',\n stopOver: false,\n taxAmount: 1200,\n ),\n ],\n passengerNameRecord: 'JOHN L',\n passengers: [\n new Gr4vy\\AirlinePassenger(\n ageGroup: 'adult',\n dateOfBirth: LocalDate::parse('2013-07-16'),\n emailAddress: 'john@example.com',\n firstName: 'John',\n frequentFlyerNumber: '15885566',\n lastName: 'Luhn',\n passportNumber: '11117700225',\n phoneNumber: '+1234567890',\n ticketNumber: 'BA1236699999',\n title: 'Mr.',\n countryCode: 'US',\n ),\n new Gr4vy\\AirlinePassenger(\n ageGroup: 'adult',\n dateOfBirth: LocalDate::parse('2013-07-16'),\n emailAddress: 'john@example.com',\n firstName: 'John',\n frequentFlyerNumber: '15885566',\n lastName: 'Luhn',\n passportNumber: '11117700225',\n phoneNumber: '+1234567890',\n ticketNumber: 'BA1236699999',\n title: 'Mr.',\n countryCode: 'US',\n ),\n ],\n reservationSystem: 'Amadeus',\n restrictedTicket: false,\n ticketDeliveryMethod: 'electronic',\n ticketNumber: '123-1234-151555',\n travelAgencyCode: '12345',\n travelAgencyInvoiceNumber: 'EG15555155',\n travelAgencyName: 'ACME Agency',\n travelAgencyPlanName: 'B733',\n ),\n);\n\n$response = $sdk->checkoutSessions->create(\n checkoutSessionCreate: $checkoutSessionCreate\n);\n\nif ($response->checkoutSession !== null) {\n // handle response\n}"}],"requestExampleLanguages":["csharp","go","java","php","python","javascript","bash"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"2e941988-9b5b-4810-b7a0-2a8f5842072f":{"name":"x-gr4vy-merchant-account-id","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Gr4Vy-Merchant-Account-Id","description":"The ID of the merchant account to use for this request.","example":"default","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Gr4Vy-Merchant-Account-Id","description":"The ID of the merchant account to use for this request.","example":"default","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The ID of the merchant account to use for this request.","x-speakeasy-name-override":"merchantAccountId"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Body","properties":{"cart_items":{"oneOf":[{"type":"array","items":{"type":"object","title":"CartItem","required":["name","quantity","unit_amount"],"properties":{"name":{"type":"string","title":"Name","description":"The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.","maxLength":255,"minLength":1,"example":"GoPro HD","isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","title":"Quantity","description":"The quantity of this item in the cart. This value cannot be negative or zero.","maximum":99999999,"minimum":0,"example":2,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_amount":{"type":"integer","title":"Unit Amount","description":"The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.","maximum":99999999,"minimum":0,"example":1299,"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_amount","typeLabel":"integer"},"discount_amount":{"oneOf":[{"type":"integer","title":"Discount Amount","description":"The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"maximum":99999999,"minimum":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Discount Amount","description":"The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount","typeLabel":"integer | null"},"tax_amount":{"oneOf":[{"type":"integer","title":"Tax Amount","description":"The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"maximum":99999999,"minimum":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Tax Amount","description":"The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount","typeLabel":"integer | null"},"external_identifier":{"oneOf":[{"type":"string","title":"External Identifier","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","maxLength":200,"minLength":1,"example":"goprohd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","example":"goprohd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","title":"Sku","description":"The SKU or product code for the item.","maxLength":200,"minLength":1,"example":"GPHD1078","uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sku","description":"The SKU or product code for the item.","example":"GPHD1078","uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku","typeLabel":"string | null"},"upc":{"oneOf":[{"type":"string","title":"Upc","description":"The UPC for the item.","maxLength":50,"minLength":1,"example":"012345678905","uniqueKey":"cart_items.oneOf.0.items.[INDEX].upc.oneOf.0","typeLabel":"string"},{"type":"null","title":"Upc","description":"The UPC for the item.","example":"012345678905","uniqueKey":"cart_items.oneOf.0.items.[INDEX].upc.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].upc","typeLabel":"string | null"},"product_url":{"oneOf":[{"type":"string","title":"Product Url","description":"The product URL for the item.","example":"https://example.com/catalog/go-pro-hd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Product Url","description":"The product URL for the item.","example":"https://example.com/catalog/go-pro-hd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","title":"Image Url","description":"The URL for the image of the item.","example":"https://example.com/images/go-pro-hd.jpg","uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Image Url","description":"The URL for the image of the item.","example":"https://example.com/images/go-pro-hd.jpg","uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url","typeLabel":"string | null"},"categories":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":50,"minLength":1,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Categories","description":"A list of strings containing product categories for the item.","example":["camera","travel","gear"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Categories","description":"A list of strings containing product categories for the item.","example":["camera","travel","gear"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories","typeLabel":"string[] | null"},"subcategories":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":50,"minLength":1,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Subcategories","description":"A list of strings containing product subcategories for the item.","example":["action-cameras"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Subcategories","description":"A list of strings containing product subcategories for the item.","example":["action-cameras"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories","typeLabel":"string[] | null"},"brand":{"oneOf":[{"type":"string","title":"Brand","description":"The brand of the item.","maxLength":255,"minLength":1,"example":"GoPro","uniqueKey":"cart_items.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand","description":"The brand of the item.","example":"GoPro","uniqueKey":"cart_items.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","title":"ProductType","description":"The product type of the cart item.","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge"],"x-speakeasy-unknown-values":"allow","example":"physical","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The product type of the cart item.","example":"physical","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"seller_country":{"oneOf":[{"type":"string","title":"Seller Country","description":"The seller country of the cart item.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Seller Country","description":"The seller country of the cart item.","example":"US","uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country","typeLabel":"string | null"},"tax_exempt":{"oneOf":[{"type":"boolean","title":"Tax Exempt","description":"Whether the item is exempt of tax.","example":false,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_exempt.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Tax Exempt","description":"Whether the item is exempt of tax.","example":false,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_exempt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_exempt","typeLabel":"boolean | null"},"unit_of_measure":{"oneOf":[{"type":"string","title":"Unit Of Measure","description":"The unit of measure or the unit of measure code.","maxLength":50,"minLength":1,"example":"feet","uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","title":"Unit Of Measure","description":"The unit of measure or the unit of measure code.","example":"feet","uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_of_measure","typeLabel":"string | null"},"commodity_code":{"oneOf":[{"type":"string","title":"Commodity Code","description":"Item commodity code. Generally a UNSPSC code.","maxLength":50,"minLength":1,"example":"43211503","uniqueKey":"cart_items.oneOf.0.items.[INDEX].commodity_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Commodity Code","description":"Item commodity code. Generally a UNSPSC code.","example":"43211503","uniqueKey":"cart_items.oneOf.0.items.[INDEX].commodity_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].commodity_code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"Brief item description.","maxLength":255,"minLength":1,"example":"A brief description of an interesting item.","uniqueKey":"cart_items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Brief item description.","example":"A brief description of an interesting item.","uniqueKey":"cart_items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"duty_amount":{"oneOf":[{"type":"integer","title":"Duty Amount","description":"Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","maximum":99999999,"minimum":0,"example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].duty_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Duty Amount","description":"Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].duty_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].duty_amount","typeLabel":"integer | null"},"shipping_amount":{"oneOf":[{"type":"integer","title":"Shipping Amount","description":"Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","maximum":99999999,"minimum":0,"example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].shipping_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Shipping Amount","description":"Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].shipping_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].shipping_amount","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"cart_items.oneOf.0.items.[INDEX]","typeLabel":"CartItem · object"},"title":"Cart Items","description":"An array of cart items that represents the line items of a transaction.","uniqueKey":"cart_items.oneOf.0","typeLabel":"CartItem · object[]"},{"type":"null","title":"Cart Items","description":"An array of cart items that represents the line items of a transaction.","uniqueKey":"cart_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items","typeLabel":"CartItem · object[] | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.","example":{"cohort":"cohort-a","order_id":"order-12345"},"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.","example":{"cohort":"cohort-a","order_id":"order-12345"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"},"buyer":{"oneOf":[{"type":"object","title":"GuestBuyer","description":"Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.","properties":{"display_name":{"oneOf":[{"type":"string","title":"Display Name","description":"The display name for the buyer.","maxLength":200,"minLength":1,"example":"John Doe","uniqueKey":"buyer.oneOf.0.display_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Name","description":"The display name for the buyer.","example":"John Doe","uniqueKey":"buyer.oneOf.0.display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.display_name","typeLabel":"string | null"},"external_identifier":{"oneOf":[{"type":"string","title":"External Identifier","description":"The merchant identifier for this buyer.","maxLength":200,"minLength":1,"example":"buyer-12345","uniqueKey":"buyer.oneOf.0.external_identifier.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"The merchant identifier for this buyer.","example":"buyer-12345","uniqueKey":"buyer.oneOf.0.external_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.external_identifier","typeLabel":"string | null"},"billing_details":{"oneOf":[{"type":"object","title":"BillingDetails","description":"The billing name, address, email, and other fields for this buyer.","properties":{"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"The first name(s) or given name for the buyer.","maxLength":255,"minLength":1,"example":"John","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"The first name(s) or given name for the buyer.","example":"John","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"The last name, or family name, of the buyer.","maxLength":255,"minLength":1,"example":"Doe","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"The last name, or family name, of the buyer.","example":"Doe","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.last_name","typeLabel":"string | null"},"email_address":{"oneOf":[{"type":"string","title":"Email Address","description":"The email address for the buyer.","maxLength":320,"minLength":1,"example":"john@example.com","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.email_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email Address","description":"The email address for the buyer.","example":"john@example.com","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.email_address","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","pattern":"^\\+[1-9]\\d{1,14}$","example":"+1234567890","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","example":"+1234567890","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.phone_number","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","title":"Address","description":"The billing address for the buyer.","properties":{"city":{"oneOf":[{"type":"string","title":"City","description":"The city for the address.","maxLength":100,"minLength":1,"example":"San Jose","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"The city for the address.","example":"San Jose","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"The country for the address in ISO 3166 format.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"The country for the address in ISO 3166 format.","example":"US","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","description":"The postal code or zip code for the address.","maxLength":50,"minLength":1,"example":"94560","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","description":"The postal code or zip code for the address.","example":"94560","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"The state, county, or province for the address.","maxLength":255,"minLength":1,"example":"California","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"The state, county, or province for the address.","example":"California","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"state_code":{"oneOf":[{"type":"string","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","example":"US-CA","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","example":"US-CA","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state_code","typeLabel":"string | null"},"house_number_or_name":{"oneOf":[{"type":"string","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","maxLength":255,"minLength":1,"example":"10","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","example":"10","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.house_number_or_name","typeLabel":"string | null"},"line1":{"oneOf":[{"type":"string","title":"Line1","description":"The first line of the address.","maxLength":255,"minLength":1,"example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"The first line of the address.","example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"The second line of the address.","maxLength":255,"minLength":1,"example":"29th Street","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"The second line of the address.","example":"29th Street","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"organization":{"oneOf":[{"type":"string","title":"Organization","description":"The optional name of the company or organisation to add to the address.","maxLength":255,"minLength":1,"example":"Gr4vy","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.organization.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization","description":"The optional name of the company or organisation to add to the address.","example":"Gr4vy","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.organization","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0","typeLabel":"Address · object"},{"type":"null","description":"The billing address for the buyer.","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address","typeLabel":"Address · object | null"},"tax_id":{"oneOf":[{"type":"object","title":"TaxId","description":"The tax ID information associated with the billing details.","required":["value","kind"],"properties":{"value":{"type":"string","title":"Value","description":"The tax ID for the buyer.","maxLength":50,"minLength":1,"example":"12345678931","isRequired":true,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.0.value","typeLabel":"string"},"kind":{"type":"string","title":"TaxIdKind","description":"The kind of tax ID","enum":["ae.trn","au.abn","ar.dni","ar.cuil","ar.cuit","br.cnpj","br.cpf","ca.bn","ca.gst_hst","ca.pst_bc","ca.pst_mb","ca.pst_sk","ca.qst","ch.vat","cl.tin","co.itin","co.nit","co.cc","co.ce","co.de","co.rc","co.ti","co.passport","es.cif","eu.vat","gb.vat","hk.br","id.nik","id.npwp","in.gst","in.pan","jp.cn","jp.rn","kr.brn","li.uid","mx.curp","mx.rfc","my.frp","my.itn","my.nric","my.sst","no.vat","nz.gst","pe.ruc","ph.tin","ru.inn","ru.kpp","sa.vat","sg.gst","sg.uen","th.id","th.vat","tw.vat","us.ein","za.vat","bo.ci","uy.rut","uy.ci"],"x-speakeasy-unknown-values":"allow","example":"us.ein","isRequired":true,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.0","typeLabel":"TaxId · object"},{"type":"null","description":"The tax ID information associated with the billing details.","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id","typeLabel":"TaxId · object | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0","typeLabel":"BillingDetails · object"},{"type":"null","description":"The billing name, address, email, and other fields for this buyer.","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details","typeLabel":"BillingDetails · object | null"},"account_number":{"oneOf":[{"type":"string","title":"Account Number","description":"The buyer account number","maxLength":200,"minLength":1,"uniqueKey":"buyer.oneOf.0.account_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Number","description":"The buyer account number","uniqueKey":"buyer.oneOf.0.account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.account_number","typeLabel":"string | null"},"shipping_details":{"oneOf":[{"type":"object","title":"ShippingDetailsCreate","description":"The optional shipping details for this buyer.","properties":{"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"The first name(s) or given name for the buyer.","maxLength":255,"minLength":1,"example":"John","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"The first name(s) or given name for the buyer.","example":"John","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"The last name, or family name, of the buyer.","maxLength":255,"minLength":1,"example":"Doe","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"The last name, or family name, of the buyer.","example":"Doe","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.last_name","typeLabel":"string | null"},"email_address":{"oneOf":[{"type":"string","title":"Email Address","description":"The email address for the buyer.","maxLength":320,"minLength":1,"example":"john@example.com","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.email_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email Address","description":"The email address for the buyer.","example":"john@example.com","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.email_address","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","pattern":"^\\+[1-9]\\d{1,14}$","example":"+1234567890","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","example":"+1234567890","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.phone_number","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","title":"Address","description":"The billing address for the buyer.","properties":{"city":{"oneOf":[{"type":"string","title":"City","description":"The city for the address.","maxLength":100,"minLength":1,"example":"San Jose","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"The city for the address.","example":"San Jose","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"The country for the address in ISO 3166 format.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"The country for the address in ISO 3166 format.","example":"US","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","description":"The postal code or zip code for the address.","maxLength":50,"minLength":1,"example":"94560","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","description":"The postal code or zip code for the address.","example":"94560","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"The state, county, or province for the address.","maxLength":255,"minLength":1,"example":"California","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"The state, county, or province for the address.","example":"California","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"state_code":{"oneOf":[{"type":"string","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","example":"US-CA","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","example":"US-CA","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state_code","typeLabel":"string | null"},"house_number_or_name":{"oneOf":[{"type":"string","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","maxLength":255,"minLength":1,"example":"10","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","example":"10","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.house_number_or_name","typeLabel":"string | null"},"line1":{"oneOf":[{"type":"string","title":"Line1","description":"The first line of the address.","maxLength":255,"minLength":1,"example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"The first line of the address.","example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"The second line of the address.","maxLength":255,"minLength":1,"example":"29th Street","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"The second line of the address.","example":"29th Street","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"organization":{"oneOf":[{"type":"string","title":"Organization","description":"The optional name of the company or organisation to add to the address.","maxLength":255,"minLength":1,"example":"Gr4vy","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.organization.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization","description":"The optional name of the company or organisation to add to the address.","example":"Gr4vy","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.organization","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0","typeLabel":"Address · object"},{"type":"null","description":"The billing address for the buyer.","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address","typeLabel":"Address · object | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0","typeLabel":"ShippingDetailsCreate · object"},{"type":"null","description":"The optional shipping details for this buyer.","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details","typeLabel":"ShippingDetailsCreate · object | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0","typeLabel":"GuestBuyer · object"},{"type":"null","description":"Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.","uniqueKey":"buyer.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer","typeLabel":"GuestBuyer · object | null"},"airline":{"oneOf":[{"type":"object","title":"Airline","description":"The airline addendum data which describes the airline booking associated with this transaction.","properties":{"booking_code":{"oneOf":[{"type":"string","title":"Booking Code","description":"The unique identifier of the reservation in the global distribution system.","maxLength":50,"minLength":1,"example":"X36Q9C","uniqueKey":"airline.oneOf.0.booking_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Booking Code","description":"The unique identifier of the reservation in the global distribution system.","example":"X36Q9C","uniqueKey":"airline.oneOf.0.booking_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.booking_code","typeLabel":"string | null"},"is_cardholder_traveling":{"oneOf":[{"type":"boolean","title":"Is Cardholder Traveling","description":"Indicates whether the cardholder is traveling.","example":true,"uniqueKey":"airline.oneOf.0.is_cardholder_traveling.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Cardholder Traveling","description":"Indicates whether the cardholder is traveling.","example":true,"uniqueKey":"airline.oneOf.0.is_cardholder_traveling.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.is_cardholder_traveling","typeLabel":"boolean | null"},"issued_address":{"oneOf":[{"type":"string","title":"Issued Address","description":"The address of the place/agency that issued the ticket.","maxLength":255,"minLength":1,"example":"123 Broadway, New York","uniqueKey":"airline.oneOf.0.issued_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issued Address","description":"The address of the place/agency that issued the ticket.","example":"123 Broadway, New York","uniqueKey":"airline.oneOf.0.issued_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issued_address","typeLabel":"string | null"},"issued_at":{"oneOf":[{"type":"string","title":"Issued At","description":"The date that the ticket was last issued in the airline reservation system.","format":"date-time","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.issued_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Issued At","description":"The date that the ticket was last issued in the airline reservation system.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.issued_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issued_at","typeLabel":"string\u003cdate-time> | null"},"issuing_carrier_code":{"oneOf":[{"type":"string","title":"Issuing Carrier Code","description":"For airline aggregators, three-character IATA code of the airline issuing the ticket.","maxLength":3,"minLength":2,"example":"649","uniqueKey":"airline.oneOf.0.issuing_carrier_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Carrier Code","description":"For airline aggregators, three-character IATA code of the airline issuing the ticket.","example":"649","uniqueKey":"airline.oneOf.0.issuing_carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_carrier_code","typeLabel":"string | null"},"issuing_carrier_name":{"oneOf":[{"type":"string","title":"Issuing Carrier Name","description":"For airline aggregators, name of the airline issuing the ticket.","minLength":1,"example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.issuing_carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Carrier Name","description":"For airline aggregators, name of the airline issuing the ticket.","example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.issuing_carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_carrier_name","typeLabel":"string | null"},"issuing_iata_designator":{"oneOf":[{"type":"string","title":"Issuing Iata Designator","description":"For airline aggregators, two-character IATA code of the airline issuing the ticket.","maxLength":2,"minLength":2,"example":"TS","uniqueKey":"airline.oneOf.0.issuing_iata_designator.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Iata Designator","description":"For airline aggregators, two-character IATA code of the airline issuing the ticket.","example":"TS","uniqueKey":"airline.oneOf.0.issuing_iata_designator.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_iata_designator","typeLabel":"string | null"},"issuing_icao_code":{"oneOf":[{"type":"string","title":"Issuing Icao Code","description":"For airline aggregators, three-character ICAO code of the airline issuing the ticket.","maxLength":3,"minLength":3,"example":"TSC","uniqueKey":"airline.oneOf.0.issuing_icao_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Icao Code","description":"For airline aggregators, three-character ICAO code of the airline issuing the ticket.","example":"TSC","uniqueKey":"airline.oneOf.0.issuing_icao_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_icao_code","typeLabel":"string | null"},"legs":{"oneOf":[{"type":"array","items":{"type":"object","title":"AirlineLeg","properties":{"arrival_airport":{"oneOf":[{"type":"string","title":"Arrival Airport","description":"Arrival airport code of leg. 3-letter ISO code according to IATA official directory.","maxLength":3,"minLength":3,"example":"LAX","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arrival Airport","description":"Arrival airport code of leg. 3-letter ISO code according to IATA official directory.","example":"LAX","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport","typeLabel":"string | null"},"arrival_at":{"oneOf":[{"type":"string","title":"Arrival At","description":"The date and time of travel in local time at the arrival airport.","format":"date-time","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Arrival At","description":"The date and time of travel in local time at the arrival airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at","typeLabel":"string\u003cdate-time> | null"},"arrival_city":{"oneOf":[{"type":"string","title":"Arrival City","description":"Arrival city name.","maxLength":100,"minLength":1,"example":"Los Angeles","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arrival City","description":"Arrival city name.","example":"Los Angeles","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city","typeLabel":"string | null"},"arrival_country":{"oneOf":[{"type":"string","title":"Arrival Country","description":"Arrival country code in ISO 3166 format.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arrival Country","description":"Arrival country code in ISO 3166 format.","example":"US","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country","typeLabel":"string | null"},"carrier_code":{"oneOf":[{"type":"string","title":"Carrier Code","description":"3 character airline code as set by IATA.","maxLength":3,"minLength":2,"example":"649","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Carrier Code","description":"3 character airline code as set by IATA.","example":"649","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code","typeLabel":"string | null"},"carrier_name":{"oneOf":[{"type":"string","title":"Carrier Name","description":"Name of the airline.","minLength":1,"example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Carrier Name","description":"Name of the airline.","example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name","typeLabel":"string | null"},"iata_designator":{"oneOf":[{"type":"string","title":"Iata Designator","description":"Two-character IATA code of the airline.","maxLength":2,"minLength":2,"example":"TS","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator.oneOf.0","typeLabel":"string"},{"type":"null","title":"Iata Designator","description":"Two-character IATA code of the airline.","example":"TS","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator","typeLabel":"string | null"},"icao_code":{"oneOf":[{"type":"string","title":"Icao Code","description":"Three-character ICAO code of the airline.","maxLength":3,"minLength":3,"example":"TSC","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icao Code","description":"Three-character ICAO code of the airline.","example":"TSC","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code","typeLabel":"string | null"},"coupon_number":{"oneOf":[{"type":"string","title":"Coupon Number","description":"Coupon number associated with the leg.","maxLength":50,"minLength":1,"example":"15885566","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Coupon Number","description":"Coupon number associated with the leg.","example":"15885566","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number","typeLabel":"string | null"},"departure_airport":{"oneOf":[{"type":"string","title":"Departure Airport","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","maxLength":3,"minLength":3,"example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport.oneOf.0","typeLabel":"string"},{"type":"null","title":"Departure Airport","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport","typeLabel":"string | null"},"departure_at":{"oneOf":[{"type":"string","title":"Departure At","description":"The date and time of travel in local time at the departure airport.","format":"date-time","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Departure At","description":"The date and time of travel in local time at the departure airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at","typeLabel":"string\u003cdate-time> | null"},"departure_city":{"oneOf":[{"type":"string","title":"Departure City","description":"Departure city name.","maxLength":100,"minLength":1,"example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city.oneOf.0","typeLabel":"string"},{"type":"null","title":"Departure City","description":"Departure city name.","example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city","typeLabel":"string | null"},"departure_country":{"oneOf":[{"type":"string","title":"Departure Country","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","pattern":"^[A-Z]{2}$","example":"GB","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Departure Country","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","example":"GB","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country","typeLabel":"string | null"},"departure_tax_amount":{"oneOf":[{"type":"integer","title":"Departure Tax Amount","description":"Departure tax amount charged by a country when a person is leaving the country.","maximum":99999999,"minimum":0,"example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Departure Tax Amount","description":"Departure tax amount charged by a country when a person is leaving the country.","example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount","typeLabel":"integer | null"},"fare_amount":{"oneOf":[{"type":"integer","title":"Fare Amount","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","maximum":99999999,"minimum":0,"example":129900,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Fare Amount","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","example":129900,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount","typeLabel":"integer | null"},"fare_basis_code":{"oneOf":[{"type":"string","title":"Fare Basis Code","description":"The alphanumeric code for the booking class of a ticket.","maxLength":8,"minLength":1,"example":"FY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Fare Basis Code","description":"The alphanumeric code for the booking class of a ticket.","example":"FY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code","typeLabel":"string | null"},"fee_amount":{"oneOf":[{"type":"integer","title":"Fee Amount","description":"Fee amount for current leg of the trip.","maximum":99999999,"minimum":0,"example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Fee Amount","description":"Fee amount for current leg of the trip.","example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount","typeLabel":"integer | null"},"flight_class":{"oneOf":[{"type":"string","title":"Flight Class","description":"Indicates service class (first class, business class, etc.).","maxLength":5,"minLength":1,"example":"E","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class.oneOf.0","typeLabel":"string"},{"type":"null","title":"Flight Class","description":"Indicates service class (first class, business class, etc.).","example":"E","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class","typeLabel":"string | null"},"flight_number":{"oneOf":[{"type":"string","title":"Flight Number","description":"Unique identifier of the flight number.","maxLength":6,"minLength":3,"example":"101","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Flight Number","description":"Unique identifier of the flight number.","example":"101","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number","typeLabel":"string | null"},"route_type":{"oneOf":[{"type":"string","title":"Route Type","description":"The route type of the flight.","enum":["round_trip","one_way"],"x-speakeasy-unknown-values":"allow","example":"round_trip","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Route Type","description":"The route type of the flight.","example":"round_trip","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type","typeLabel":"enum\u003cstring> | null"},"seat_class":{"oneOf":[{"type":"string","title":"Seat Class","description":"Indicates seat class (first class, business class, etc.).","maxLength":5,"minLength":1,"example":"F","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class.oneOf.0","typeLabel":"string"},{"type":"null","title":"Seat Class","description":"Indicates seat class (first class, business class, etc.).","example":"F","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class","typeLabel":"string | null"},"stop_over":{"oneOf":[{"type":"boolean","title":"Stop Over","description":"Indicates whether a stopover is allowed on this ticket.","example":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Stop Over","description":"Indicates whether a stopover is allowed on this ticket.","example":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over","typeLabel":"boolean | null"},"tax_amount":{"oneOf":[{"type":"integer","title":"Tax Amount","description":"Amount of the taxes for current leg of the trip.","maximum":99999999,"minimum":0,"example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Tax Amount","description":"Amount of the taxes for current leg of the trip.","example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX]","typeLabel":"AirlineLeg · object"},"title":"Legs","description":"An array of separate trip segments. Each leg contains detailed itinerary information.","maxItems":20,"uniqueKey":"airline.oneOf.0.legs.oneOf.0","typeLabel":"AirlineLeg · object[]"},{"type":"null","title":"Legs","description":"An array of separate trip segments. Each leg contains detailed itinerary information.","uniqueKey":"airline.oneOf.0.legs.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs","typeLabel":"AirlineLeg · object[] | null"},"passenger_name_record":{"oneOf":[{"type":"string","title":"Passenger Name Record","description":"The Passenger Name Record (PNR) in the airline reservation system.","maxLength":50,"minLength":1,"example":"JOHN L","uniqueKey":"airline.oneOf.0.passenger_name_record.oneOf.0","typeLabel":"string"},{"type":"null","title":"Passenger Name Record","description":"The Passenger Name Record (PNR) in the airline reservation system.","example":"JOHN L","uniqueKey":"airline.oneOf.0.passenger_name_record.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passenger_name_record","typeLabel":"string | null"},"passengers":{"oneOf":[{"type":"array","items":{"type":"object","title":"AirlinePassenger","properties":{"age_group":{"oneOf":[{"type":"string","title":"Age Group","description":"The age group for the passenger.","enum":["adult","infant"],"x-speakeasy-unknown-values":"allow","example":"adult","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Age Group","description":"The age group for the passenger.","example":"adult","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group","typeLabel":"enum\u003cstring> | null"},"date_of_birth":{"oneOf":[{"type":"string","title":"Date Of Birth","description":"The passenger's date of birth in YYYY-MM-YY format.","format":"date","example":"2013-07-16","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Date Of Birth","description":"The passenger's date of birth in YYYY-MM-YY format.","example":"2013-07-16","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth","typeLabel":"string\u003cdate> | null"},"email_address":{"oneOf":[{"type":"string","title":"Email Address","description":"The email address of the passenger.","maxLength":320,"minLength":1,"example":"john@example.com","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email Address","description":"The email address of the passenger.","example":"john@example.com","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"The first name(s) or given name of the passenger.","maxLength":255,"minLength":1,"example":"John","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"The first name(s) or given name of the passenger.","example":"John","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name","typeLabel":"string | null"},"frequent_flyer_number":{"oneOf":[{"type":"string","title":"Frequent Flyer Number","description":"The passenger's frequent flyer number.","maxLength":50,"minLength":5,"example":"15885566","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Frequent Flyer Number","description":"The passenger's frequent flyer number.","example":"15885566","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"The last name, or family name, of the passenger.","maxLength":255,"minLength":1,"example":"Luhn","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"The last name, or family name, of the passenger.","example":"Luhn","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name","typeLabel":"string | null"},"passport_number":{"oneOf":[{"type":"string","title":"Passport Number","description":"The passenger's unique passport number.","maxLength":50,"minLength":1,"example":"11117700225","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Passport Number","description":"The passenger's unique passport number.","example":"11117700225","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"The phone number of the passenger. This number is formatted according to the E164 number standard.","pattern":"^\\+[1-9]\\d{1,14}$","example":"+1234567890","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"The phone number of the passenger. This number is formatted according to the E164 number standard.","example":"+1234567890","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number","typeLabel":"string | null"},"ticket_number":{"oneOf":[{"type":"string","title":"Ticket Number","description":"The ticket number for a flight.","maxLength":50,"minLength":1,"example":"BA1236699999","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ticket Number","description":"The ticket number for a flight.","example":"BA1236699999","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title of the passenger.","maxLength":50,"minLength":1,"example":"Mr.","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title of the passenger.","example":"Mr.","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","title":"Country Code","description":"The country of residence of the passenger","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country Code","description":"The country of residence of the passenger","example":"US","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].country_code","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX]","typeLabel":"AirlinePassenger · object"},"title":"Passengers","description":"An array of the travelling passengers.","maxItems":20,"uniqueKey":"airline.oneOf.0.passengers.oneOf.0","typeLabel":"AirlinePassenger · object[]"},{"type":"null","title":"Passengers","description":"An array of the travelling passengers.","uniqueKey":"airline.oneOf.0.passengers.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers","typeLabel":"AirlinePassenger · object[] | null"},"reservation_system":{"oneOf":[{"type":"string","title":"Reservation System","description":"The name of the reservation system.","maxLength":200,"minLength":1,"example":"Amadeus","uniqueKey":"airline.oneOf.0.reservation_system.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reservation System","description":"The name of the reservation system.","example":"Amadeus","uniqueKey":"airline.oneOf.0.reservation_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.reservation_system","typeLabel":"string | null"},"restricted_ticket":{"oneOf":[{"type":"boolean","title":"Restricted Ticket","description":"Indicates whether the ticket is restricted (refundable).","example":false,"uniqueKey":"airline.oneOf.0.restricted_ticket.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Restricted Ticket","description":"Indicates whether the ticket is restricted (refundable).","example":false,"uniqueKey":"airline.oneOf.0.restricted_ticket.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.restricted_ticket","typeLabel":"boolean | null"},"ticket_delivery_method":{"oneOf":[{"type":"string","title":"Ticket Delivery Method","description":"The delivery method of the ticket.","default":"electronic","enum":["electronic","other"],"x-speakeasy-unknown-values":"allow","example":"electronic","uniqueKey":"airline.oneOf.0.ticket_delivery_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Ticket Delivery Method","description":"The delivery method of the ticket.","default":"electronic","example":"electronic","uniqueKey":"airline.oneOf.0.ticket_delivery_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.ticket_delivery_method","typeLabel":"enum\u003cstring> | null"},"ticket_number":{"oneOf":[{"type":"string","title":"Ticket Number","description":"The airline's unique ticket number.","maxLength":50,"minLength":1,"example":"123-1234-151555","uniqueKey":"airline.oneOf.0.ticket_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ticket Number","description":"The airline's unique ticket number.","example":"123-1234-151555","uniqueKey":"airline.oneOf.0.ticket_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.ticket_number","typeLabel":"string | null"},"travel_agency_code":{"oneOf":[{"type":"string","title":"Travel Agency Code","description":"The IATA travel agency code.","maxLength":50,"minLength":1,"example":"12345","uniqueKey":"airline.oneOf.0.travel_agency_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Code","description":"The IATA travel agency code.","example":"12345","uniqueKey":"airline.oneOf.0.travel_agency_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_code","typeLabel":"string | null"},"travel_agency_invoice_number":{"oneOf":[{"type":"string","title":"Travel Agency Invoice Number","description":"The reference number of the invoice that was issued by the travel agency.","maxLength":50,"minLength":1,"example":"EG15555155","uniqueKey":"airline.oneOf.0.travel_agency_invoice_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Invoice Number","description":"The reference number of the invoice that was issued by the travel agency.","example":"EG15555155","uniqueKey":"airline.oneOf.0.travel_agency_invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_invoice_number","typeLabel":"string | null"},"travel_agency_name":{"oneOf":[{"type":"string","title":"Travel Agency Name","description":"The name of the travel agency.","maxLength":200,"minLength":1,"example":"ACME Agency","uniqueKey":"airline.oneOf.0.travel_agency_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Name","description":"The name of the travel agency.","example":"ACME Agency","uniqueKey":"airline.oneOf.0.travel_agency_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_name","typeLabel":"string | null"},"travel_agency_plan_name":{"oneOf":[{"type":"string","title":"Travel Agency Plan Name","description":"The name of the travel agency plan.","maxLength":200,"minLength":1,"example":"B733","uniqueKey":"airline.oneOf.0.travel_agency_plan_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Plan Name","description":"The name of the travel agency plan.","example":"B733","uniqueKey":"airline.oneOf.0.travel_agency_plan_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_plan_name","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"airline.oneOf.0","typeLabel":"Airline · object"},{"type":"null","description":"The airline addendum data which describes the airline booking associated with this transaction.","uniqueKey":"airline.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline","typeLabel":"Airline · object | null"},"expires_in":{"type":"number","title":"Expires In","description":"The time in seconds when this checkout session expires.","default":3600,"maximum":86400,"minimum":3600,"uniqueKey":"expires_in","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"Body · object"},"examples":{"Example":{"title":"Example","value":{"cart_items":[{"name":"GoPro HD","quantity":2,"unit_amount":1299,"discount_amount":0,"tax_amount":0,"external_identifier":"goprohd","sku":"GPHD1078","upc":"012345678905","product_url":"https://example.com/catalog/go-pro-hd","image_url":"https://example.com/images/go-pro-hd.jpg","categories":["camera","travel","gear"],"subcategories":["action-cameras"],"brand":"GoPro","product_type":"physical","seller_country":"US","tax_exempt":false,"unit_of_measure":"feet","commodity_code":"43211503","description":"A brief description of an interesting item.","duty_amount":1299,"shipping_amount":1299}],"metadata":{"cohort":"cohort-a","order_id":"order-12345"},"buyer":{"display_name":"John Doe","external_identifier":"buyer-12345","billing_details":{"first_name":"John","last_name":"Doe","email_address":"john@example.com","phone_number":"+1234567890","address":{"city":"San Jose","country":"US","postal_code":"94560","state":"California","state_code":"US-CA","house_number_or_name":"10","line1":"Stafford Appartments","line2":"29th Street","organization":"Gr4vy"},"tax_id":{"value":"12345678931","kind":"us.ein"}},"account_number":"\u003cstring>","shipping_details":{"first_name":"John","last_name":"Doe","email_address":"john@example.com","phone_number":"+1234567890","address":{"city":"San Jose","country":"US","postal_code":"94560","state":"California","state_code":"US-CA","house_number_or_name":"10","line1":"Stafford Appartments","line2":"29th Street","organization":"Gr4vy"}}},"airline":{"booking_code":"X36Q9C","is_cardholder_traveling":true,"issued_address":"123 Broadway, New York","issued_at":"2013-07-16T19:23:00.000+00:00","issuing_carrier_code":"649","issuing_carrier_name":"Air Transat A.T. Inc","issuing_iata_designator":"TS","issuing_icao_code":"TSC","legs":[{"arrival_airport":"LAX","arrival_at":"2013-07-16T19:23:00.000+00:00","arrival_city":"Los Angeles","arrival_country":"US","carrier_code":"649","carrier_name":"Air Transat A.T. Inc","iata_designator":"TS","icao_code":"TSC","coupon_number":"15885566","departure_airport":"LHR","departure_at":"2013-07-16T19:23:00.000+00:00","departure_city":"London","departure_country":"GB","departure_tax_amount":1200,"fare_amount":129900,"fare_basis_code":"FY","fee_amount":1200,"flight_class":"E","flight_number":"101","route_type":"round_trip","seat_class":"F","stop_over":false,"tax_amount":1200}],"passenger_name_record":"JOHN L","passengers":[{"age_group":"adult","date_of_birth":"2013-07-16","email_address":"john@example.com","first_name":"John","frequent_flyer_number":"15885566","last_name":"Luhn","passport_number":"11117700225","phone_number":"+1234567890","ticket_number":"BA1236699999","title":"Mr.","country_code":"US"}],"reservation_system":"Amadeus","restricted_ticket":false,"ticket_delivery_method":"electronic","ticket_number":"123-1234-151555","travel_agency_code":"12345","travel_agency_invoice_number":"EG15555155","travel_agency_name":"ACME Agency","travel_agency_plan_name":"B733"},"expires_in":3600}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d2f75d6e-8f8e-4686-a1ed-61b8cdb47c72":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The ID for the checkout session.","examples":["4137b1cf-39ac-42a8-bad6-1c680d5dab6b"],"isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"The date and time when this checkout session expires.","examples":["2013-07-16T19:23:00.000+00:00"],"isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"cart_items":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.","examples":["GoPro HD"],"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","maximum":99999999,"exclusiveMinimum":0,"title":"Quantity","description":"The quantity of this item in the cart. This value cannot be negative or zero.","examples":[2],"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].quantity","typeLabel":"integer"},"unit_amount":{"type":"integer","maximum":99999999,"minimum":0,"title":"Unit Amount","description":"The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.","examples":[1299],"isRequired":true,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_amount","typeLabel":"integer"},"discount_amount":{"oneOf":[{"type":"integer","title":"Discount Amount","description":"The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"maximum":99999999,"minimum":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Discount Amount","description":"The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].discount_amount","typeLabel":"integer | null"},"tax_amount":{"oneOf":[{"type":"integer","title":"Tax Amount","description":"The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"maximum":99999999,"minimum":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Tax Amount","description":"The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`.","default":0,"example":0,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_amount","typeLabel":"integer | null"},"external_identifier":{"oneOf":[{"type":"string","title":"External Identifier","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","maxLength":200,"minLength":1,"example":"goprohd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"An external identifier for the cart item. This can be set to any value and is not sent to the payment service.","example":"goprohd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].external_identifier","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","title":"Sku","description":"The SKU or product code for the item.","maxLength":200,"minLength":1,"example":"GPHD1078","uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sku","description":"The SKU or product code for the item.","example":"GPHD1078","uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].sku","typeLabel":"string | null"},"upc":{"oneOf":[{"type":"string","title":"Upc","description":"The UPC for the item.","maxLength":50,"minLength":1,"example":"012345678905","uniqueKey":"cart_items.oneOf.0.items.[INDEX].upc.oneOf.0","typeLabel":"string"},{"type":"null","title":"Upc","description":"The UPC for the item.","example":"012345678905","uniqueKey":"cart_items.oneOf.0.items.[INDEX].upc.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].upc","typeLabel":"string | null"},"product_url":{"oneOf":[{"type":"string","title":"Product Url","description":"The product URL for the item.","example":"https://example.com/catalog/go-pro-hd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Product Url","description":"The product URL for the item.","example":"https://example.com/catalog/go-pro-hd","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_url","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","title":"Image Url","description":"The URL for the image of the item.","example":"https://example.com/images/go-pro-hd.jpg","uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Image Url","description":"The URL for the image of the item.","example":"https://example.com/images/go-pro-hd.jpg","uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].image_url","typeLabel":"string | null"},"categories":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":50,"minLength":1,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Categories","description":"A list of strings containing product categories for the item.","example":["camera","travel","gear"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Categories","description":"A list of strings containing product categories for the item.","example":["camera","travel","gear"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].categories","typeLabel":"string[] | null"},"subcategories":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":50,"minLength":1,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Subcategories","description":"A list of strings containing product subcategories for the item.","example":["action-cameras"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Subcategories","description":"A list of strings containing product subcategories for the item.","example":["action-cameras"],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].subcategories","typeLabel":"string[] | null"},"brand":{"oneOf":[{"type":"string","title":"Brand","description":"The brand of the item.","maxLength":255,"minLength":1,"example":"GoPro","uniqueKey":"cart_items.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand","description":"The brand of the item.","example":"GoPro","uniqueKey":"cart_items.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","title":"ProductType","description":"The product type of the cart item.","enum":["physical","discount","shipping_fee","sales_tax","digital","gift_card","store_credit","surcharge"],"x-speakeasy-unknown-values":"allow","example":"physical","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The product type of the cart item.","example":"physical","uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"seller_country":{"oneOf":[{"type":"string","title":"Seller Country","description":"The seller country of the cart item.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Seller Country","description":"The seller country of the cart item.","example":"US","uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].seller_country","typeLabel":"string | null"},"tax_exempt":{"oneOf":[{"type":"boolean","title":"Tax Exempt","description":"Whether the item is exempt of tax.","example":false,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_exempt.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Tax Exempt","description":"Whether the item is exempt of tax.","example":false,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_exempt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].tax_exempt","typeLabel":"boolean | null"},"unit_of_measure":{"oneOf":[{"type":"string","title":"Unit Of Measure","description":"The unit of measure or the unit of measure code.","maxLength":50,"minLength":1,"example":"feet","uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","title":"Unit Of Measure","description":"The unit of measure or the unit of measure code.","example":"feet","uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].unit_of_measure","typeLabel":"string | null"},"commodity_code":{"oneOf":[{"type":"string","title":"Commodity Code","description":"Item commodity code. Generally a UNSPSC code.","maxLength":50,"minLength":1,"example":"43211503","uniqueKey":"cart_items.oneOf.0.items.[INDEX].commodity_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Commodity Code","description":"Item commodity code. Generally a UNSPSC code.","example":"43211503","uniqueKey":"cart_items.oneOf.0.items.[INDEX].commodity_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].commodity_code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","description":"Brief item description.","maxLength":255,"minLength":1,"example":"A brief description of an interesting item.","uniqueKey":"cart_items.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Brief item description.","example":"A brief description of an interesting item.","uniqueKey":"cart_items.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"duty_amount":{"oneOf":[{"type":"integer","title":"Duty Amount","description":"Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","maximum":99999999,"minimum":0,"example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].duty_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Duty Amount","description":"Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].duty_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].duty_amount","typeLabel":"integer | null"},"shipping_amount":{"oneOf":[{"type":"integer","title":"Shipping Amount","description":"Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","maximum":99999999,"minimum":0,"example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].shipping_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Shipping Amount","description":"Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`","example":1299,"uniqueKey":"cart_items.oneOf.0.items.[INDEX].shipping_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items.oneOf.0.items.[INDEX].shipping_amount","typeLabel":"integer | null"}},"additionalProperties":false,"type":"object","required":["name","quantity","unit_amount"],"title":"CartItem","uniqueKey":"cart_items.oneOf.0.items.[INDEX]","typeLabel":"CartItem · object"},"title":"Cart Items","description":"An array of cart items that represents the line items of a transaction.","uniqueKey":"cart_items.oneOf.0","typeLabel":"CartItem · object[]"},{"type":"null","title":"Cart Items","description":"An array of cart items that represents the line items of a transaction.","uniqueKey":"cart_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"cart_items","typeLabel":"CartItem · object[] | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.","example":{"cohort":"cohort-a","order_id":"order-12345"},"additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.","example":{"cohort":"cohort-a","order_id":"order-12345"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"},"buyer":{"oneOf":[{"type":"object","title":"GuestBuyer","description":"Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.","properties":{"display_name":{"oneOf":[{"type":"string","title":"Display Name","description":"The display name for the buyer.","maxLength":200,"minLength":1,"example":"John Doe","uniqueKey":"buyer.oneOf.0.display_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Name","description":"The display name for the buyer.","example":"John Doe","uniqueKey":"buyer.oneOf.0.display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.display_name","typeLabel":"string | null"},"external_identifier":{"oneOf":[{"type":"string","title":"External Identifier","description":"The merchant identifier for this buyer.","maxLength":200,"minLength":1,"example":"buyer-12345","uniqueKey":"buyer.oneOf.0.external_identifier.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Identifier","description":"The merchant identifier for this buyer.","example":"buyer-12345","uniqueKey":"buyer.oneOf.0.external_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.external_identifier","typeLabel":"string | null"},"billing_details":{"oneOf":[{"type":"object","title":"BillingDetails","description":"The billing name, address, email, and other fields for this buyer.","properties":{"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"The first name(s) or given name for the buyer.","maxLength":255,"minLength":1,"example":"John","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"The first name(s) or given name for the buyer.","example":"John","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"The last name, or family name, of the buyer.","maxLength":255,"minLength":1,"example":"Doe","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"The last name, or family name, of the buyer.","example":"Doe","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.last_name","typeLabel":"string | null"},"email_address":{"oneOf":[{"type":"string","title":"Email Address","description":"The email address for the buyer.","maxLength":320,"minLength":1,"example":"john@example.com","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.email_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email Address","description":"The email address for the buyer.","example":"john@example.com","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.email_address","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","pattern":"^\\+[1-9]\\d{1,14}$","example":"+1234567890","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","example":"+1234567890","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.phone_number","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","title":"Address","description":"The billing address for the buyer.","properties":{"city":{"oneOf":[{"type":"string","title":"City","description":"The city for the address.","maxLength":100,"minLength":1,"example":"San Jose","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"The city for the address.","example":"San Jose","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"The country for the address in ISO 3166 format.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"The country for the address in ISO 3166 format.","example":"US","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","description":"The postal code or zip code for the address.","maxLength":50,"minLength":1,"example":"94560","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","description":"The postal code or zip code for the address.","example":"94560","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"The state, county, or province for the address.","maxLength":255,"minLength":1,"example":"California","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"The state, county, or province for the address.","example":"California","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"state_code":{"oneOf":[{"type":"string","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","example":"US-CA","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","example":"US-CA","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.state_code","typeLabel":"string | null"},"house_number_or_name":{"oneOf":[{"type":"string","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","maxLength":255,"minLength":1,"example":"10","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","example":"10","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.house_number_or_name","typeLabel":"string | null"},"line1":{"oneOf":[{"type":"string","title":"Line1","description":"The first line of the address.","maxLength":255,"minLength":1,"example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"The first line of the address.","example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"The second line of the address.","maxLength":255,"minLength":1,"example":"29th Street","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"The second line of the address.","example":"29th Street","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"organization":{"oneOf":[{"type":"string","title":"Organization","description":"The optional name of the company or organisation to add to the address.","maxLength":255,"minLength":1,"example":"Gr4vy","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.organization.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization","description":"The optional name of the company or organisation to add to the address.","example":"Gr4vy","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0.organization","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.0","typeLabel":"Address · object"},{"type":"null","description":"The billing address for the buyer.","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.address","typeLabel":"Address · object | null"},"tax_id":{"oneOf":[{"type":"object","title":"TaxId","description":"The tax ID information associated with the billing details.","required":["value","kind"],"properties":{"value":{"type":"string","maxLength":50,"minLength":1,"title":"Value","description":"The tax ID for the buyer.","examples":["12345678931"],"isRequired":true,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.0.value","typeLabel":"string"},"kind":{"description":"The kind of tax ID","examples":["us.ein"],"type":"string","enum":["ae.trn","au.abn","ar.dni","ar.cuil","ar.cuit","br.cnpj","br.cpf","ca.bn","ca.gst_hst","ca.pst_bc","ca.pst_mb","ca.pst_sk","ca.qst","ch.vat","cl.tin","co.itin","co.nit","co.cc","co.ce","co.de","co.rc","co.ti","co.passport","es.cif","eu.vat","gb.vat","hk.br","id.nik","id.npwp","in.gst","in.pan","jp.cn","jp.rn","kr.brn","li.uid","mx.curp","mx.rfc","my.frp","my.itn","my.nric","my.sst","no.vat","nz.gst","pe.ruc","ph.tin","ru.inn","ru.kpp","sa.vat","sg.gst","sg.uen","th.id","th.vat","tw.vat","us.ein","za.vat","bo.ci","uy.rut","uy.ci"],"title":"TaxIdKind","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.0","typeLabel":"TaxId · object"},{"type":"null","description":"The tax ID information associated with the billing details.","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0.tax_id","typeLabel":"TaxId · object | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.billing_details.oneOf.0","typeLabel":"BillingDetails · object"},{"type":"null","description":"The billing name, address, email, and other fields for this buyer.","uniqueKey":"buyer.oneOf.0.billing_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.billing_details","typeLabel":"BillingDetails · object | null"},"account_number":{"oneOf":[{"type":"string","title":"Account Number","description":"The buyer account number","maxLength":200,"minLength":1,"uniqueKey":"buyer.oneOf.0.account_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Number","description":"The buyer account number","uniqueKey":"buyer.oneOf.0.account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.account_number","typeLabel":"string | null"},"shipping_details":{"oneOf":[{"type":"object","title":"ShippingDetailsCreate","description":"The optional shipping details for this buyer.","properties":{"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"The first name(s) or given name for the buyer.","maxLength":255,"minLength":1,"example":"John","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"The first name(s) or given name for the buyer.","example":"John","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"The last name, or family name, of the buyer.","maxLength":255,"minLength":1,"example":"Doe","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"The last name, or family name, of the buyer.","example":"Doe","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.last_name","typeLabel":"string | null"},"email_address":{"oneOf":[{"type":"string","title":"Email Address","description":"The email address for the buyer.","maxLength":320,"minLength":1,"example":"john@example.com","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.email_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email Address","description":"The email address for the buyer.","example":"john@example.com","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.email_address","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","pattern":"^\\+[1-9]\\d{1,14}$","example":"+1234567890","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"The phone number for the buyer which should be formatted according to the E164 number standard.","example":"+1234567890","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.phone_number","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","title":"Address","description":"The billing address for the buyer.","properties":{"city":{"oneOf":[{"type":"string","title":"City","description":"The city for the address.","maxLength":100,"minLength":1,"example":"San Jose","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"The city for the address.","example":"San Jose","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"The country for the address in ISO 3166 format.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"The country for the address in ISO 3166 format.","example":"US","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","description":"The postal code or zip code for the address.","maxLength":50,"minLength":1,"example":"94560","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","description":"The postal code or zip code for the address.","example":"94560","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.postal_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"The state, county, or province for the address.","maxLength":255,"minLength":1,"example":"California","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"The state, county, or province for the address.","example":"California","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"state_code":{"oneOf":[{"type":"string","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$","example":"US-CA","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"State Code","description":"The code of state, county, or province for the address in ISO 3166-2 format.","example":"US-CA","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.state_code","typeLabel":"string | null"},"house_number_or_name":{"oneOf":[{"type":"string","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","maxLength":255,"minLength":1,"example":"10","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"House Number Or Name","description":"The house number or name for the address. Not all payment services use this field but some do.","example":"10","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.house_number_or_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.house_number_or_name","typeLabel":"string | null"},"line1":{"oneOf":[{"type":"string","title":"Line1","description":"The first line of the address.","maxLength":255,"minLength":1,"example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","description":"The first line of the address.","example":"Stafford Appartments","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","description":"The second line of the address.","maxLength":255,"minLength":1,"example":"29th Street","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","description":"The second line of the address.","example":"29th Street","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"organization":{"oneOf":[{"type":"string","title":"Organization","description":"The optional name of the company or organisation to add to the address.","maxLength":255,"minLength":1,"example":"Gr4vy","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.organization.oneOf.0","typeLabel":"string"},{"type":"null","title":"Organization","description":"The optional name of the company or organisation to add to the address.","example":"Gr4vy","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0.organization","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.0","typeLabel":"Address · object"},{"type":"null","description":"The billing address for the buyer.","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0.address","typeLabel":"Address · object | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.0","typeLabel":"ShippingDetailsCreate · object"},{"type":"null","description":"The optional shipping details for this buyer.","uniqueKey":"buyer.oneOf.0.shipping_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer.oneOf.0.shipping_details","typeLabel":"ShippingDetailsCreate · object | null"}},"additionalProperties":false,"uniqueKey":"buyer.oneOf.0","typeLabel":"GuestBuyer · object"},{"type":"null","description":"Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.","uniqueKey":"buyer.oneOf.1","typeLabel":"null"}],"uniqueKey":"buyer","typeLabel":"GuestBuyer · object | null"},"airline":{"oneOf":[{"type":"object","title":"Airline","description":"The airline addendum data which describes the airline booking associated with this transaction.","properties":{"booking_code":{"oneOf":[{"type":"string","title":"Booking Code","description":"The unique identifier of the reservation in the global distribution system.","maxLength":50,"minLength":1,"example":"X36Q9C","uniqueKey":"airline.oneOf.0.booking_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Booking Code","description":"The unique identifier of the reservation in the global distribution system.","example":"X36Q9C","uniqueKey":"airline.oneOf.0.booking_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.booking_code","typeLabel":"string | null"},"is_cardholder_traveling":{"oneOf":[{"type":"boolean","title":"Is Cardholder Traveling","description":"Indicates whether the cardholder is traveling.","example":true,"uniqueKey":"airline.oneOf.0.is_cardholder_traveling.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Cardholder Traveling","description":"Indicates whether the cardholder is traveling.","example":true,"uniqueKey":"airline.oneOf.0.is_cardholder_traveling.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.is_cardholder_traveling","typeLabel":"boolean | null"},"issued_address":{"oneOf":[{"type":"string","title":"Issued Address","description":"The address of the place/agency that issued the ticket.","maxLength":255,"minLength":1,"example":"123 Broadway, New York","uniqueKey":"airline.oneOf.0.issued_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issued Address","description":"The address of the place/agency that issued the ticket.","example":"123 Broadway, New York","uniqueKey":"airline.oneOf.0.issued_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issued_address","typeLabel":"string | null"},"issued_at":{"oneOf":[{"type":"string","title":"Issued At","description":"The date that the ticket was last issued in the airline reservation system.","format":"date-time","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.issued_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Issued At","description":"The date that the ticket was last issued in the airline reservation system.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.issued_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issued_at","typeLabel":"string\u003cdate-time> | null"},"issuing_carrier_code":{"oneOf":[{"type":"string","title":"Issuing Carrier Code","description":"For airline aggregators, three-character IATA code of the airline issuing the ticket.","maxLength":3,"minLength":2,"example":"649","uniqueKey":"airline.oneOf.0.issuing_carrier_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Carrier Code","description":"For airline aggregators, three-character IATA code of the airline issuing the ticket.","example":"649","uniqueKey":"airline.oneOf.0.issuing_carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_carrier_code","typeLabel":"string | null"},"issuing_carrier_name":{"oneOf":[{"type":"string","title":"Issuing Carrier Name","description":"For airline aggregators, name of the airline issuing the ticket.","minLength":1,"example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.issuing_carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Carrier Name","description":"For airline aggregators, name of the airline issuing the ticket.","example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.issuing_carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_carrier_name","typeLabel":"string | null"},"issuing_iata_designator":{"oneOf":[{"type":"string","title":"Issuing Iata Designator","description":"For airline aggregators, two-character IATA code of the airline issuing the ticket.","maxLength":2,"minLength":2,"example":"TS","uniqueKey":"airline.oneOf.0.issuing_iata_designator.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Iata Designator","description":"For airline aggregators, two-character IATA code of the airline issuing the ticket.","example":"TS","uniqueKey":"airline.oneOf.0.issuing_iata_designator.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_iata_designator","typeLabel":"string | null"},"issuing_icao_code":{"oneOf":[{"type":"string","title":"Issuing Icao Code","description":"For airline aggregators, three-character ICAO code of the airline issuing the ticket.","maxLength":3,"minLength":3,"example":"TSC","uniqueKey":"airline.oneOf.0.issuing_icao_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Issuing Icao Code","description":"For airline aggregators, three-character ICAO code of the airline issuing the ticket.","example":"TSC","uniqueKey":"airline.oneOf.0.issuing_icao_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.issuing_icao_code","typeLabel":"string | null"},"legs":{"oneOf":[{"type":"array","items":{"properties":{"arrival_airport":{"oneOf":[{"type":"string","title":"Arrival Airport","description":"Arrival airport code of leg. 3-letter ISO code according to IATA official directory.","maxLength":3,"minLength":3,"example":"LAX","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arrival Airport","description":"Arrival airport code of leg. 3-letter ISO code according to IATA official directory.","example":"LAX","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_airport","typeLabel":"string | null"},"arrival_at":{"oneOf":[{"type":"string","title":"Arrival At","description":"The date and time of travel in local time at the arrival airport.","format":"date-time","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Arrival At","description":"The date and time of travel in local time at the arrival airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_at","typeLabel":"string\u003cdate-time> | null"},"arrival_city":{"oneOf":[{"type":"string","title":"Arrival City","description":"Arrival city name.","maxLength":100,"minLength":1,"example":"Los Angeles","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arrival City","description":"Arrival city name.","example":"Los Angeles","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_city","typeLabel":"string | null"},"arrival_country":{"oneOf":[{"type":"string","title":"Arrival Country","description":"Arrival country code in ISO 3166 format.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Arrival Country","description":"Arrival country code in ISO 3166 format.","example":"US","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].arrival_country","typeLabel":"string | null"},"carrier_code":{"oneOf":[{"type":"string","title":"Carrier Code","description":"3 character airline code as set by IATA.","maxLength":3,"minLength":2,"example":"649","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Carrier Code","description":"3 character airline code as set by IATA.","example":"649","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_code","typeLabel":"string | null"},"carrier_name":{"oneOf":[{"type":"string","title":"Carrier Name","description":"Name of the airline.","minLength":1,"example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Carrier Name","description":"Name of the airline.","example":"Air Transat A.T. Inc","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].carrier_name","typeLabel":"string | null"},"iata_designator":{"oneOf":[{"type":"string","title":"Iata Designator","description":"Two-character IATA code of the airline.","maxLength":2,"minLength":2,"example":"TS","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator.oneOf.0","typeLabel":"string"},{"type":"null","title":"Iata Designator","description":"Two-character IATA code of the airline.","example":"TS","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].iata_designator","typeLabel":"string | null"},"icao_code":{"oneOf":[{"type":"string","title":"Icao Code","description":"Three-character ICAO code of the airline.","maxLength":3,"minLength":3,"example":"TSC","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Icao Code","description":"Three-character ICAO code of the airline.","example":"TSC","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].icao_code","typeLabel":"string | null"},"coupon_number":{"oneOf":[{"type":"string","title":"Coupon Number","description":"Coupon number associated with the leg.","maxLength":50,"minLength":1,"example":"15885566","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Coupon Number","description":"Coupon number associated with the leg.","example":"15885566","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].coupon_number","typeLabel":"string | null"},"departure_airport":{"oneOf":[{"type":"string","title":"Departure Airport","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","maxLength":3,"minLength":3,"example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport.oneOf.0","typeLabel":"string"},{"type":"null","title":"Departure Airport","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","example":"LHR","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_airport","typeLabel":"string | null"},"departure_at":{"oneOf":[{"type":"string","title":"Departure At","description":"The date and time of travel in local time at the departure airport.","format":"date-time","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Departure At","description":"The date and time of travel in local time at the departure airport.","example":"2013-07-16T19:23:00.000+00:00","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_at","typeLabel":"string\u003cdate-time> | null"},"departure_city":{"oneOf":[{"type":"string","title":"Departure City","description":"Departure city name.","maxLength":100,"minLength":1,"example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city.oneOf.0","typeLabel":"string"},{"type":"null","title":"Departure City","description":"Departure city name.","example":"London","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_city","typeLabel":"string | null"},"departure_country":{"oneOf":[{"type":"string","title":"Departure Country","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","pattern":"^[A-Z]{2}$","example":"GB","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Departure Country","description":"Departure airport code of leg. 3-letter ISO code according to IATA official directory.","example":"GB","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_country","typeLabel":"string | null"},"departure_tax_amount":{"oneOf":[{"type":"integer","title":"Departure Tax Amount","description":"Departure tax amount charged by a country when a person is leaving the country.","maximum":99999999,"minimum":0,"example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Departure Tax Amount","description":"Departure tax amount charged by a country when a person is leaving the country.","example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].departure_tax_amount","typeLabel":"integer | null"},"fare_amount":{"oneOf":[{"type":"integer","title":"Fare Amount","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","maximum":99999999,"minimum":0,"example":129900,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Fare Amount","description":"Amount of the ticket, for current leg of the trip, excluding taxes and fees.","example":129900,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_amount","typeLabel":"integer | null"},"fare_basis_code":{"oneOf":[{"type":"string","title":"Fare Basis Code","description":"The alphanumeric code for the booking class of a ticket.","maxLength":8,"minLength":1,"example":"FY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Fare Basis Code","description":"The alphanumeric code for the booking class of a ticket.","example":"FY","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fare_basis_code","typeLabel":"string | null"},"fee_amount":{"oneOf":[{"type":"integer","title":"Fee Amount","description":"Fee amount for current leg of the trip.","maximum":99999999,"minimum":0,"example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Fee Amount","description":"Fee amount for current leg of the trip.","example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].fee_amount","typeLabel":"integer | null"},"flight_class":{"oneOf":[{"type":"string","title":"Flight Class","description":"Indicates service class (first class, business class, etc.).","maxLength":5,"minLength":1,"example":"E","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class.oneOf.0","typeLabel":"string"},{"type":"null","title":"Flight Class","description":"Indicates service class (first class, business class, etc.).","example":"E","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_class","typeLabel":"string | null"},"flight_number":{"oneOf":[{"type":"string","title":"Flight Number","description":"Unique identifier of the flight number.","maxLength":6,"minLength":3,"example":"101","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Flight Number","description":"Unique identifier of the flight number.","example":"101","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].flight_number","typeLabel":"string | null"},"route_type":{"oneOf":[{"type":"string","title":"Route Type","description":"The route type of the flight.","enum":["round_trip","one_way"],"x-speakeasy-unknown-values":"allow","example":"round_trip","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Route Type","description":"The route type of the flight.","example":"round_trip","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].route_type","typeLabel":"enum\u003cstring> | null"},"seat_class":{"oneOf":[{"type":"string","title":"Seat Class","description":"Indicates seat class (first class, business class, etc.).","maxLength":5,"minLength":1,"example":"F","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class.oneOf.0","typeLabel":"string"},{"type":"null","title":"Seat Class","description":"Indicates seat class (first class, business class, etc.).","example":"F","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].seat_class","typeLabel":"string | null"},"stop_over":{"oneOf":[{"type":"boolean","title":"Stop Over","description":"Indicates whether a stopover is allowed on this ticket.","example":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Stop Over","description":"Indicates whether a stopover is allowed on this ticket.","example":false,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].stop_over","typeLabel":"boolean | null"},"tax_amount":{"oneOf":[{"type":"integer","title":"Tax Amount","description":"Amount of the taxes for current leg of the trip.","maximum":99999999,"minimum":0,"example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Tax Amount","description":"Amount of the taxes for current leg of the trip.","example":1200,"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX].tax_amount","typeLabel":"integer | null"}},"additionalProperties":false,"type":"object","title":"AirlineLeg","uniqueKey":"airline.oneOf.0.legs.oneOf.0.items.[INDEX]","typeLabel":"AirlineLeg · object"},"title":"Legs","description":"An array of separate trip segments. Each leg contains detailed itinerary information.","maxItems":20,"uniqueKey":"airline.oneOf.0.legs.oneOf.0","typeLabel":"AirlineLeg · object[]"},{"type":"null","title":"Legs","description":"An array of separate trip segments. Each leg contains detailed itinerary information.","uniqueKey":"airline.oneOf.0.legs.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.legs","typeLabel":"AirlineLeg · object[] | null"},"passenger_name_record":{"oneOf":[{"type":"string","title":"Passenger Name Record","description":"The Passenger Name Record (PNR) in the airline reservation system.","maxLength":50,"minLength":1,"example":"JOHN L","uniqueKey":"airline.oneOf.0.passenger_name_record.oneOf.0","typeLabel":"string"},{"type":"null","title":"Passenger Name Record","description":"The Passenger Name Record (PNR) in the airline reservation system.","example":"JOHN L","uniqueKey":"airline.oneOf.0.passenger_name_record.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passenger_name_record","typeLabel":"string | null"},"passengers":{"oneOf":[{"type":"array","items":{"properties":{"age_group":{"oneOf":[{"type":"string","title":"Age Group","description":"The age group for the passenger.","enum":["adult","infant"],"x-speakeasy-unknown-values":"allow","example":"adult","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Age Group","description":"The age group for the passenger.","example":"adult","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].age_group","typeLabel":"enum\u003cstring> | null"},"date_of_birth":{"oneOf":[{"type":"string","title":"Date Of Birth","description":"The passenger's date of birth in YYYY-MM-YY format.","format":"date","example":"2013-07-16","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Date Of Birth","description":"The passenger's date of birth in YYYY-MM-YY format.","example":"2013-07-16","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].date_of_birth","typeLabel":"string\u003cdate> | null"},"email_address":{"oneOf":[{"type":"string","title":"Email Address","description":"The email address of the passenger.","maxLength":320,"minLength":1,"example":"john@example.com","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email Address","description":"The email address of the passenger.","example":"john@example.com","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].email_address","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"The first name(s) or given name of the passenger.","maxLength":255,"minLength":1,"example":"John","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"The first name(s) or given name of the passenger.","example":"John","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].first_name","typeLabel":"string | null"},"frequent_flyer_number":{"oneOf":[{"type":"string","title":"Frequent Flyer Number","description":"The passenger's frequent flyer number.","maxLength":50,"minLength":5,"example":"15885566","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Frequent Flyer Number","description":"The passenger's frequent flyer number.","example":"15885566","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].frequent_flyer_number","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"The last name, or family name, of the passenger.","maxLength":255,"minLength":1,"example":"Luhn","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"The last name, or family name, of the passenger.","example":"Luhn","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].last_name","typeLabel":"string | null"},"passport_number":{"oneOf":[{"type":"string","title":"Passport Number","description":"The passenger's unique passport number.","maxLength":50,"minLength":1,"example":"11117700225","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Passport Number","description":"The passenger's unique passport number.","example":"11117700225","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].passport_number","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","title":"Phone Number","description":"The phone number of the passenger. This number is formatted according to the E164 number standard.","pattern":"^\\+[1-9]\\d{1,14}$","example":"+1234567890","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Phone Number","description":"The phone number of the passenger. This number is formatted according to the E164 number standard.","example":"+1234567890","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].phone_number","typeLabel":"string | null"},"ticket_number":{"oneOf":[{"type":"string","title":"Ticket Number","description":"The ticket number for a flight.","maxLength":50,"minLength":1,"example":"BA1236699999","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ticket Number","description":"The ticket number for a flight.","example":"BA1236699999","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].ticket_number","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title of the passenger.","maxLength":50,"minLength":1,"example":"Mr.","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title of the passenger.","example":"Mr.","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].title","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","title":"Country Code","description":"The country of residence of the passenger","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].country_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country Code","description":"The country of residence of the passenger","example":"US","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX].country_code","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","title":"AirlinePassenger","uniqueKey":"airline.oneOf.0.passengers.oneOf.0.items.[INDEX]","typeLabel":"AirlinePassenger · object"},"title":"Passengers","description":"An array of the travelling passengers.","maxItems":20,"uniqueKey":"airline.oneOf.0.passengers.oneOf.0","typeLabel":"AirlinePassenger · object[]"},{"type":"null","title":"Passengers","description":"An array of the travelling passengers.","uniqueKey":"airline.oneOf.0.passengers.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.passengers","typeLabel":"AirlinePassenger · object[] | null"},"reservation_system":{"oneOf":[{"type":"string","title":"Reservation System","description":"The name of the reservation system.","maxLength":200,"minLength":1,"example":"Amadeus","uniqueKey":"airline.oneOf.0.reservation_system.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reservation System","description":"The name of the reservation system.","example":"Amadeus","uniqueKey":"airline.oneOf.0.reservation_system.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.reservation_system","typeLabel":"string | null"},"restricted_ticket":{"oneOf":[{"type":"boolean","title":"Restricted Ticket","description":"Indicates whether the ticket is restricted (refundable).","example":false,"uniqueKey":"airline.oneOf.0.restricted_ticket.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Restricted Ticket","description":"Indicates whether the ticket is restricted (refundable).","example":false,"uniqueKey":"airline.oneOf.0.restricted_ticket.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.restricted_ticket","typeLabel":"boolean | null"},"ticket_delivery_method":{"oneOf":[{"type":"string","title":"Ticket Delivery Method","description":"The delivery method of the ticket.","default":"electronic","enum":["electronic","other"],"x-speakeasy-unknown-values":"allow","example":"electronic","uniqueKey":"airline.oneOf.0.ticket_delivery_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Ticket Delivery Method","description":"The delivery method of the ticket.","default":"electronic","example":"electronic","uniqueKey":"airline.oneOf.0.ticket_delivery_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.ticket_delivery_method","typeLabel":"enum\u003cstring> | null"},"ticket_number":{"oneOf":[{"type":"string","title":"Ticket Number","description":"The airline's unique ticket number.","maxLength":50,"minLength":1,"example":"123-1234-151555","uniqueKey":"airline.oneOf.0.ticket_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ticket Number","description":"The airline's unique ticket number.","example":"123-1234-151555","uniqueKey":"airline.oneOf.0.ticket_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.ticket_number","typeLabel":"string | null"},"travel_agency_code":{"oneOf":[{"type":"string","title":"Travel Agency Code","description":"The IATA travel agency code.","maxLength":50,"minLength":1,"example":"12345","uniqueKey":"airline.oneOf.0.travel_agency_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Code","description":"The IATA travel agency code.","example":"12345","uniqueKey":"airline.oneOf.0.travel_agency_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_code","typeLabel":"string | null"},"travel_agency_invoice_number":{"oneOf":[{"type":"string","title":"Travel Agency Invoice Number","description":"The reference number of the invoice that was issued by the travel agency.","maxLength":50,"minLength":1,"example":"EG15555155","uniqueKey":"airline.oneOf.0.travel_agency_invoice_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Invoice Number","description":"The reference number of the invoice that was issued by the travel agency.","example":"EG15555155","uniqueKey":"airline.oneOf.0.travel_agency_invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_invoice_number","typeLabel":"string | null"},"travel_agency_name":{"oneOf":[{"type":"string","title":"Travel Agency Name","description":"The name of the travel agency.","maxLength":200,"minLength":1,"example":"ACME Agency","uniqueKey":"airline.oneOf.0.travel_agency_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Name","description":"The name of the travel agency.","example":"ACME Agency","uniqueKey":"airline.oneOf.0.travel_agency_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_name","typeLabel":"string | null"},"travel_agency_plan_name":{"oneOf":[{"type":"string","title":"Travel Agency Plan Name","description":"The name of the travel agency plan.","maxLength":200,"minLength":1,"example":"B733","uniqueKey":"airline.oneOf.0.travel_agency_plan_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Travel Agency Plan Name","description":"The name of the travel agency plan.","example":"B733","uniqueKey":"airline.oneOf.0.travel_agency_plan_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline.oneOf.0.travel_agency_plan_name","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"airline.oneOf.0","typeLabel":"Airline · object"},{"type":"null","description":"The airline addendum data which describes the airline booking associated with this transaction.","uniqueKey":"airline.oneOf.1","typeLabel":"null"}],"uniqueKey":"airline","typeLabel":"Airline · object | null"},"type":{"type":"string","const":"checkout-session","title":"Type","description":"Always `checkout-session`","default":"checkout-session","examples":["checkout-session"],"uniqueKey":"type","typeLabel":"string"},"payment_method":{"oneOf":[{"type":"object","title":"CheckoutSessionPaymentMethod","description":"Information about the payment method stored on the checkout session.","properties":{"type":{"type":"string","const":"payment-method","title":"Type","description":"Always `payment-method`","default":"payment-method","examples":["payment-method"],"uniqueKey":"payment_method.oneOf.0.type","typeLabel":"string"},"id":{"oneOf":[{"type":"string","title":"Id","description":"The ID of the payment method.","format":"uuid","example":"ef9496d8-53a5-4aad-8ca2-00eb68334389","uniqueKey":"payment_method.oneOf.0.id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Id","description":"The ID of the payment method.","example":"ef9496d8-53a5-4aad-8ca2-00eb68334389","uniqueKey":"payment_method.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.id","typeLabel":"string\u003cuuid> | null"},"details":{"oneOf":[{"type":"object","title":"CheckoutSessionPaymentMethodDetails","description":"Details for credit or debit card payment method.","properties":{"bin":{"oneOf":[{"type":"string","title":"Bin","description":"The first 6 digit of the card.","example":"411111","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.bin.oneOf.0","typeLabel":"string"},{"type":"null","title":"Bin","description":"The first 6 digit of the card.","example":"411111","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.bin.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.bin","typeLabel":"string | null"},"card_country":{"oneOf":[{"type":"string","title":"Card Country","description":"The country of the card issuer.","pattern":"^[A-Z]{2}$","example":"US","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Country","description":"The country of the card issuer.","example":"US","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_country","typeLabel":"string | null"},"card_type":{"oneOf":[{"type":"string","title":"CardType","description":"The payment scheme of the card.","enum":["credit","debit","prepaid"],"x-speakeasy-unknown-values":"allow","example":"credit","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The payment scheme of the card.","example":"credit","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_type","typeLabel":"enum\u003cstring> | null"},"card_issuer_name":{"oneOf":[{"type":"string","title":"Card Issuer Name","description":"The card issuer.","example":"Bank of America NA","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_issuer_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Issuer Name","description":"The card issuer.","example":"Bank of America NA","uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_issuer_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details.oneOf.0.card_issuer_name","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"payment_method.oneOf.0.details.oneOf.0","typeLabel":"CheckoutSessionPaymentMethodDetails · object"},{"type":"null","description":"Details for credit or debit card payment method.","uniqueKey":"payment_method.oneOf.0.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.details","typeLabel":"CheckoutSessionPaymentMethodDetails · object | null"},"label":{"oneOf":[{"type":"string","title":"Label","description":"The last 4 digits of the the card.","example":"1234","uniqueKey":"payment_method.oneOf.0.label.oneOf.0","typeLabel":"string"},{"type":"null","title":"Label","description":"The last 4 digits of the the card.","example":"1234","uniqueKey":"payment_method.oneOf.0.label.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.label","typeLabel":"string | null"},"method":{"type":"string","const":"card","title":"Method","description":"Always `card`","default":"card","examples":["card"],"uniqueKey":"payment_method.oneOf.0.method","typeLabel":"string"},"scheme":{"oneOf":[{"type":"string","title":"CardScheme","description":"The scheme of the card.","enum":["accel","amex","bancontact","carte-bancaire","cirrus","culiance","dankort","diners-club","discover","eftpos-australia","elo","hipercard","jcb","maestro","mastercard","mir","nyce","other","pulse","qcard","rupay","star","uatp","unionpay","visa"],"x-speakeasy-unknown-values":"allow","example":"visa","uniqueKey":"payment_method.oneOf.0.scheme.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The scheme of the card.","example":"visa","uniqueKey":"payment_method.oneOf.0.scheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.scheme","typeLabel":"enum\u003cstring> | null"},"fingerprint":{"oneOf":[{"type":"string","title":"Fingerprint","description":"The unique hash derived from the card number.","example":"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4","uniqueKey":"payment_method.oneOf.0.fingerprint.oneOf.0","typeLabel":"string"},{"type":"null","title":"Fingerprint","description":"The unique hash derived from the card number.","example":"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4","uniqueKey":"payment_method.oneOf.0.fingerprint.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.0.fingerprint","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"payment_method.oneOf.0","typeLabel":"CheckoutSessionPaymentMethod · object"},{"type":"null","description":"Information about the payment method stored on the checkout session.","uniqueKey":"payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method","typeLabel":"CheckoutSessionPaymentMethod · object | null"}},"additionalProperties":false,"type":"object","required":["id","expires_at"],"title":"CheckoutSession","uniqueKey":"","typeLabel":"CheckoutSession · object"},"examples":{"Example":{"title":"Example","value":{"id":"4137b1cf-39ac-42a8-bad6-1c680d5dab6b","expires_at":"2013-07-16T19:23:00.000+00:00","cart_items":[{"name":"GoPro HD","quantity":2,"unit_amount":1299,"discount_amount":0,"tax_amount":0,"external_identifier":"goprohd","sku":"GPHD1078","upc":"012345678905","product_url":"https://example.com/catalog/go-pro-hd","image_url":"https://example.com/images/go-pro-hd.jpg","categories":["camera","travel","gear"],"subcategories":["action-cameras"],"brand":"GoPro","product_type":"physical","seller_country":"US","tax_exempt":false,"unit_of_measure":"feet","commodity_code":"43211503","description":"A brief description of an interesting item.","duty_amount":1299,"shipping_amount":1299}],"metadata":{"cohort":"cohort-a","order_id":"order-12345"},"buyer":{"display_name":"John Doe","external_identifier":"buyer-12345","billing_details":{"first_name":"John","last_name":"Doe","email_address":"john@example.com","phone_number":"+1234567890","address":{"city":"San Jose","country":"US","postal_code":"94560","state":"California","state_code":"US-CA","house_number_or_name":"10","line1":"Stafford Appartments","line2":"29th Street","organization":"Gr4vy"},"tax_id":{"value":"12345678931","kind":"us.ein"}},"account_number":"\u003cstring>","shipping_details":{"first_name":"John","last_name":"Doe","email_address":"john@example.com","phone_number":"+1234567890","address":{"city":"San Jose","country":"US","postal_code":"94560","state":"California","state_code":"US-CA","house_number_or_name":"10","line1":"Stafford Appartments","line2":"29th Street","organization":"Gr4vy"}}},"airline":{"booking_code":"X36Q9C","is_cardholder_traveling":true,"issued_address":"123 Broadway, New York","issued_at":"2013-07-16T19:23:00.000+00:00","issuing_carrier_code":"649","issuing_carrier_name":"Air Transat A.T. Inc","issuing_iata_designator":"TS","issuing_icao_code":"TSC","legs":[{"arrival_airport":"LAX","arrival_at":"2013-07-16T19:23:00.000+00:00","arrival_city":"Los Angeles","arrival_country":"US","carrier_code":"649","carrier_name":"Air Transat A.T. Inc","iata_designator":"TS","icao_code":"TSC","coupon_number":"15885566","departure_airport":"LHR","departure_at":"2013-07-16T19:23:00.000+00:00","departure_city":"London","departure_country":"GB","departure_tax_amount":1200,"fare_amount":129900,"fare_basis_code":"FY","fee_amount":1200,"flight_class":"E","flight_number":"101","route_type":"round_trip","seat_class":"F","stop_over":false,"tax_amount":1200}],"passenger_name_record":"JOHN L","passengers":[{"age_group":"adult","date_of_birth":"2013-07-16","email_address":"john@example.com","first_name":"John","frequent_flyer_number":"15885566","last_name":"Luhn","passport_number":"11117700225","phone_number":"+1234567890","ticket_number":"BA1236699999","title":"Mr.","country_code":"US"}],"reservation_system":"Amadeus","restricted_ticket":false,"ticket_delivery_method":"electronic","ticket_number":"123-1234-151555","travel_agency_code":"12345","travel_agency_invoice_number":"EG15555155","travel_agency_name":"ACME Agency","travel_agency_plan_name":"B733"},"type":"checkout-session","payment_method":{"type":"payment-method","id":"ef9496d8-53a5-4aad-8ca2-00eb68334389","details":{"bin":"411111","card_country":"US","card_type":"credit","card_issuer_name":"Bank of America NA"},"label":"1234","method":"card","scheme":"visa","fingerprint":"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"}}}},"exampleType":"generated"}},"exampleType":"generated"},"30eb68b3-0b40-4b81-9fff-df9e25795a47":{"description":"The request was invalid.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `bad_request`","default":"bad_request","examples":["bad_request"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `400`.","default":400,"examples":[400],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error400","uniqueKey":"","typeLabel":"Error400 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"bad_request","status":400,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"f44ce367-1cba-4cdc-8d00-1a5f9aedfbbc":{"description":"The request was unauthorized.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `unauthorized`","default":"unauthorized","examples":["unauthorized"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `401`.","default":401,"examples":[401],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"No valid API authentication found","examples":["No valid API authentication found"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error401","uniqueKey":"","typeLabel":"Error401 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"unauthorized","status":401,"message":"No valid API authentication found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"90a6a540-db7e-49c5-a5d6-eac4475a2d6f":{"description":"The credentials were invalid or the caller did not have permission to act on the resource.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `forbidden`","default":"forbidden","examples":["forbidden"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `403`.","default":403,"examples":[403],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error403","uniqueKey":"","typeLabel":"Error403 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"forbidden","status":403,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d5d3ea14-8453-4a72-af83-a43bae634922":{"description":"The resource was not found.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `not_found`","default":"not_found","examples":["not_found"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `404`.","default":404,"examples":[404],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"The resource could not be found","examples":["The resource could not be found"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error404","uniqueKey":"","typeLabel":"Error404 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"not_found","status":404,"message":"The resource could not be found","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"25a620d1-7341-429a-a5cf-61bff9b1bb7a":{"description":"The request method was not allowed.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `method_not_allowed`","default":"method_not_allowed","examples":["method_not_allowed"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `405`.","default":405,"examples":[405],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Method Not Allowed","examples":["Method Not Allowed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error405","uniqueKey":"","typeLabel":"Error405 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"method_not_allowed","status":405,"message":"Method Not Allowed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d6f195db-022c-4001-8112-f7021e0145dd":{"description":"A duplicate record was found.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `duplicate_record`","default":"duplicate_record","examples":["duplicate_record"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `409`.","default":409,"examples":[409],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"},"resource_id":{"oneOf":[{"type":"string","title":"Resource Id","description":"The ID of the conflicting resource.","example":"cdc70639-cb9c-4222-a73f-b8ce39f7821b","uniqueKey":"resource_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Resource Id","description":"The ID of the conflicting resource.","example":"cdc70639-cb9c-4222-a73f-b8ce39f7821b","uniqueKey":"resource_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource_id","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","title":"Error409","uniqueKey":"","typeLabel":"Error409 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"duplicate_record","status":409,"message":"Request failed validation","details":[],"resource_id":"cdc70639-cb9c-4222-a73f-b8ce39f7821b"}}},"exampleType":"generated"}},"exampleType":"generated"},"8ba9a125-dd41-4385-aefd-aa8beed9a5fb":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6266f95e-820d-4c4e-a8ab-085b3da7ff5e":{"description":"The request was too early.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `too_early`","default":"too_early","examples":["too_early"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `425`.","default":425,"examples":[425],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error425","uniqueKey":"","typeLabel":"Error425 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"too_early","status":425,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"3c9e7b1a-12b8-44cd-a299-433c51d703f0":{"description":"Too many requests were made.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `too_many_requests`","default":"too_many_requests","examples":["too_many_requests"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `429`.","default":429,"examples":[429],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Generic error","examples":["Request failed validation"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error429","uniqueKey":"","typeLabel":"Error429 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"too_many_requests","status":429,"message":"Request failed validation","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"ed8316be-123f-4111-a971-524830b99041":{"description":"The server encountered an error.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `server_error`","default":"server_error","examples":["server_error"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `500`.","default":500,"examples":[500],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Request could not be processed","examples":["Request could not be processed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error500","uniqueKey":"","typeLabel":"Error500 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"server_error","status":500,"message":"Request could not be processed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"07614aff-8e71-4381-88c9-1990a9840622":{"description":"The server encountered an error.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `bad_gateway`","default":"bad_gateway","examples":["bad_gateway"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Always `502`.","default":502,"examples":[502],"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Request could not be processed","examples":["Request could not be processed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error502","uniqueKey":"","typeLabel":"Error502 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"bad_gateway","status":502,"message":"Request could not be processed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d65c73cd-8371-42d8-8e32-d4be49a684ee":{"description":"The server encountered an error.","content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"error","title":"Type","description":"Always `error`.","default":"error","examples":["error"],"uniqueKey":"type","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"Always `gateway_timeout`","default":"gateway_timeout","examples":["gateway_timeout"],"uniqueKey":"code","typeLabel":"string"},"status":{"type":"integer","title":"Status","default":504,"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"A human readable message that provides more context to the error.","default":"Request could not be processed","examples":["Request could not be processed"],"uniqueKey":"message","typeLabel":"string"},"details":{"items":{"properties":{"location":{"description":"The part of the request where the property can be found that caused the error.","examples":["body"],"type":"string","enum":["query","body","path","header","unknown"],"title":"ErrorLocation","x-speakeasy-unknown-values":"allow","overlay":"1.0.0","isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"pointer":{"oneOf":[{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","format":"json-pointer","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.0","typeLabel":"string\u003cjson-pointer>"},{"type":"string","title":"Pointer","description":"A JSON pointer for the particular property that caused the error.","example":"/currency","isRequired":true,"uniqueKey":"details.items.[INDEX].pointer.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"details.items.[INDEX].pointer","typeLabel":"string\u003cjson-pointer> | string"},"message":{"type":"string","title":"Message","description":"A human-readdable explanation of the error.","examples":["Unknown ISO 4217 currency code: USX"],"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","title":"Type","description":"The type of error that was raised for this property.","examples":["value_error"],"isRequired":true,"uniqueKey":"details.items.[INDEX].type","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["location","pointer","message","type"],"title":"ErrorDetail","uniqueKey":"details.items.[INDEX]","typeLabel":"ErrorDetail · object"},"type":"array","title":"Details","description":"A list of details that further ellaborate on the error.","default":[],"uniqueKey":"details","typeLabel":"ErrorDetail · object[]"}},"additionalProperties":false,"type":"object","title":"Error504","uniqueKey":"","typeLabel":"Error504 · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","code":"gateway_timeout","status":504,"message":"Request could not be processed","details":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1c94c691-caf6-424e-b0d4-912fcc945a19":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0048b136-b0cb-4528-8f3a-95ce1a20d337":{"url":"https://api.sandbox.{id}.gr4vy.app","x-speakeasy-server-id":"sandbox","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}},"b15a1711-bb6b-4cdf-9106-1a445dacccf7":{"url":"https://api.{id}.gr4vy.app","x-speakeasy-server-id":"production","variables":{"id":{"default":"example","description":"The subdomain for your Gr4vy instance."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.speakeasy.json"},"subdomain":"flexxbuy","siteName":"Gr4vy","title":"Create checkout session - Gr4vy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-27T10:02:14.904Z","originalFileLocation":"reference/checkout-sessions/new-checkout-session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new checkout session.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create checkout session - Gr4vy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new checkout session.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gr4vy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Checkout+Sessions\u0026amp;title=Create+checkout+session\u0026amp;description=Create+a+new+checkout+session.\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=db4165d14f6e4ec925f04dc4e4d94eb066039576736c24e94c07c4b06faa56a0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create checkout session - Gr4vy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new checkout session.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexxbuy.mintlify.app/_mintlify/api/og/v2?division=Checkout+Sessions\u0026amp;title=Create+checkout+session\u0026amp;description=Create+a+new+checkout+session.\u0026amp;theme=93f51384d2ec49fce20f3d31\u0026amp;signature=db4165d14f6e4ec925f04dc4e4d94eb066039576736c24e94c07c4b06faa56a0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/flexxbuy/UwX1s5aPWOD2LQQg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gr4vy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/checkout-sessions/new-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.byzly.com/#organization\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexxbuy/AxFxa3X7-38b2HYz/assets/logos/light.svg?fit=max\u0026auto=format\u0026n=AxFxa3X7-38b2HYz\u0026q=85\u0026s=c8c719a4e76f3fc4418d42afd2c0ee99\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.byzly.com#website\",\"name\":\"Gr4vy\",\"url\":\"https://docs.byzly.com\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session#webpage\",\"url\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session\",\"name\":\"Create checkout session\",\"description\":\"Create a new checkout session.\",\"dateModified\":\"2026-07-27T10:02:14.904Z\",\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Gr4vy\",\"item\":\"https://docs.byzly.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create checkout session\",\"item\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session#apireference\",\"headline\":\"Create checkout session\",\"name\":\"Create checkout session\",\"description\":\"Create a new checkout session.\",\"url\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.byzly.com/reference/checkout-sessions/new-checkout-session#webpage\"},\"dateModified\":\"2026-07-27T10:02:14.904Z\",\"publisher\":{\"@id\":\"https://docs.byzly.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.byzly.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gr4vy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gr4vy","nav":{"global":null,"tabs":[{"tab":"Build","icon":"credit-card","pages":[{"title":"Build","href":"/guides/get-started"}]},{"tab":"Dashboard","icon":"circle-user","pages":[{"title":"Dashboard","href":"/guides/dashboard/overview"}]},{"tab":"Connections","icon":{"style":"light","name":"circle-nodes"},"pages":[{"title":"Connections","href":"/connections/payments/overview"}]},{"tab":"Custom Connectors","icon":"plug","hidden":true,"pages":[{"title":"Custom Connectors","href":"/guides/features/custom-connectors/overview"}]},{"tab":"Connector Requirements","icon":"clipboard-check","hidden":true,"pages":[{"title":"Connector Requirements","href":"/partners/connector-requirements/overview"}]},{"tab":"External Apps","icon":"puzzle-piece","hidden":true,"pages":[{"title":"External Apps","href":"/partners/external-apps"}]},{"tab":"API Reference","icon":{"style":"light","name":"square-terminal"},"groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Authentication","mode":"wide","href":"/guides/api/authentication"},{"title":"Managing API keys","sidebarTitle":"API keys","mode":"wide","href":"/guides/api/api-keys"},{"title":"API Compatibility","sidebarTitle":"Compatibility","href":"/guides/api/compatibility"},{"title":"Connectivity and TLS","sidebarTitle":"Connectivity","href":"/guides/api/connectivity"},{"sidebarTitle":"JWTs","title":"Authentication with JWTs","href":"/guides/api/jwts"},{"title":"Environments","href":"/guides/api/environments"},{"title":"Error handling","sidebarTitle":"Errors","mode":"wide","href":"/guides/api/errors"},{"title":"Idempotent requests","href":"/guides/api/idempotent-requests"},{"title":"IP address forwarding","href":"/guides/api/ip-address-forwarding"},{"title":"OpenAPI 3.1.0 Specification","sidebarTitle":"OpenAPI","href":"/guides/api/openapi"},{"title":"Pagination","href":"/guides/api/pagination"},{"sidebarTitle":"Prefer header","title":"Prefer header","href":"/guides/api/prefer-header"},{"title":"Rate limiting","href":"/guides/api/rate-limiting"},{"sidebarTitle":"Timeouts","title":"Handling transaction timeout","mode":"wide","href":"/guides/timeouts"},{"title":"Transaction error codes","sidebarTitle":"Error Codes","mode":"wide","href":"/guides/api/error-codes"}]},{"group":"Transactions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions","title":"List transactions","href":"/reference/transactions/list-transactions"},{"openapi":"openapi.speakeasy.json POST /transactions","title":"Create transaction","href":"/reference/transactions/new-transaction"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}","title":"Get transaction","href":"/reference/transactions/get-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/capture","title":"Capture transaction","href":"/reference/transactions/capture-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/void","title":"Void transaction","href":"/reference/transactions/void-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/authorization/increment","title":"Increment transaction authorization","href":"/reference/transactions/increment-transaction-authorization"},{"group":"Captures","pages":[{"sidebarTitle":"List captures","title":"List transaction captures","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures","href":"/reference/transactions/list-transaction-captures"},{"sidebarTitle":"Get capture","title":"Get capture","openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/captures/{capture_id}","href":"/reference/transactions/get-transaction-capture"}]},{"group":"More actions","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/events","title":"List transaction events","href":"/reference/transactions/list-transaction-events"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/actions","title":"List transaction Flow rules","href":"/reference/transactions/list-transaction-actions"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/sync","title":"Sync transaction","href":"/reference/transactions/sync-transaction"},{"title":"Update a transaction","openapi":"openapi.speakeasy.json PUT /transactions/{transaction_id}","href":"/reference/transactions/update-transaction"},{"title":"Cancel a transaction","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/cancel","href":"/reference/transactions/cancel-transaction"},{"title":"Get or update transaction session","sidebarTitle":"Get session","openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/session","href":"/reference/transactions/get-transaction-session"}]}]},{"group":"Buyers","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /buyers","title":"List all buyers","href":"/reference/buyers/list-buyers"},{"openapi":"openapi.speakeasy.json POST /buyers","title":"Add a buyer","href":"/reference/buyers/new-buyer"},{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}","title":"Get a buyer","href":"/reference/buyers/get-buyer"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}","title":"Update a buyer","href":"/reference/buyers/update-buyer"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}","title":"Delete a buyer","href":"/reference/buyers/delete-buyer"},{"group":"Shipping details","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/{buyer_id}/shipping-details","title":"List a buyer's shipping details","href":"/reference/buyers/get-buyer-shipping-details"},{"openapi":"openapi.speakeasy.json POST /buyers/{buyer_id}/shipping-details","title":"Add buyer shipping details","href":"/reference/buyers/new-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json PUT /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Update a buyer's shipping details","href":"/reference/buyers/update-buyer-shipping-detail"},{"openapi":"openapi.speakeasy.json DELETE /buyers/{buyer_id}/shipping-details/{shipping_details_id}","title":"Delete a buyer's shipping details","description":"Delete the shipping details associated to a specific buyer.","href":"/reference/buyers/delete-buyer-shipping-detail"}]}]},{"group":"Checkout Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /checkout/sessions","title":"Create checkout session","href":"/reference/checkout-sessions/new-checkout-session"},{"openapi":"openapi.speakeasy.json GET /checkout/sessions/{checkout_session_id}","title":null,"description":null,"href":"/reference/checkout-sessions/get-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/update-checkout-session"},{"openapi":"openapi.speakeasy.json DELETE /checkout/sessions/{checkout_session_id}","title":null,"href":"/reference/checkout-sessions/delete-checkout-session"},{"openapi":"openapi.speakeasy.json PUT /checkout/sessions/{checkout_session_id}/fields","sidebarTitle":"Update session fields","title":null,"href":"/reference/checkout-sessions/update-checkout-session-fields"}]},{"group":"Payment links","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payment-links","title":"List all payment links","href":"/reference/payment-links/list-payment-links"},{"openapi":"openapi.speakeasy.json POST /payment-links","title":"Add a payment link","href":"/reference/payment-links/new-payment-link"},{"openapi":"openapi.speakeasy.json GET /payment-links/{payment_link_id}","title":"Get payment link","href":"/reference/payment-links/get-payment-link"},{"openapi":"openapi.speakeasy.json POST /payment-links/{payment_link_id}/expire","title":"Expire a payment link","href":"/reference/payment-links/expire-payment-link"}]},{"group":"Payment options","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-options","title":"List payment options","href":"/reference/payment-options/list-payment-options"}]},{"group":"Payouts","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /payouts","title":"List payouts created","href":"/reference/payouts/list-payouts"},{"openapi":"openapi.speakeasy.json POST /payouts","title":"Create a payout","href":"/reference/payouts/new-payout"},{"openapi":"openapi.speakeasy.json GET /payouts/{payout_id}","title":"Get a payout","href":"/reference/payouts/get-payout"}]},{"group":"Refunds","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refunds","title":"List transaction refunds","href":"/reference/transactions/list-transaction-refunds"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds","title":"Create transaction refund","href":"/reference/transactions/refund-transaction"},{"openapi":"openapi.speakeasy.json POST /transactions/{transaction_id}/refunds/all","sidebarTitle":"Refund all instruments","title":"Create batch transaction refund","href":"/reference/transactions/refund-all"},{"sidebarTitle":"Get refund","title":"Get refund","openapi":"openapi.speakeasy.json GET /refunds/{refund_id}","href":"/reference/transactions/get-refund"}]},{"group":"Sessions","icon":"code","pages":[{"openapi":"openapi.speakeasy.json POST /payment-service-definitions/{payment_service_definition_id}/sessions","sidebarTitle":"Get session","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session"},{"openapi":"openapi.speakeasy.json POST /payment-services/{payment_service_id}/sessions","sidebarTitle":"Get session by ID","title":"Create a session for a payment service definition","href":"/reference/payment-service-sessions/create-payment-service-session-by-id"}]},{"group":"Settlement records","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements","sidebarTitle":"List settlement records","title":"List transaction settlements","href":"/reference/settlements/list-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/settlements/{settlement_id}","sidebarTitle":"Get settlement record","title":"Get transaction settlement","href":"/reference/settlements/get-settlement"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements","sidebarTitle":"List refund settlement records","title":"List transaction refund settlements","href":"/reference/settlements/list-refund-settlements"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/refund-settlements/{settlement_id}","sidebarTitle":"Get refund settlement record","title":"Get transaction refund settlement","href":"/reference/settlements/get-refund-settlement"}]},{"group":"Disputes","icon":"code","pages":[{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargebacks","sidebarTitle":"List chargeback records","title":"List transaction chargebacks","href":"/reference/disputes/list-chargebacks"},{"openapi":"openapi.speakeasy.json GET /transactions/{transaction_id}/chargeback-reversals","sidebarTitle":"List chargeback reversal records","title":"List transaction chargeback reversals","href":"/reference/disputes/list-chargeback-reversals"}]},{"group":"Instruments","icon":"code","pages":[{"group":"Card schemes","pages":[{"openapi":"openapi.speakeasy.json GET /card-scheme-definitions","title":"List card scheme definitions","href":"/reference/card-schemes/list-card-scheme-definitions"}]},{"group":"Card details","pages":[{"openapi":"openapi.speakeasy.json GET /card-details","title":"Get card details","href":"/reference/card-details/get-card-details"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/apple/session","title":"Create a Apple Pay session","href":"/reference/digital-wallets/get-apple-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/google/session","title":"Create a Google Pay session","href":"/reference/digital-wallets/get-google-pay-session"},{"openapi":"openapi.speakeasy.json POST /digital-wallets/click-to-pay/session","title":"Create a Click to Pay session","href":"/reference/digital-wallets/get-click-to-pay-session"}]},{"group":"Gift cards","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/gift-cards","title":"List gift cards for a buyer","href":"/reference/gift-cards/list-buyer-gift-cards"},{"openapi":"openapi.speakeasy.json GET /gift-cards","title":"List gift cards","href":"/reference/gift-cards/list-gift-cards"},{"openapi":"openapi.speakeasy.json POST /gift-cards/balances","title":"Verify and get gift card balances","sidebarTitle":"Verify \u0026 get balance","href":"/reference/gift-cards/list-gift-card-balances"},{"openapi":"openapi.speakeasy.json POST /gift-cards","title":"Create gift card","href":"/reference/gift-cards/new-gift-card"},{"openapi":"openapi.speakeasy.json GET /gift-cards/{gift_card_id}","title":"Get gift card","href":"/reference/gift-cards/get-gift-card"},{"openapi":"openapi.speakeasy.json DELETE /gift-cards/{gift_card_id}","title":"Delete a gift card","href":"/reference/gift-cards/delete-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/issuances","title":"Issue a gift card","href":"/reference/gift-cards/issue-gift-card"},{"openapi":"openapi.speakeasy.json POST /gift-cards/activations","title":"Activate a gift card","href":"/reference/gift-cards/activate-gift-card"}]},{"group":"Payment methods","pages":[{"openapi":"openapi.speakeasy.json GET /buyers/payment-methods","title":"List payment methods for a buyer","href":"/reference/payment-methods/list-buyer-payment-methods"},{"openapi":"openapi.speakeasy.json GET /payment-methods","title":"List all payment methods","href":"/reference/payment-methods/list-payment-methods"},{"openapi":"openapi.speakeasy.json POST /payment-methods","title":"Create payment method","href":"/reference/payment-methods/new-payment-method"},{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}","title":"Get payment method","href":"/reference/payment-methods/get-payment-method"},{"openapi":"openapi.speakeasy.json PUT /payment-methods/{payment_method_id}","title":"Update payment method","href":"/reference/payment-methods/update-payment-method"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}","title":"Delete payment method","href":"/reference/payment-methods/delete-payment-method"}]},{"group":"Payment method definitions","pages":[{"openapi":"openapi.speakeasy.json GET /payment-method-definitions","title":"List payment method definitions","href":"/reference/payment-method-definitions/list-payment-method-definitions"}]}]},{"group":"Vault","icon":"code","pages":[{"group":"Account updater","pages":[{"openapi":"openapi.speakeasy.json POST /account-updater/jobs","sidebarTitle":"Create a job","title":"Create account updater job","href":"/reference/account-updater/new-account-updater-job"}]},{"group":"Network tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/network-tokens","title":"List network tokens","href":"/reference/network-tokens/list-network-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens","title":"Provision network token","href":"/reference/network-tokens/provision-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/cryptogram","title":"Provision network token cryptogram","href":"/reference/network-tokens/get-network-token-cryptogram"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend","title":"Suspend network token","href":"/reference/network-tokens/suspend-network-token"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume","title":"Resume network token","href":"/reference/network-tokens/resume-network-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/network-tokens/{network_token_id}","title":"Delete network token","href":"/reference/network-tokens/delete-network-token"}]},{"group":"Payment service tokens","pages":[{"openapi":"openapi.speakeasy.json GET /payment-methods/{payment_method_id}/payment-service-tokens","title":"List payment service tokens","href":"/reference/payment-service-tokens/list-payment-service-tokens"},{"openapi":"openapi.speakeasy.json POST /payment-methods/{payment_method_id}/payment-service-tokens","title":"Create payment service token","href":"/reference/payment-service-tokens/provision-payment-service-token"},{"openapi":"openapi.speakeasy.json DELETE /payment-methods/{payment_method_id}/payment-service-tokens/{payment_service_token_id}","title":"Delete payment service token","href":"/reference/payment-service-tokens/delete-payment-service-token"}]},{"group":"Vault Forward","pages":[{"openapi":"openapi.v1.json POST /vault-forward","title":"Forward PCI data","href":"/reference/vault-forwarding/make-vault-forward"}]},{"group":"Vault Forward endpoints","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs","sidebarTitle":"List endpoints","title":"List configured Vault Forward endpoints","href":"/reference/vault-forwarding/list-vault-forward-configs"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}","sidebarTitle":"Get endpoint","title":"Get configured Vault Forward endpoints","href":"/reference/vault-forwarding/get-vault-forward-config"}]},{"group":"Vault Forward authentication","pages":[{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Get authentications","title":"List configured Vault Forward authentication methods","href":"/reference/vault-forwarding/list-vault-forward-authentications"},{"openapi":"openapi.v1.json GET /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Get authentication","title":"Get Vault Forward authentication method","href":"/reference/vault-forwarding/get-vault-forward-authentication"},{"openapi":"openapi.v1.json POST /vault-forward/configs/{config_id}/authentications","sidebarTitle":"Add authentication","title":"Adds new Vault Forward authentication method","href":"/reference/vault-forwarding/add-vault-forward-authentication"},{"openapi":"openapi.v1.json PUT /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Update authentication","title":"Update Vault Forward authentication method","href":"/reference/vault-forwarding/update-vault-forward-authentication"},{"openapi":"openapi.v1.json DELETE /vault-forward/configs/{config_id}/authentications/{authentication_id}","sidebarTitle":"Remove authentication","title":"Remove a Vault Forward authentication method","href":"/reference/vault-forwarding/delete-vault-forward-authentication"}]}]},{"group":"PSPs \u0026 Gateways","icon":"code","pages":[{"group":"All services","pages":[{"openapi":"openapi.v1.json GET /connections","title":"List connections","href":"/reference/connections/list-connections"},{"openapi":"openapi.speakeasy.json GET /connection-definitions","title":null,"href":"/reference/connections/list-connection-definitions"}]},{"group":"Payment services","pages":[{"openapi":"openapi.speakeasy.json GET /payment-service-definitions/{payment_service_definition_id}","sidebarTitle":"Get service definition","title":"Get a payment service definition","href":"/reference/payment-service-definitions/get-payment-service-definition"},{"openapi":"openapi.speakeasy.json GET /payment-services","title":"List payment services","href":"/reference/payment-services/list-payment-services"},{"openapi":"openapi.speakeasy.json POST /payment-services","title":"Configure a payment service","href":"/reference/payment-services/new-payment-service"},{"openapi":"openapi.speakeasy.json GET /payment-services/{payment_service_id}","title":"Get payment service","href":"/reference/payment-services/get-payment-service"},{"openapi":"openapi.speakeasy.json PUT /payment-services/{payment_service_id}","title":"Update a configured payment service","href":"/reference/payment-services/update-payment-service"},{"openapi":"openapi.speakeasy.json DELETE /payment-services/{payment_service_id}","title":"Delete a configured payment service","href":"/reference/payment-services/delete-payment-service"},{"openapi":"openapi.speakeasy.json POST /payment-services/verify","sidebarTitle":"Verify credentials","title":"Verify payment service credentials","href":"/reference/payment-services/verify-payment-service"}]},{"group":"Digital wallets","pages":[{"openapi":"openapi.speakeasy.json GET /digital-wallets","title":"List digital wallets","href":"/reference/digital-wallets/list-digital-wallets"},{"openapi":"openapi.speakeasy.json GET /digital-wallets/{digital_wallet_id}","title":"Get digital wallet","href":"/reference/digital-wallets/get-digital-wallet"},{"openapi":"openapi.speakeasy.json POST /digital-wallets","title":"Register digital wallet","href":"/reference/digital-wallets/register-digital-wallet"},{"openapi":"openapi.speakeasy.json PUT /digital-wallets/{digital_wallet_id}","title":"Update digital wallet","href":"/reference/digital-wallets/update-digital-wallet"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}","title":"Delete digital wallet","href":"/reference/digital-wallets/deregister-digital-wallet"},{"group":"Domain registration","pages":[{"openapi":"openapi.speakeasy.json POST /digital-wallets/{digital_wallet_id}/domains","title":"Register a digital wallet domain","href":"/reference/digital-wallets/new-digital-wallet-domain"},{"openapi":"openapi.speakeasy.json DELETE /digital-wallets/{digital_wallet_id}/domains","title":"Remove a digital wallet domain","href":"/reference/digital-wallets/delete-digital-wallet-domain"}]},{"group":"Mobile Certificates (Apple Pay)","pages":[{"openapi":"openapi.v1.json GET /apple-pay-certificates","sidebarTitle":"List certificates","title":"List Apple Pay certificates","href":"/reference/digital-wallets/list-apple-pay-certificates"},{"openapi":"openapi.v1.json POST /apple-pay-certificates","sidebarTitle":"Create certificate","title":"New Apple Pay certificate","href":"/reference/digital-wallets/create-apple-pay-certificate"},{"openapi":"openapi.v1.json PUT /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Update certificate","title":"Update Apple Pay certificate","href":"/reference/digital-wallets/update-apple-pay-certificate"},{"openapi":"openapi.v1.json DELETE /apple-pay-certificates/{apple_pay_certificate_id}","sidebarTitle":"Delete certificate","title":"Remove Apple Pay certificate","href":"/reference/digital-wallets/delete-apple-pay-certificate"}]}]},{"group":"Anti-fraud services","pages":[{"openapi":"openapi.v1.json GET /anti-fraud-service-definitions/{anti_fraud_service_definition_id}","sidebarTitle":"Get service definition","title":"Get anti fraud service definition","href":"/reference/anti-fraud-services/get-anti-fraud-service-definition"},{"openapi":"openapi.v1.json POST /anti-fraud-services","title":"New anti-fraud service","href":"/reference/anti-fraud-services/new-anti-fraud-service"},{"openapi":"openapi.v1.json GET /anti-fraud-services/{anti_fraud_service_id}","title":"Get anti-fraud service","href":"/reference/anti-fraud-services/get-anti-fraud-service"},{"openapi":"openapi.v1.json PUT /anti-fraud-services/{anti_fraud_service_id}","title":"Update anti-fraud service","href":"/reference/anti-fraud-services/update-anti-fraud-service"},{"openapi":"openapi.v1.json DELETE /anti-fraud-services/{anti_fraud_service_id}","title":"Delete anti-fraud service","href":"/reference/anti-fraud-services/delete-anti-fraud-service"}]},{"group":"Gift-card services","pages":[{"openapi":"openapi.v1.json GET /gift-card-service-definitions/{gift_card_service_definition_id}","sidebarTitle":"Get service definition","title":"Get gift card service definition","href":"/reference/gift-card-services/get-gift-card-service-definition"},{"openapi":"openapi.v1.json POST /gift-card-services","title":"New gift card service","href":"/reference/gift-card-services/new-gift-card-service"},{"openapi":"openapi.v1.json GET /gift-card-services/{gift_card_service_id}","title":"Get gift card service","href":"/reference/gift-card-services/get-gift-card-service"},{"openapi":"openapi.v1.json PUT /gift-card-services/{gift_card_service_id}","title":"Update gift card service","href":"/reference/gift-card-services/update-gift-card-service"},{"openapi":"openapi.v1.json DELETE /gift-card-services/{gift_card_service_id}","title":"Delete gift card service","href":"/reference/gift-card-services/delete-gift-card-service"}]}]},{"group":"Errors","icon":"code","pages":[{"title":"Client-side errors (4XX)","sidebarTitle":"Client errors","href":"/reference/errors/client-errors"},{"title":"Server-side errors (5XX)","sidebarTitle":"Server errors","href":"/reference/errors/server-errors"},{"openapi":"openapi.v1.json GET /api-logs","title":"List 4XX errors","href":"/reference/logs/list-api-error-logs"}]},{"group":"Other","icon":"code","pages":[{"group":"API keys","pages":[{"openapi":"openapi.speakeasy.json GET /api-key-pairs","sidebarTitle":"List API keys","title":"List all API key pairs","href":"/reference/api-key-pairs/list-api-key-pairs"},{"openapi":"openapi.speakeasy.json POST /api-key-pairs","sidebarTitle":"Create API key","title":"Create an API key pair","href":"/reference/api-key-pairs/new-api-key-pair"},{"openapi":"openapi.speakeasy.json GET /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Get API key","title":"Get an API key pair","href":"/reference/api-key-pairs/get-api-key-pair"},{"openapi":"openapi.speakeasy.json PUT /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Update API key","title":"Update an API key pair","href":"/reference/api-key-pairs/update-api-key-pair"},{"openapi":"openapi.speakeasy.json DELETE /api-key-pairs/{api_key_pair_id}","sidebarTitle":"Delete API key","title":"Delete an API key pair","href":"/reference/api-key-pairs/delete-api-key-pair"}]},{"group":"3DS Configuration","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"List 3DS configuration","sidebarTitle":"List 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/list-three-ds-configurations"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts/{merchant_account_id}/three-ds-configurations","title":"Add 3DS configuration","sidebarTitle":"Add 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/new-three-ds-configuration"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Update 3DS configuration","sidebarTitle":"Update 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/update-three-ds-configuration"},{"openapi":"openapi.speakeasy.json DELETE /merchant-accounts/{merchant_account_id}/three-ds-configurations/{three_ds_configuration_id}","title":"Delete 3DS configuration","sidebarTitle":"Delete 3DS configuration","href":"/reference/merchant-accounts/three-ds-configurations/delete-three-ds-configuration"}]},{"group":"3DS Scenarios","pages":[{"openapi":"openapi.speakeasy.json GET /three-ds-scenarios","title":"List 3DS scenario","href":"/reference/three-ds-scenarios/list-three-ds-scenarios"},{"openapi":"openapi.speakeasy.json POST /three-ds-scenarios","title":"Create a 3DS scenario","href":"/reference/three-ds-scenarios/new-three-ds-scenario"},{"openapi":"openapi.speakeasy.json PUT /three-ds-scenarios/{three_ds_scenario_id}","title":"Update a 3DS scenario","href":"/reference/three-ds-scenarios/update-three-ds-scenario"},{"openapi":"openapi.speakeasy.json DELETE /three-ds-scenarios/{three_ds_scenario_id}","title":"Delete a 3DS scenario","href":"/reference/three-ds-scenarios/delete-three-ds-scenario"}]},{"group":"Flow","pages":[{"openapi":"openapi.v1.json GET /flows/{flow}","title":"List flow rules","href":"/reference/flow/list-rules"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Get rule","href":"/reference/flow/get-rule"},{"openapi":"openapi.v1.json POST /flows/{flow}/actions/{action}/rules","title":"Create flow rule","href":"/reference/flow/new-rule"},{"openapi":"openapi.v1.json PUT /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Update flow rule","href":"/reference/flow/update-rule"},{"openapi":"openapi.v1.json DELETE /flows/{flow}/actions/{action}/rules/{rule_id}","title":"Delete flow rule","href":"/reference/flow/delete-rule"},{"openapi":"openapi.v1.json GET /flows/{flow}/actions/{action}/outcomes","title":"List flow outcomes","href":"/reference/flow/list-outcomes"}]},{"group":"Merchant accounts","pages":[{"openapi":"openapi.speakeasy.json GET /merchant-accounts","title":"List all merchant accounts","href":"/reference/merchant-accounts/list-merchant-accounts"},{"openapi":"openapi.speakeasy.json POST /merchant-accounts","title":"Create a merchant account","href":"/reference/merchant-accounts/new-merchant-account"},{"openapi":"openapi.speakeasy.json PUT /merchant-accounts/{merchant_account_id}","title":"Update a merchant account","href":"/reference/merchant-accounts/update-merchant-account"}]},{"group":"Reports","pages":[{"openapi":"openapi.speakeasy.json GET /reports","title":"List configured reports","href":"/reference/reports/list-reports"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}","title":"Get a report","href":"/reference/reports/get-report"},{"openapi":"openapi.speakeasy.json POST /reports","title":"Add a report","href":"/reference/reports/new-report"},{"openapi":"openapi.speakeasy.json PUT /reports/{report_id}","title":"Update a report","href":"/reference/reports/update-report"}]},{"group":"Report executions","pages":[{"openapi":"openapi.speakeasy.json GET /report-executions","title":"List executed reports","href":"/reference/reports/list-all-report-executions"},{"openapi":"openapi.speakeasy.json GET /reports/{report_id}/executions","title":"List executions for report","href":"/reference/reports/list-executions-for-report"},{"openapi":"openapi.speakeasy.json GET /report-executions/{report_execution_id}","title":"Get executed report","href":"/reference/reports/get-report-execution"},{"openapi":"openapi.speakeasy.json POST /reports/{report_id}/executions/{report_execution_id}/url","title":"Create URL for executed report","href":"/reference/reports/generate-download-url"}]},{"group":"Roles","pages":[{"openapi":"openapi.speakeasy.json GET /roles","sidebarTitle":"List roles","title":"List all roles","href":"/reference/roles/list-roles"}]},{"group":"Users","pages":[{"openapi":"openapi.speakeasy.json GET /audit-logs","title":"List audit log entries","href":"/reference/audit-logs/list-audit-logs"}]},{"group":"Webhook subscriptions","pages":[{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions","sidebarTitle":"List subscriptions","title":"List webhook subscriptions","href":"/reference/webhook-subscriptions/list-webhook-subscriptions"},{"openapi":"openapi.speakeasy.json POST /webhook-subscriptions","sidebarTitle":"New subscription","title":"Create webhook subscription","href":"/reference/webhook-subscriptions/new-webhook-subscription"},{"openapi":"openapi.speakeasy.json GET /webhook-subscriptions/{subscription_id}","sidebarTitle":"Get subscription","title":"Get webhook subscription","href":"/reference/webhook-subscriptions/get-webhook-subscription"},{"openapi":"openapi.speakeasy.json PUT /webhook-subscriptions/{subscription_id}","sidebarTitle":"Update subscription","title":"Update webhook subscription","href":"/reference/webhook-subscriptions/update-webhook-subscription"},{"openapi":"openapi.speakeasy.json DELETE /webhook-subscriptions/{subscription_id}","sidebarTitle":"Delete subscription","title":"Delete webhook subscription","href":"/reference/webhook-subscriptions/delete-webhook-subscription"}]}]}]},{"tab":"Updates","icon":"bullhorn","pages":[{"title":"Updates","href":"/updates"}]}]},"title":"Create checkout session - Gr4vy","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}