Cancels a specific subscription. If a restore_at value is provided, the subscription will be effectively “paused” until that date when it will automatically renew.
The strategy to use when canceling this subscription – one of immediate or pending. If no value is provided, the subscription protocol cancel_behavior will be be used.
If the subscription is set to cancel at the end of the current period. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
The time at which this subscription will automatically be restored. This can only be set if the subscription is canceled or set to cancel at period end.
Whether installment subscriptions should be automatically restarted when they reach the completed state. When the subscription is created, this value will be inherited from the price restart_subscription_on_completed value.
Whether or not tax is enabled for this subscription. This will default to the account's tax_protocol.tax_enabled value when the subscription is created.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
End of the current period that the subscription is in. At the end of this period, a new period will be created. This will be null when the subscription has a one-time price.
Time at which the object was last updated. Measured in seconds since the Unix epoch.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SureCart","colors":{"primary":"#00824c","light":"#00824c","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/surecart/ETeQN6deVZFb6K1z/logo/surecart-logo-light.svg?fit=max\u0026auto=format\u0026n=ETeQN6deVZFb6K1z\u0026q=85\u0026s=38315d1a606d0a91773837ea01e08a74","dark":"https://mintcdn.com/surecart/ETeQN6deVZFb6K1z/logo/surecart-logo-dark.svg?fit=max\u0026auto=format\u0026n=ETeQN6deVZFb6K1z\u0026q=85\u0026s=d0dc62ee850e0e69d81395b283b6c338"},"favicon":"https://mintcdn.com/surecart/jHwrSAqAc4o_umB5/favicon.png?fit=max\u0026auto=format\u0026n=jHwrSAqAc4o_umB5\u0026q=85\u0026s=8f5e1bed5ef79ba47647c500fedaadb1","footer":{"socials":{"facebook":"https://www.facebook.com/my.surecart","x":"https://x.com/my_surecart","youtube":"https://www.youtube.com/@SureCartOfficial","linkedin":"https://www.linkedin.com/company/surecart"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"surecart","hasAudioNarration":false,"actualSubdomain":"surecart","customDomains":["developer.surecart.com"],"gitSource":{"type":"github","owner":"surecart","repo":"surecart-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad5e94203b76e0d8ece5922","collectionId":"1b72b928-4602-4933-96d8-3dfafcb11a67","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5e94203b76e0d8ece5922"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad5e94203b76e0d8ece5922","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":429},{"language":"default","tag":"Products","count":106},{"language":"default","tag":"Orders \u0026 Payments","count":86},{"language":"default","tag":"Shipping \u0026 Fulfillment","count":62},{"language":"default","tag":"Core Endpoints","count":48},{"language":"default","tag":"Affiliates","count":42},{"language":"default","tag":"Customers","count":39},{"language":"default","tag":"Subscriptions","count":36},{"language":"default","tag":"Documentation","count":28},{"language":"default","tag":"Extending","count":20}]},"assistantConfig":{},"basePath":"","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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".prose :where(h1):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:800;font-size:2.25em;margin-top:2.5em;margin-bottom:.8888889em;line-height:1.1111111}.prose :where(h1 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:900;color:inherit}.prose :where(h2):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:700;font-size:1.5em;margin-top:4em;margin-bottom:.6666666666666666em;line-height:1.3333333}.prose :where(h2 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:800;color:inherit}.prose :where(h3):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:600;font-size:1.25em;margin-top:2.4em;margin-bottom:.6em;line-height:1.4}.prose :where(h3 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:700;color:inherit}.prose :where(h4):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:var(--tw-prose-headings);font-weight:600;margin-top:2em;margin-bottom:.5em;line-height:1.5;font-size:1.125em}.prose :where(h4 strong):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){font-weight:700;color:inherit}"}],"page":{"pagePath":"api-reference/subscriptions/cancelpause","slug":"/api-reference/subscriptions/cancelpause","pageMetadata":{"title":"Cancel/Pause","description":"Cancels a specific subscription. If a `restore_at` value is provided, the subscription will be effectively \"paused\" until that date when it will automatically renew.","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancelpause","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Cancels a specific subscription. If a \", _jsx(_components.code, {\n children: \"restore_at\"\n }), \" value is provided, the subscription will be effectively “paused” until that date when it will automatically renew.\"]\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"config":{},"pageMetadata":{"title":"Cancel/Pause","description":"Cancels a specific subscription. If a `restore_at` value is provided, the subscription will be effectively \"paused\" until that date when it will automatically renew.","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancelpause","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Cancel/Pause","tags":["Subscriptions"],"operationId":"cancel/pause_subscription","description":"Cancels a specific subscription. If a `restore_at` value is provided, the subscription will be effectively \"paused\" until that date when it will automatically renew.","parameters":["717d8053-a0bb-4b15-8fdd-60cc7f09cefa","92c2e072-73eb-4874-a2fa-2064afe37949","8bf73f98-8577-40d5-a0f6-813c895cc853"],"responses":{"200":"418542a6-a597-44d2-8c78-c5405011ae02"},"requestBody":"332f95c4-64c8-4519-8544-cad93a94a947","method":"patch","type":"path","servers":["0d4fcd2d-651c-42a5-a696-14d1bb02e291"],"security":["f4a9acc0-f626-41c8-bade-ae8daf7233ea"],"path":"/v1/subscriptions/{id}/cancel","baseUrlOptions":["https://{defaultHost}"],"title":"Cancel/Pause","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"717d8053-a0bb-4b15-8fdd-60cc7f09cefa":{"name":"cancel_behavior","in":"query","description":"The strategy to use when canceling this subscription – one of `immediate` or `pending`. If no value is provided, the subscription protocol `cancel_behavior` will be be used.","required":false,"schema":{"type":"string","isRequired":false,"description":"The strategy to use when canceling this subscription – one of `immediate` or `pending`. If no value is provided, the subscription protocol `cancel_behavior` will be be used.","uniqueKey":"","typeLabel":"string"}},"92c2e072-73eb-4874-a2fa-2064afe37949":{"name":"cancellation_act[cancellation_reason_id]","in":"query","description":"The cancellation reason that should be set on the cancellation act when the subscription is canceled or preserved.","required":false,"schema":{"type":"string","isRequired":false,"description":"The cancellation reason that should be set on the cancellation act when the subscription is canceled or preserved.","uniqueKey":"","typeLabel":"string"}},"8bf73f98-8577-40d5-a0f6-813c895cc853":{"name":"cancellation_act[comment]","in":"query","description":"The comment that should be set on the cancellation act when the subscription is canceled or preserved.","required":false,"schema":{"type":"string","isRequired":false,"description":"The comment that should be set on the cancellation act when the subscription is canceled or preserved.","uniqueKey":"","typeLabel":"string"}},"946d791e-615d-46a4-b512-a4a49d1041e0":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"type":"object","properties":{"restore_at":{"oneOf":[{"type":"integer","description":"The time at which this subscription will automatically be restored. This can only be set if the subscription is canceled or set to cancel at period end.","uniqueKey":"subscription.restore_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which this subscription will automatically be restored. This can only be set if the subscription is canceled or set to cancel at period end.","uniqueKey":"subscription.restore_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscription.restore_at","typeLabel":"integer | null"}},"uniqueKey":"subscription","typeLabel":"object"}},"example":{"subscription":{"restore_at":"2026-12-19 09:16:40 UTC"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"subscription":{"restore_at":"2026-12-19 09:16:40 UTC"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"418542a6-a597-44d2-8c78-c5405011ae02":{"description":"Success","content":{"application/json":{"example":{"id":"18bf5f94-14f3-4d95-84af-f1f2a05d5837","object":"subscription","ad_hoc_amount":null,"affiliation_expires_at":null,"cancel_at_period_end":true,"currency":"usd","current_period_end_at":1795079800,"current_period_start_at":1792401400,"ended_at":null,"finite":false,"last_renewal_reminder_sent_at":null,"live_mode":true,"manual_payment":false,"metadata":{},"pending_update":{},"price_readonly":false,"portal_url":"http://app.example.com/portal_redirect/subscriptions/18bf5f94-14f3-4d95-84af-f1f2a05d5837","quantity":1,"remaining_period_count":null,"restart_on_completed":false,"restore_at":1797671800,"subtotal_amount":2900,"status":"active","tax_enabled":false,"trial_end_at":null,"trial_start_at":null,"variant_options":null,"affiliation":null,"current_cancellation_act":"637c113b-68d5-4b4a-9a7a-f0125086cc97","current_period":"cc465ce1-8457-4756-8ebc-348c657a61ac","customer":"451a1b48-35dd-47d6-bd04-61e072a7e796","discount":null,"manual_payment_method":null,"payment_method":"c5d1b8de-f81e-4795-b5b9-2978ecabf4d0","price":"8f0c0f08-d46b-4bec-a299-aca8de0fb9aa","purchase":"7f30a475-128b-4058-95f3-7f88a6ce5e68","shipping_method":null,"variant":null,"created_at":1792401400,"updated_at":1792401400},"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"object","typeLabel":"string"},"ad_hoc_amount":{"oneOf":[{"type":"integer","description":"The amount to use for this subscription when the associated price is `ad_hoc=true`.","uniqueKey":"ad_hoc_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount to use for this subscription when the associated price is `ad_hoc=true`.","uniqueKey":"ad_hoc_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"ad_hoc_amount","typeLabel":"integer | null"},"affiliation_expires_at":{"oneOf":[{"type":"integer","description":"Time at which the affiliation will expire.","uniqueKey":"affiliation_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the affiliation will expire.","uniqueKey":"affiliation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"affiliation_expires_at","typeLabel":"integer | null"},"cancel_at_period_end":{"type":"boolean","description":"If the subscription is set to cancel at the end of the current period. You can use this attribute to determine whether a subscription that has a `status` of `active` is scheduled to be canceled at the end of the current period.","uniqueKey":"cancel_at_period_end","typeLabel":"boolean"},"live_mode":{"type":"boolean","description":"Set to `true` if this subscription is in live mode, and set to `false` if it is in test mode.","uniqueKey":"live_mode","typeLabel":"boolean"},"manual_payment":{"type":"boolean","description":"Whether or not this subscription should finalize checkouts during renewal with the `manual_payment=true` option.","uniqueKey":"manual_payment","typeLabel":"boolean"},"quantity":{"type":"integer","description":"The quantity of products being purchased.","uniqueKey":"quantity","typeLabel":"integer"},"restore_at":{"oneOf":[{"type":"integer","description":"The time at which this subscription will automatically be restored. This can only be set if the subscription is canceled or set to cancel at period end.","uniqueKey":"restore_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which this subscription will automatically be restored. This can only be set if the subscription is canceled or set to cancel at period end.","uniqueKey":"restore_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"restore_at","typeLabel":"integer | null"},"restart_on_completed":{"type":"boolean","description":"Whether installment subscriptions should be automatically restarted when they reach the completed state. When the subscription is created, this value will be inherited from the price `restart_subscription_on_completed` value.","uniqueKey":"restart_on_completed","typeLabel":"boolean"},"tax_enabled":{"type":"boolean","description":"Whether or not tax is enabled for this subscription. This will default to the account's `tax_protocol.tax_enabled` value when the subscription is created.","uniqueKey":"tax_enabled","typeLabel":"boolean"},"trial_end_at":{"oneOf":[{"type":"integer","description":"If the subscription has a trial, the end of that trial.","uniqueKey":"trial_end_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"If the subscription has a trial, the end of that trial.","uniqueKey":"trial_end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"trial_end_at","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"metadata","typeLabel":"object"},"current_period_end_at":{"oneOf":[{"type":"integer","description":"End of the current period that the subscription is in. At the end of this period, a new period will be created. This will be `null` when the subscription has a one-time price.","uniqueKey":"current_period_end_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"End of the current period that the subscription is in. At the end of this period, a new period will be created. This will be `null` when the subscription has a one-time price.","uniqueKey":"current_period_end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period_end_at","typeLabel":"integer | null"},"current_period_start_at":{"oneOf":[{"type":"integer","description":"Start of the current period that the subscription is in.","uniqueKey":"current_period_start_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Start of the current period that the subscription is in.","uniqueKey":"current_period_start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period_start_at","typeLabel":"integer | null"},"ended_at":{"oneOf":[{"type":"integer","description":"If the subscription has ended, the date the subscription ended.","uniqueKey":"ended_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"If the subscription has ended, the date the subscription ended.","uniqueKey":"ended_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"ended_at","typeLabel":"integer | null"},"finite":{"type":"boolean","description":"Whether or not this subscription belongs to a price with a set `recurring_period_count`, meaning it has a defined end.","uniqueKey":"finite","typeLabel":"boolean"},"last_renewal_reminder_sent_at":{"oneOf":[{"type":"integer","description":"Time at which the last renewal reminder notification sent. Measured in seconds since the Unix epoch.","uniqueKey":"last_renewal_reminder_sent_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the last renewal reminder notification sent. Measured in seconds since the Unix epoch.","uniqueKey":"last_renewal_reminder_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_renewal_reminder_sent_at","typeLabel":"integer | null"},"pending_update":{"type":"object","properties":{"price":{"type":"string","description":"The UUID of the price this subscription will be updated to at the end of the current period.","uniqueKey":"pending_update.price","typeLabel":"string"},"quantity":{"type":"integer","description":"The quantity of products being purchased at the end of the current period.","uniqueKey":"pending_update.quantity","typeLabel":"integer"}},"uniqueKey":"pending_update","typeLabel":"object"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this subscription's correct portal page (hosted or external).","uniqueKey":"portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this subscription's correct portal page (hosted or external).","uniqueKey":"portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"portal_url","typeLabel":"string | null"},"price_readonly":{"type":"boolean","description":"Whether or not the price of this subscription can be modified. If `true`, the price is locked and cannot be changed","uniqueKey":"price_readonly","typeLabel":"boolean"},"remaining_period_count":{"oneOf":[{"type":"integer","description":"The number of periods remaining before this subscription ends. This count is reduced when a period is paid.","uniqueKey":"remaining_period_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of periods remaining before this subscription ends. This count is reduced when a period is paid.","uniqueKey":"remaining_period_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"remaining_period_count","typeLabel":"integer | null"},"subtotal_amount":{"type":"integer","description":"Total of the subscription before discounts or taxes are applied.","uniqueKey":"subtotal_amount","typeLabel":"integer"},"status":{"type":"string","description":"The current status of this subscription, which can be one of `incomplete`, `trialing`, `active`, `past_due`, `canceled`, or `completed`.","uniqueKey":"status","typeLabel":"string"},"affiliation":{"oneOf":[{"type":"object","description":"The affiliation associated with this subscription.","uniqueKey":"affiliation.oneOf.0","typeLabel":"object"},{"type":"null","description":"The affiliation associated with this subscription.","uniqueKey":"affiliation.oneOf.1","typeLabel":"null"}],"uniqueKey":"affiliation","typeLabel":"object | null"},"current_cancellation_act":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated cancellation act ID.","uniqueKey":"current_cancellation_act.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated cancellation act object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_cancellation_act.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_cancellation_act.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_cancellation_act.oneOf.1.object","typeLabel":"string"},"comment":{"oneOf":[{"type":"string","description":"The comment left by the customer when they canceled the subscription.","uniqueKey":"current_cancellation_act.oneOf.1.comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The comment left by the customer when they canceled the subscription.","uniqueKey":"current_cancellation_act.oneOf.1.comment.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.comment","typeLabel":"string | null"},"coupon_applied":{"type":"boolean","description":"Whether or not the preservation coupon was applied to the subscription when it was preserved.","uniqueKey":"current_cancellation_act.oneOf.1.coupon_applied","typeLabel":"boolean"},"performed_at":{"type":"integer","description":"Time at which the cancellation act was performed. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.performed_at","typeLabel":"integer"},"preserved":{"type":"boolean","description":"Whether or not this subscription was preserved when the customer went to cancel it.","uniqueKey":"current_cancellation_act.oneOf.1.preserved","typeLabel":"boolean"},"cancellation_reason":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated cancellation reason ID.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated cancellation reason object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this cancellation reason is archived.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.archived","typeLabel":"boolean"},"comment_enabled":{"type":"boolean","description":"Whether or not this cancellation reason should prompt the user for a comment.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.comment_enabled","typeLabel":"boolean"},"comment_prompt":{"oneOf":[{"type":"string","description":"A breif customer-facing prompt for more detail that will be shown when this cancellation reason is selected.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.comment_prompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"A breif customer-facing prompt for more detail that will be shown when this cancellation reason is selected.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.comment_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.comment_prompt","typeLabel":"string | null"},"coupon_enabled":{"type":"boolean","description":"Whether or not this cancellation reason should offer the `subscription_protocol.cancellation_prevention_coupon` to the customer to preserve the subscription.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.coupon_enabled","typeLabel":"boolean"},"label":{"type":"string","description":"The customer-facing label for this cancellation reason.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.label","typeLabel":"string"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this cancellation reason when displayed to customers.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this cancellation reason when displayed to customers.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.position","typeLabel":"integer | null"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.archived_at","typeLabel":"integer | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason.oneOf.1","typeLabel":"object"}],"uniqueKey":"current_cancellation_act.oneOf.1.cancellation_reason","typeLabel":"string | object"},"subscription":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated subscription ID.","uniqueKey":"current_cancellation_act.oneOf.1.subscription.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated subscription object.","uniqueKey":"current_cancellation_act.oneOf.1.subscription.oneOf.1","typeLabel":"any"}],"uniqueKey":"current_cancellation_act.oneOf.1.subscription","typeLabel":"string | any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_cancellation_act.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_cancellation_act.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_cancellation_act.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_cancellation_act.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_cancellation_act","typeLabel":"string | object | null"},"current_period":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated period ID.","uniqueKey":"current_period.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated period object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.object","typeLabel":"string"},"end_at":{"oneOf":[{"type":"integer","description":"End of the period. This will be `null` when the period is for a subscription with a one-time price.","uniqueKey":"current_period.oneOf.1.end_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"End of the period. This will be `null` when the period is for a subscription with a one-time price.","uniqueKey":"current_period.oneOf.1.end_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.end_at","typeLabel":"integer | null"},"ad_hoc_amount":{"oneOf":[{"type":"integer","description":"The amount to use for this period when the associated price is `ad_hoc=true`.","uniqueKey":"current_period.oneOf.1.ad_hoc_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount to use for this period when the associated price is `ad_hoc=true`.","uniqueKey":"current_period.oneOf.1.ad_hoc_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.ad_hoc_amount","typeLabel":"integer | null"},"next_payment_retry_at":{"oneOf":[{"type":"integer","description":"The time at which payment will be automatically retried.","uniqueKey":"current_period.oneOf.1.next_payment_retry_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which payment will be automatically retried.","uniqueKey":"current_period.oneOf.1.next_payment_retry_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.next_payment_retry_at","typeLabel":"integer | null"},"payment_retry_count":{"type":"integer","description":"Number of payment retries made for this period, from the perspective of the payment retry schedule. Only automatic retries increment the count.","uniqueKey":"current_period.oneOf.1.payment_retry_count","typeLabel":"integer"},"payoff":{"type":"boolean","description":"Indicates whether or not this period paid off all remaining periods.","uniqueKey":"current_period.oneOf.1.payoff","typeLabel":"boolean"},"quantity":{"type":"integer","description":"The quantity of products being purchased.","uniqueKey":"current_period.oneOf.1.quantity","typeLabel":"integer"},"renewal":{"type":"boolean","description":"Whether or not this period has been generated automatically for a subscription renewal.","uniqueKey":"current_period.oneOf.1.renewal","typeLabel":"boolean"},"renewal_reminder_sent_at":{"oneOf":[{"type":"integer","description":"The time at which the renewal reminder notification was sent to the customer.","uniqueKey":"current_period.oneOf.1.renewal_reminder_sent_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the renewal reminder notification was sent to the customer.","uniqueKey":"current_period.oneOf.1.renewal_reminder_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.renewal_reminder_sent_at","typeLabel":"integer | null"},"restoral":{"type":"boolean","description":"Whether or not this period was generated from a subscription restoral.","uniqueKey":"current_period.oneOf.1.restoral","typeLabel":"boolean"},"skip_proration":{"type":"boolean","description":"Whether or not proration should be skipped when generating this period's checkout.","uniqueKey":"current_period.oneOf.1.skip_proration","typeLabel":"boolean"},"start_at":{"oneOf":[{"type":"integer","description":"Start of the period.","uniqueKey":"current_period.oneOf.1.start_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Start of the period.","uniqueKey":"current_period.oneOf.1.start_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.start_at","typeLabel":"integer | null"},"status":{"type":"string","description":"The current status of this period, which can be one of `pending`, `payment_failed`, `paid`, `processing`, or `void`.","uniqueKey":"current_period.oneOf.1.status","typeLabel":"string"},"checkout":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated checkout ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated checkout object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.object","typeLabel":"string"},"abandoned_checkout_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true` abandonded checkout reminder emails will be sent to the customer.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.abandoned_checkout_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true` abandonded checkout reminder emails will be sent to the customer.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.abandoned_checkout_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.abandoned_checkout_enabled","typeLabel":"boolean | null"},"billing_matches_shipping":{"type":"boolean","description":"If set to `true` the shipping address will be used for the billing address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_matches_shipping","typeLabel":"boolean"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.currency","typeLabel":"string"},"email":{"oneOf":[{"type":"string","description":"The email of the customer. If customers exists with this email, the most recently active/updated customer will be associated. If no customers exist with this email, a new customer will be created. If a `customer_id` is also passed then this will take precedence and the customer will not be looked up by email.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The email of the customer. If customers exists with this email, the most recently active/updated customer will be associated. If no customers exist with this email, a new customer will be created. If a `customer_id` is also passed then this will take precedence and the customer will not be looked up by email.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.email","typeLabel":"string | null"},"external_url":{"oneOf":[{"type":"string","description":"If set, this URL will be used whenever redirecting to the external checkout portal. If not set, the default `external_url` from the `CheckoutPortalProtocol` will be used.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.external_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"If set, this URL will be used whenever redirecting to the external checkout portal. If not set, the default `external_url` from the `CheckoutPortalProtocol` will be used.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.external_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.external_url","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The customer’s first name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s first name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.first_name","typeLabel":"string | null"},"ip_address":{"oneOf":[{"type":"string","description":"The IP address of the customer for this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"The IP address of the customer for this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_address","typeLabel":"string | null"},"group_key":{"oneOf":[{"type":"string","description":"A key used to retrieve groups of checkouts dynamically from a static string.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.group_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"A key used to retrieve groups of checkouts dynamically from a static string.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.group_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.group_key","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The customer’s last name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s last name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_name","typeLabel":"string | null"},"latitude":{"oneOf":[{"type":"number","description":"The latitude captured for this checkout, in decimal degrees.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.latitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"The latitude captured for this checkout, in decimal degrees.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.latitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.latitude","typeLabel":"number | null"},"longitude":{"oneOf":[{"type":"number","description":"The longitude captured for this checkout, in decimal degrees.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.longitude.oneOf.0","typeLabel":"number"},{"type":"null","description":"The longitude captured for this checkout, in decimal degrees.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.longitude.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.longitude","typeLabel":"number | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this checkout is in live mode, and set to `false` if it is in test mode.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.live_mode","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.name","typeLabel":"string | null"},"tax_behavior":{"type":"string","description":"The tax behavior for this checkout. One of `exclusive` or `inclusive`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_behavior","typeLabel":"string"},"tax_enabled":{"type":"boolean","description":"Whether or not tax is enabled for this checkout. This will default to the account's `tax_protocol.tax_enabled` value when the checkout is created.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_enabled","typeLabel":"boolean"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.metadata","typeLabel":"object"},"amount_due":{"type":"integer","description":"Total amount due after all adjustments (i.e. trials, credits, proration).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.amount_due","typeLabel":"integer"},"applied_balance_amount":{"type":"integer","description":"The customer balance amount that was applied to this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.applied_balance_amount","typeLabel":"integer"},"available_countries":{"type":"array","description":"A list of countries available for this checkout, represented in the two-letter (ISO 3166-1 alpha-2) format.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.available_countries","typeLabel":"array"},"billing_address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.billing_address","typeLabel":"string | object | null"},"charges":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated charge objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.charges","typeLabel":"string | object | null"},"checkout_fees":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated checkout fee objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees","typeLabel":"string | object | null"},"checkout_fees_amount":{"type":"integer","description":"The total amount of checkout fees applied to this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.checkout_fees_amount","typeLabel":"integer"},"credited_balance_amount":{"type":"integer","description":"The amount the customer's balance was credited from this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.credited_balance_amount","typeLabel":"integer"},"current_payment_intent":{"oneOf":[{"type":"string","description":"The current payment intent to be used to pay the checkout. (This will only be set once the checkout has been finalized.)\n\n[Expandable](/api-reference/expanding-responses) – The associated payment intent ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.0","typeLabel":"string"},{"type":"object","description":"The current payment intent to be used to pay the checkout. (This will only be set once the checkout has been finalized.)\n\n[Expanded](/api-reference/expanding-responses) – The associated payment intent object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.object","typeLabel":"string"},"amount":{"type":"integer","description":"The amount intended to be collected by this payment intent.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.amount","typeLabel":"integer"},"payment_method_type":{"type":"string","description":"The payment method type to use for this payment intent. This is only applicable for `mollie` processors.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.payment_method_type","typeLabel":"string"},"return_url":{"type":"string","description":"The URL the customer will be redirected to after the payment process. This is only applicable for `mollie` processors.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.return_url","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Set to `true` if this checkout is in live mode, and set to `false` if it is in test mode.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.live_mode","typeLabel":"boolean"},"processor_type":{"type":"string","description":"The processor being used for this checkout. The only allowed processors right now are `stripe` and `paypal`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.processor_type","typeLabel":"string"},"checkout":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.checkout.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.checkout.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.checkout","typeLabel":"any | null"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.currency","typeLabel":"string"},"customer":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.customer.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.customer","typeLabel":"any | null"},"external_intent_id":{"type":"string","description":"The external ID necessary to capture payment through this processor. For example, if processing through Stripe, the `external_intent_id` will be set to the `Stripe::PaymentIntent` ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.external_intent_id","typeLabel":"string"},"off_session":{"type":"boolean","description":"Set to true to indicate that the customer is not in the checkout flow during the payment attempt. When `off_session=true` payment collection will be attempted immediately.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.off_session","typeLabel":"boolean"},"payment_method":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.payment_method.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.payment_method","typeLabel":"any | null"},"platform_fee":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.platform_fee.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.platform_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.platform_fee","typeLabel":"any | null"},"processor_data":{"type":"object","description":"All of the additional data necessary to capture payment with this processor.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.processor_data","typeLabel":"object"},"reusable":{"type":"boolean","description":"Whether or not the payment method that is generated from this payment intent should be reusable or not.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.reusable","typeLabel":"boolean"},"service_fee":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.service_fee.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.service_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.service_fee","typeLabel":"any | null"},"status":{"type":"string","description":"The status of this payment intent, one of `pending`, `canceled`, `failed`, `processing`, `requires_action`, `requires_capture`, or `succeeded`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.status","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_payment_intent","typeLabel":"string | object | null"},"current_upsell":{"oneOf":[{"type":"string","description":"The upsell to be shown to the customer. (This will only be set once the checkout has been paid and an upsell funnel is set on the checkout.)\n\n[Expandable](/api-reference/expanding-responses) – The associated upsell ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.0","typeLabel":"string"},{"type":"object","description":"The upsell to be shown to the customer. (This will only be set once the checkout has been paid and an upsell funnel is set on the checkout.)\n\n[Expanded](/api-reference/expanding-responses) – The associated upsell object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.object","typeLabel":"string"},"amount_off":{"oneOf":[{"type":"integer","description":"Amount (in the `currency` of the price) that will be taken off line items associated with this upsell.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.amount_off.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount (in the `currency` of the price) that will be taken off line items associated with this upsell.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.amount_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.amount_off","typeLabel":"integer | null"},"duplicate_purchase_behavior":{"type":"string","description":"How to handle duplicate purchases of the product – can be one of `allow`, `block_within_checkout`, or `block`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.duplicate_purchase_behavior","typeLabel":"string"},"fee_description":{"type":"string","description":"The description for this upsell which will be visible to customers.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.fee_description","typeLabel":"string"},"percent_off":{"oneOf":[{"type":"number","description":"Percent that will be taken off line items associated with this upsell.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.percent_off.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percent that will be taken off line items associated with this upsell.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.percent_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.percent_off","typeLabel":"number | null"},"replacement_behavior":{"type":"string","description":"Whether or not to replace line items in the associated checkout. Replacement occurs when a line item is upsold. Possible values include:\n- `none` (default): No line items will be replaced.\n- `all`: All line items will be replaced.\n","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.replacement_behavior","typeLabel":"string"},"step":{"type":"string","description":"Where this upsell falls in position within the upsell funnel – can be one of `initial`, `accepted`, or `declined`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.step","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.metadata","typeLabel":"object"},"price":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.price","typeLabel":"any"},"upsell_funnel":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.upsell_funnel","typeLabel":"any"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.current_upsell","typeLabel":"string | object | null"},"customer":{"oneOf":[{"type":"string","description":"The customer will only be set once the checkout has been finalized.\n\n[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"The customer will only be set once the checkout has been finalized.\n\n[Expanded](/api-reference/expanding-responses) – The associated customer object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.object","typeLabel":"string"},"affiliation_expires_at":{"oneOf":[{"type":"integer","description":"Time at which the affiliation will expire.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.affiliation_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the affiliation will expire.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.affiliation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.affiliation_expires_at","typeLabel":"integer | null"},"billing_matches_shipping":{"type":"boolean","description":"If set to `true` the shipping address will be used for the billing address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.billing_matches_shipping","typeLabel":"boolean"},"email":{"type":"string","description":"The customer’s email address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","description":"The customer’s first name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s first name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this customer is in live mode, and set to `false` if it is in test mode.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.live_mode","typeLabel":"boolean"},"last_name":{"oneOf":[{"type":"string","description":"The customer’s last name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s last name.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The customer’s phone number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s phone number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.phone","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"Whether or not tax should be calculated for checkouts associated with this customer.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.tax_enabled","typeLabel":"boolean"},"unsubscribed":{"type":"boolean","description":"Set to `true` if this customer has unsubscribed from from opt-in emails (i.e. abandoned cart emails).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.unsubscribed","typeLabel":"boolean"},"indexed":{"type":"boolean","description":"Whether or not this customer is included in the `/customers` list endpoint. Only customers that have been manually created or have a purchase are indexed.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.indexed","typeLabel":"boolean"},"affiliation":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.affiliation.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.affiliation.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.affiliation","typeLabel":"any | null"},"balances":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.balances.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.balances.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.balances","typeLabel":"any | null"},"billing_address":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.billing_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.billing_address","typeLabel":"any | null"},"default_payment_method":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.default_payment_method","typeLabel":"any | null"},"default_saved_list":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.default_saved_list","typeLabel":"any | null"},"saved_lists":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.saved_lists.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.saved_lists","typeLabel":"any | null"},"licenses":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.licenses.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.licenses.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.licenses","typeLabel":"any | null"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this customer's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this customer's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.portal_url","typeLabel":"string | null"},"purchases":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.purchases.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.purchases.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.purchases","typeLabel":"any | null"},"shipping_address":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.shipping_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.shipping_address","typeLabel":"any | null"},"tax_identifier":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.tax_identifier","typeLabel":"any | null"},"reviews":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.reviews.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.reviews.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.reviews","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.customer","typeLabel":"string | object | null"},"discount":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated discount ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated discount object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.object","typeLabel":"string"},"discount_amount":{"type":"integer","description":"The total discount amount applied to the associated checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.discount_amount","typeLabel":"integer"},"primary":{"type":"boolean","description":"Whether or not this discount is a primary or secondary discount. Primary discounts are the first discount in a series of discounts when the associated coupon can be used multiple times. Secondary discounts are the subsequent discounts in the series.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.primary","typeLabel":"boolean"},"redeemable_status":{"type":"string","description":"The status indicating if this discount can be redeemed (finalized with) or not and why. Possible values are `invalid`, `gone`, `expired`, `less_than_min_subtotal_amount`, greater_than_max_subtotal_amount`, `not_applicable`, `not_applicable_to_customer`, or `redeemable`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.redeemable_status","typeLabel":"string"},"used_up":{"type":"boolean","description":"Whether or not this discount has been used up. If not used up, this discount will create secondary discounts on future checkouts.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.used_up","typeLabel":"boolean"},"checkout":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.checkout","typeLabel":"any"},"coupon":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.coupon","typeLabel":"any"},"customer":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.customer.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.customer","typeLabel":"any | null"},"primary_discount":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.primary_discount.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.primary_discount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.primary_discount","typeLabel":"any | null"},"promotion":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.promotion.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.promotion.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.promotion","typeLabel":"any | null"},"secondary_discounts":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.secondary_discounts.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.secondary_discounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.secondary_discounts","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount","typeLabel":"string | object | null"},"discount_amount":{"type":"integer","description":"Total discount amount of all line items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.discount_amount","typeLabel":"integer"},"geo_address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.geo_address","typeLabel":"string | object | null"},"ip_geo_address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.ip_geo_address","typeLabel":"string | object | null"},"free_shipping_choice_shortage_amount":{"oneOf":[{"type":"integer","description":"The amount that needs to be added to the checkout to qualify for free shipping. If `null`, then a free shipping choice is not available or it has already qualified.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.free_shipping_choice_shortage_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount that needs to be added to the checkout to qualify for free shipping. If `null`, then a free shipping choice is not available or it has already qualified.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.free_shipping_choice_shortage_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.free_shipping_choice_shortage_amount","typeLabel":"integer | null"},"full_amount":{"type":"integer","description":"The full amount to be charged across all periods.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.full_amount","typeLabel":"integer"},"g_weight":{"type":"number","description":"Total weight of the entire checkout in grams.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.g_weight","typeLabel":"number"},"inherited_billing_address":{"oneOf":[{"type":"string","description":"The inherited billing address of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.\n\n[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"The inherited billing address of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.\n\n[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_billing_address","typeLabel":"string | object | null"},"inherited_email":{"oneOf":[{"type":"string","description":"The inherited email of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The inherited email of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_email","typeLabel":"string | null"},"inherited_name":{"oneOf":[{"type":"string","description":"The inherited name of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The inherited name of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_name","typeLabel":"string | null"},"inherited_phone":{"oneOf":[{"type":"string","description":"The inherited phone of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The inherited phone of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_phone","typeLabel":"string | null"},"inherited_shipping_address":{"oneOf":[{"type":"string","description":"The inherited shipping address of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.\n\n[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"The inherited shipping address of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.\n\n[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_shipping_address","typeLabel":"string | object | null"},"inherited_tax_identifier":{"oneOf":[{"type":"string","description":"The inherited tax identifier of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.\n\n[Expandable](/api-reference/expanding-responses) – The associated tax identifier ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.0","typeLabel":"string"},{"type":"object","description":"The inherited tax identifier of the checkout or customer. This is controlled by the `inherit_customer_enabled` attribute on the account's order protocol.\n\n[Expanded](/api-reference/expanding-responses) – The associated tax identifier object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.object","typeLabel":"string"},"number":{"oneOf":[{"type":"string","description":"The tax ID number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax ID number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.number","typeLabel":"string | null"},"number_type":{"type":"string","description":"The type of tax ID number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.number_type","typeLabel":"string"},"eu_vat_verified":{"type":"boolean","description":"Whether or not this a verified EU VAT number based on regex validation and an attempted VIES check.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.eu_vat_verified","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.inherited_tax_identifier","typeLabel":"string | object | null"},"invoice":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated invoice ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated invoice object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.object","typeLabel":"string"},"automatic_collection":{"type":"boolean","description":"Whether or not the invoice should be paid automatically using one of the customer's payment methods. The specific payment method will need to passed to the `/open` endpoint.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.automatic_collection","typeLabel":"boolean"},"due_date":{"oneOf":[{"type":"integer","description":"The date on which payment for this invoice is due. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.due_date.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The date on which payment for this invoice is due. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.due_date","typeLabel":"integer | null"},"footer":{"oneOf":[{"type":"string","description":"Additional footer text to be displayed on the invoice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.footer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional footer text to be displayed on the invoice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.footer.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.footer","typeLabel":"string | null"},"issue_date":{"oneOf":[{"type":"integer","description":"The date on which the invoice was issued. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.issue_date.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The date on which the invoice was issued. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.issue_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.issue_date","typeLabel":"integer | null"},"live_mode":{"type":"boolean","description":"Whether or not the invoice is in live mode.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.live_mode","typeLabel":"boolean"},"memo":{"oneOf":[{"type":"string","description":"Additional memo text to be displayed on the invoice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.memo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional memo text to be displayed on the invoice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.memo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.memo","typeLabel":"string | null"},"notifications_enabled":{"type":"boolean","description":"Whether or not notifications should be sent to customers when an invoice is opened and when it reaches its due date.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.notifications_enabled","typeLabel":"boolean"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.metadata","typeLabel":"object"},"notification_sent_at":{"oneOf":[{"type":"integer","description":"The time at which the invoice notification was sent. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.notification_sent_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the invoice notification was sent. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.notification_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.notification_sent_at","typeLabel":"integer | null"},"order_number":{"oneOf":[{"type":"string","description":"The order number associated with this invoice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.order_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The order number associated with this invoice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.order_number","typeLabel":"string | null"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this invoice's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this invoice's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.portal_url","typeLabel":"string | null"},"reminder_notification_sent_at":{"oneOf":[{"type":"integer","description":"The time at which the reminder notification was sent. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.reminder_notification_sent_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the reminder notification was sent. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.reminder_notification_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.reminder_notification_sent_at","typeLabel":"integer | null"},"status":{"type":"string","description":"The current status of this invoice, which can be one of `draft`, `open`, `paid` or void.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.status","typeLabel":"string"},"checkout":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.checkout","typeLabel":"any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.invoice","typeLabel":"string | object | null"},"last_click":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated click ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated click object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.object","typeLabel":"string"},"anonymous_id":{"type":"string","description":"The anonymous ID used for identifying a customer across multiple clicks.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.anonymous_id","typeLabel":"string"},"converted":{"type":"boolean","description":"Whether or not this click is associated with any referrals.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.converted","typeLabel":"boolean"},"domain":{"type":"string","description":"The domain of the click.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.domain","typeLabel":"string"},"expires_at":{"type":"integer","description":"Time at which the click expires. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.expires_at","typeLabel":"integer"},"referrer":{"oneOf":[{"type":"string","description":"The referring URL that the customer came from.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.referrer.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referring URL that the customer came from.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.referrer.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.referrer","typeLabel":"string | null"},"url":{"type":"string","description":"The URL where the click was tracked.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.url","typeLabel":"string"},"affiliation":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.affiliation","typeLabel":"any"},"previous_click":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.previous_click.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.previous_click.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.previous_click","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.last_click","typeLabel":"string | object | null"},"line_items":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated line item objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.line_items","typeLabel":"string | object | null"},"manual_charges":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated manual charge objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_charges","typeLabel":"string | object | null"},"manual_payment":{"type":"boolean","description":"Whether or not this checkout has been finalized with the `manual_payment=true` option.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment","typeLabel":"boolean"},"manual_payment_method":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated manual payment method ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated manual payment method object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this manual payment method is archived.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.archived","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"The description of this payment method that will be shown in the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of this payment method that will be shown in the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.description","typeLabel":"string | null"},"instructions":{"oneOf":[{"type":"string","description":"The instructions that you want your customers to follow to pay for an order. These instructions are shown on the confirmation page after a customer completes the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.instructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"The instructions that you want your customers to follow to pay for an order. These instructions are shown on the confirmation page after a customer completes the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.instructions","typeLabel":"string | null"},"name":{"type":"string","description":"The name of this manual payment method.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.name","typeLabel":"string"},"reuseable":{"type":"boolean","decription":"Whether or not this manual payment method can be reused.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.reuseable","typeLabel":"boolean"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.archived_at","typeLabel":"integer | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.manual_payment_method","typeLabel":"string | object | null"},"remaining_amount_due":{"type":"integer","description":"The remaining amount that is due for this checkout – the `amount_due` - `paid_amount`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.remaining_amount_due","typeLabel":"integer"},"net_paid_amount":{"type":"integer","description":"The net amount that has been paid for this checkout – the `paid_amount` minus the `refunded_amount`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.net_paid_amount","typeLabel":"integer"},"order":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated order ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated order object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.object","typeLabel":"string"},"checkout":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.checkout","typeLabel":"any"},"fulfillment_status":{"type":"string","description":"The overall fulfillment status of this order based on all fulfillments – one of `fulfilled`, `partially_fulfilled`, or `unfulfilled`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.fulfillment_status","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Set to `true` if this order is in live mode, and set to `false` if it is in test mode.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.live_mode","typeLabel":"boolean"},"number":{"type":"string","description":"The unique identifier for this order that is auto generated based on this account's order protocol.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.number","typeLabel":"string"},"order_type":{"type":"string","description":"One of either `checkout` or `subscription`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.order_type","typeLabel":"string"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this order's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this order's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.portal_url","typeLabel":"string | null"},"return_status":{"type":"string","description":"The overall return status of this order based on all return requests – one of `not_returned`, `partially_returned`, `return_request_open`, or `returned`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.return_status","typeLabel":"string"},"shipment_status":{"type":"string","description":"The overall shipment status of this order based on all fulfillments – one of `unshippable`, `unshipped`, `partially_shipped`, `label_purchased`, `shipped`, `in_transit`, or `delivered`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.shipment_status","typeLabel":"string"},"statement_url":{"oneOf":[{"type":"string","description":"The link to view and download the \"invoice\" or \"receipt\" statement of this order.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.statement_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to view and download the \"invoice\" or \"receipt\" statement of this order.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.statement_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.statement_url","typeLabel":"string | null"},"status":{"type":"string","description":"The current status of this order, which can be one of `draft`, `paid`, `payment_failed`, `processing`, or `void`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.status","typeLabel":"string"},"fulfillments":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.fulfillments.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.fulfillments.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.fulfillments","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.order","typeLabel":"string | object | null"},"paid_amount":{"type":"integer","description":"The total amount that has been paid for this checkout – the sum of charges and manual charges.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.paid_amount","typeLabel":"integer"},"paid_at":{"oneOf":[{"type":"integer","description":"Time at which the object was paid. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.paid_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was paid. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.paid_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.paid_at","typeLabel":"integer | null"},"payment_failures":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated payment failure objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_failures","typeLabel":"string | object | null"},"payment_method_required":{"type":"boolean","description":"Whether or not a payment method is required for this checkout. If false, the checkout will immediately transition to the `paid` state when finalized.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.payment_method_required","typeLabel":"boolean"},"phone_required":{"type":"boolean","description":"Whether or not a phone number is required for this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.phone_required","typeLabel":"boolean"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this checkout's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this checkout's correct portal page (hosted or external).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.portal_url","typeLabel":"string | null"},"processor_data":{"type":"object","description":"All of the additional data necessary to capture payment with each processor.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.processor_data","typeLabel":"object"},"proration_amount":{"type":"integer","description":"Total amount to be prorated from this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.proration_amount","typeLabel":"integer"},"purchases":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated purchase objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.purchases","typeLabel":"string | object | null"},"recommended_bumps":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of recommended bumps for this checkout.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.recommended_bumps","typeLabel":"string | object | null"},"referral":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated referral ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated referral object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.object","typeLabel":"string"},"commission_amount":{"type":"integer","description":"The amount in cents that will be paid out to the affiliate for this referral.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.commission_amount","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","description":"A brief description of what this referral is for.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A brief description of what this referral is for.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.description","typeLabel":"string | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this referral is in live mode, and set to `false` if it is in test mode.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.live_mode","typeLabel":"boolean"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. If not set, this value will fallback to the default `Account` currency.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.currency","typeLabel":"string"},"manual":{"type":"boolean","description":"Whether or not this referral was created manually or automatically from a tracked click associated with a checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.manual","typeLabel":"boolean"},"status":{"type":"string","description":"The status of the referral – one of `approved`, `canceled`, `denied`, `paid`, or `reviewing`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.status","typeLabel":"string"},"refund_reduction_amount":{"type":"integer","description":"The amount in cents that is reduced from the original commission amount due to refunds.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.refund_reduction_amount","typeLabel":"integer"},"affiliation":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.affiliation","typeLabel":"any"},"attributed_click":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.attributed_click.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.attributed_click.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.attributed_click","typeLabel":"any | null"},"checkout":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.checkout.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.checkout.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.checkout","typeLabel":"any | null"},"payout":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.payout.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.payout.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.payout","typeLabel":"any | null"},"referral_items":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.referral_items.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.referral_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.referral_items","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.referral","typeLabel":"string | object | null"},"refunded_amount":{"type":"integer","description":"The total amount that has been refunded for this checkout – the sum of refunds.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.refunded_amount","typeLabel":"integer"},"reusable_payment_method_required":{"type":"boolean","description":"Whether or not a reusable payment method is required for this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.reusable_payment_method_required","typeLabel":"boolean"},"selected_shipping_choice_required":{"type":"boolean","description":"Whether or not a shipping choice must be selected for this checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice_required","typeLabel":"boolean"},"selected_shipping_choice":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated shipping choice ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated shipping choice object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.object","typeLabel":"string"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents for this shipping choice. For example `9900` is equivalent to `$99`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents for this shipping choice. For example `9900` is equivalent to `$99`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.amount","typeLabel":"integer | null"},"currency":{"oneOf":[{"type":"string","description":"The three-letter currency code for this shipping choice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"The three-letter currency code for this shipping choice.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.currency","typeLabel":"string | null"},"live":{"type":"boolean","description":"Whether this shipping choice was quoted live from a carrier.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.live","typeLabel":"boolean"},"carrier_quotes":{"type":"array","description":"The carrier quotes backing this shipping choice.","items":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.carrier_quotes.items.[INDEX]","typeLabel":"any"},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.carrier_quotes","typeLabel":"any[]"},"checkout":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.checkout","typeLabel":"any"},"shipping_method":{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.shipping_method","typeLabel":"any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.selected_shipping_choice","typeLabel":"string | object | null"},"shipping_address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address","typeLabel":"string | object | null"},"shipping_address_accuracy_requirement":{"oneOf":[{"type":"string","description":"The required level of accuracy for the shipping address – one of `full`, `tax`, or `none`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address_accuracy_requirement.oneOf.0","typeLabel":"string"},{"type":"null","description":"The required level of accuracy for the shipping address – one of `full`, `tax`, or `none`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address_accuracy_requirement.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_address_accuracy_requirement","typeLabel":"string | null"},"shipping_amount":{"type":"integer","description":"Total shipping amount for the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_amount","typeLabel":"integer"},"shipping_choices":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of available shipping choices for this checkout.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_choices","typeLabel":"string | object | null"},"shipping_fees":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated shipping fee objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees","typeLabel":"string | object | null"},"shipping_enabled":{"type":"boolean","description":"Whether or not this checkout has products with `shipping_enabled=true`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_enabled","typeLabel":"boolean"},"shipping_fees_amount":{"type":"integer","description":"The total amount of shipping fees applied to the shipping_amount.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_fees_amount","typeLabel":"integer"},"shipping_tax_amount":{"type":"number","description":"Total tax from shipping.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_tax_amount","typeLabel":"number"},"shipping_tax_rate":{"type":"number","description":"The tax rate applied to shipping.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.shipping_tax_rate","typeLabel":"number"},"status":{"type":"string","description":"The current status of this checkout, which can be one of `canceled`, `draft`, `finalized`, `paid`, `payment_intent_canceled`, `payment_failed`, or `processing`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.status","typeLabel":"string"},"subtotal_amount":{"type":"integer","description":"Total of all line items and their fees before discounts or taxes are applied.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.subtotal_amount","typeLabel":"integer"},"tax_amount":{"type":"integer","description":"Total tax amount of all line items.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_amount","typeLabel":"integer"},"tax_breakdown":{"type":"array","description":"The tax rate breakdown for this checkout.","items":{"type":"object","properties":{"tax_rate":{"type":"number","description":"The tax rate applied to this portion of the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_rate","typeLabel":"number"},"tax_label":{"oneOf":[{"type":"string","description":"The type of tax that is applied to this portion of the checkout. For example, in the EU this value will be `VAT` and in the US this value will be `Tax`. This can also reflect a merchant-set tax override label when one applies.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"The type of tax that is applied to this portion of the checkout. For example, in the EU this value will be `VAT` and in the US this value will be `Tax`. This can also reflect a merchant-set tax override label when one applies.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_label","typeLabel":"string | null"},"taxable_amount":{"type":"integer","description":"The amount this tax rate was applied to.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].taxable_amount","typeLabel":"integer"},"tax_amount":{"type":"integer","description":"The tax amount for this portion of the checkout.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX].tax_amount","typeLabel":"integer"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_breakdown","typeLabel":"object[]"},"tax_status":{"type":"string","description":"The status of tax calculations for this checkout. One of `address_invalid`, `calculated`, `disabled`, `estimated`, `reverse_charged`, or `tax_zone_not_found`.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_status","typeLabel":"string"},"tax_identifier":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated tax identifier ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated tax identifier object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.object","typeLabel":"string"},"number":{"oneOf":[{"type":"string","description":"The tax ID number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax ID number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.number","typeLabel":"string | null"},"number_type":{"type":"string","description":"The type of tax ID number.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.number_type","typeLabel":"string"},"eu_vat_verified":{"type":"boolean","description":"Whether or not this a verified EU VAT number based on regex validation and an attempted VIES check.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.eu_vat_verified","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.tax_identifier","typeLabel":"string | object | null"},"total_amount":{"type":"integer","description":"Total of all line items after discounts and taxes are applied.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.total_amount","typeLabel":"integer"},"total_savings_amount":{"type":"integer","description":"The total amount in cents that was saved on this checkout taking into account all negative fees, discounts, and all price `scratch_amount` values.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.total_savings_amount","typeLabel":"integer"},"trial_amount":{"type":"integer","description":"The total amount in cents that is removed from this checkout due to trial periods.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.trial_amount","typeLabel":"integer"},"upsells_expire_at":{"oneOf":[{"type":"integer","description":"The time at which upsells will expire for this checkout. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsells_expire_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which upsells will expire for this checkout. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsells_expire_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsells_expire_at","typeLabel":"integer | null"},"upsell_funnel":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated upsell funnel ID.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated upsell funnel object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this upsell funnel is archived.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.archived","typeLabel":"boolean"},"enabled":{"type":"boolean","description":"Whether or not this upsell funnel is enabled.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.enabled","typeLabel":"boolean"},"filter_match_type":{"oneOf":[{"type":"string","description":"The matching strategy to use when filtering upsell funnels – can be `null` or one of `all`, `any`, `none`. If `null`, the upsell funnel will not be filtered and will be applicable to all checkouts.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.filter_match_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"The matching strategy to use when filtering upsell funnels – can be `null` or one of `all`, `any`, `none`. If `null`, the upsell funnel will not be filtered and will be applicable to all checkouts.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.filter_match_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.filter_match_type","typeLabel":"string | null"},"filter_price_ids":{"type":"array","description":"The prices to filter this upsell funnel by.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.filter_price_ids","typeLabel":"array"},"filter_product_ids":{"type":"array","description":"The products to filter this upsell funnel by.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.filter_product_ids","typeLabel":"array"},"name":{"oneOf":[{"type":"string","description":"A name for this upsell that will be visible to customers.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"A name for this upsell that will be visible to customers.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.name","typeLabel":"string | null"},"priority":{"type":"integer","description":"The priority of this upsell in relation to other upsells. Must be in the range of `1` - `5` with `5` being the highest priority and `1` being the lowest.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.priority","typeLabel":"integer"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.archived_at","typeLabel":"integer | null"},"upsells":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.upsells.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.upsells.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.upsells","typeLabel":"any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.upsell_funnel","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.checkout.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.checkout.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.checkout","typeLabel":"string | object | null"},"price":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"current_period.oneOf.1.price.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated price object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.object","typeLabel":"string"},"ad_hoc":{"type":"boolean","default":false,"description":"Whether or not this price accepts ad hoc amounts – also known as custom or user-defined amounts.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc","typeLabel":"boolean"},"ad_hoc_max_amount":{"oneOf":[{"type":"integer","description":"The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc_max_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc_max_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc_max_amount","typeLabel":"integer | null"},"ad_hoc_min_amount":{"oneOf":[{"type":"integer","description":"The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`. If left blank, this will be interpreted as `0`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc_min_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`. If left blank, this will be interpreted as `0`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc_min_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.ad_hoc_min_amount","typeLabel":"integer | null"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged, represented as a whole integer. For example `9900` is equivalent to `$99`. If `ad_hoc=true` the `amount` is optional.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged, represented as a whole integer. For example `9900` is equivalent to `$99`. If `ad_hoc=true` the `amount` is optional.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.amount","typeLabel":"integer | null"},"archived":{"type":"boolean","description":"Whether or not this price is archived.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.archived","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, this value will inherit from the value set on `Product`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, this value will inherit from the value set on `Product`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"oneOf":[{"type":"string","description":"The price name, meant to be displayable to the customer.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The price name, meant to be displayable to the customer.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.name","typeLabel":"string | null"},"portal_subscription_update_enabled":{"type":"boolean","description":"Whether existing subscriptions can be switched to this price from the customer dashboard. If set to false, existing subscriptions cannot be switched to this price, preventing customers from upgrading or downgrading their subscription to this price option.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.portal_subscription_update_enabled","typeLabel":"boolean"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this price when displayed to customers.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this price when displayed to customers.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.position","typeLabel":"integer | null"},"recurring_interval":{"oneOf":[{"type":"string","description":"The frequency at which a subscription is billed. One of `day`, `week`, `month`, or `year`. Only applicable during creation.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_interval.oneOf.0","typeLabel":"string"},{"type":"null","description":"The frequency at which a subscription is billed. One of `day`, `week`, `month`, or `year`. Only applicable during creation.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_interval","typeLabel":"string | null"},"recurring_interval_count":{"oneOf":[{"type":"integer","description":"The number of intervals (specified in the `recurring_interval` attribute) between subscription billings. For example, `recurring_interval=month` and `recurring_interval_count=3` bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of intervals (specified in the `recurring_interval` attribute) between subscription billings. For example, `recurring_interval=month` and `recurring_interval_count=3` bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_interval_count","typeLabel":"integer | null"},"recurring_period_count":{"oneOf":[{"type":"integer","description":"The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the `complete` state. Only applicable during creation.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_period_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the `complete` state. Only applicable during creation.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_period_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.recurring_period_count","typeLabel":"integer | null"},"revoke_after_days":{"oneOf":[{"type":"integer","description":"The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.revoke_after_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.revoke_after_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.revoke_after_days","typeLabel":"integer | null"},"revoke_purchases_on_completed":{"type":"boolean","description":"Whether or not purchases for this price should be revoked when subscriptions transition to the `complete` state.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.revoke_purchases_on_completed","typeLabel":"boolean"},"restart_subscription_on_completed":{"type":"boolean","description":"Whether installment subscriptions using this price should be automatically restarted when they reach the completed state.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.restart_subscription_on_completed","typeLabel":"boolean"},"setup_fee_amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged as a setup fee on the first billing period of a recurring price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged as a setup fee on the first billing period of a recurring price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_amount","typeLabel":"integer | null"},"setup_fee_enabled":{"type":"boolean","description":"Whether or not this price has a setup fee.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_enabled","typeLabel":"boolean"},"setup_fee_name":{"oneOf":[{"type":"string","description":"The name that will display for the setup fee on the first billing period.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name that will display for the setup fee on the first billing period.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_name","typeLabel":"string | null"},"setup_fee_trial_enabled":{"type":"boolean","description":"Whether or not the setup fee should be deferred until the trial period ends. If set to true, the setup fee will not be charged until the trial period ends.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.setup_fee_trial_enabled","typeLabel":"boolean"},"scratch_amount":{"oneOf":[{"type":"integer","description":"The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.scratch_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.scratch_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.scratch_amount","typeLabel":"integer | null"},"trial_duration_days":{"oneOf":[{"type":"integer","description":"The default number of trial days when subscribing a customer to this price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.trial_duration_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The default number of trial days when subscribing a customer to this price.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.trial_duration_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.trial_duration_days","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.archived_at","typeLabel":"integer | null"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.currency","typeLabel":"string"},"full_amount":{"type":"integer","description":"The full amount to be charged across all periods, represented as a whole integer. For prices without a `recurring_period_count` defined this is the same as `amount`. For finite prices, this is equal to `amount` * `recurring_period_count`. For example, a price that has an amount of $25 and is set to recur over 4 periods, will have a `full_amount` of $100.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.full_amount","typeLabel":"integer"},"current_version":{"type":"boolean","description":"Whether or not this object represents the current version of this price. (This will be `false` if the association was created to this price before it was altered. In this case, we will lookup the version of the price at the time it was associated.)","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_version","typeLabel":"boolean"},"current_swap":{"oneOf":[{"type":"string","description":"The current swap for this price.\n\n[Expandable](/api-reference/expanding-responses) – The associated swap ID.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.0","typeLabel":"string"},{"type":"object","description":"The current swap for this price.\n\n[Expanded](/api-reference/expanding-responses) – The associated swap object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this swap is archived.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.description","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived_at","typeLabel":"integer | null"},"price":{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.price","typeLabel":"any"},"swap_price":{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.swap_price","typeLabel":"any"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.current_swap","typeLabel":"string | object | null"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.object","typeLabel":"string"},"allow_out_of_stock_purchases":{"type":"boolean","description":"Whether or not to allow purchases of this product when stock runs out. If true, the stock levels for this can go below zero.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean"},"archived":{"type":"boolean","description":"Whether or not this product is archived.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.archived","typeLabel":"boolean"},"auto_fulfill_enabled":{"type":"boolean","description":"Whether or not this product should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean"},"cataloged_at":{"type":"integer","description":"The time when the product was added or made available. This value is used for sorting products on shop pages.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.cataloged_at","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","description":"The product description, meant to be displayable to the customer.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product description, meant to be displayable to the customer.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.description","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions","typeLabel":"object | null"},"featured":{"type":"boolean","description":"Whether or not this product is featured.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.featured","typeLabel":"boolean"},"licensing_enabled":{"type":"boolean","description":"Whether or not licensing is enabled for this product.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.licensing_enabled","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"type":"string","description":"The product name, meant to be displayable to the customer.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.purchase_limit","typeLabel":"integer | null"},"recurring":{"type":"boolean","default":false,"description":"Whether the product is for a one-time purchase or a recurring (subscription) purchase.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.recurring","typeLabel":"boolean"},"reviews_enabled":{"type":"boolean","description":"Whether or not reviews are enabled for this product.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.reviews_enabled","typeLabel":"boolean"},"shipping_enabled":{"type":"boolean","description":"If set to `true` checkouts with this product will require a full shipping address.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_enabled","typeLabel":"boolean"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.sku","typeLabel":"string | null"},"status":{"type":"string","description":"The status of this product – one of `draft` or `published`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.status","typeLabel":"string"},"slug":{"type":"string","description":"A unique and URL friendly string that represents this product. (This will be auto-generated when a product is created if not explicitly set.)","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.slug","typeLabel":"string"},"solicit_reviews":{"type":"boolean","description":"Whether or not to solicit reviews for this product with automatic emails to customers.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.solicit_reviews","typeLabel":"boolean"},"stock_enabled":{"type":"boolean","description":"Whether or not stock will be tracked for this product.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.stock_enabled","typeLabel":"boolean"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"If set to `true` this product is considered taxable.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.tax_enabled","typeLabel":"boolean"},"weight":{"type":"number","description":"The product weight, meant to be displayable to the customer.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.weight","typeLabel":"number"},"weight_unit":{"type":"string","description":"The weight unit for this product – one of `lb`, `oz`, `kg`, `g`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.weight_unit","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.archived_at","typeLabel":"integer | null"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.available_stock","typeLabel":"integer"},"average_stars":{"type":"string","description":"The average stars for this product based on published reviews.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.average_stars","typeLabel":"string"},"bundle_items":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.bundle_items.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.bundle_items","typeLabel":"any | null"},"commission_structure":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.commission_structure.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.commission_structure.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.commission_structure","typeLabel":"any | null"},"current_release_download":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.current_release_download.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.current_release_download","typeLabel":"any | null"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.held_stock","typeLabel":"integer"},"metrics":{"type":"object","properties":{"currency":{"type":"string","description":"The currency that was used to calculate these metrics. This will always be set to the account's currency.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.currency","typeLabel":"string"},"max_price_amount":{"oneOf":[{"type":"integer","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.max_price_amount","typeLabel":"integer | null"},"min_price_amount":{"oneOf":[{"type":"integer","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.min_price_amount","typeLabel":"integer | null"},"prices_count":{"oneOf":[{"type":"integer","description":"The total number of prices that belong to this product.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The total number of prices that belong to this product.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.prices_count","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.metrics","typeLabel":"object"},"downloads":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.downloads.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.downloads.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.downloads","typeLabel":"any | null"},"reviews_breakdown":{"type":"object","description":"A histogram breakdown of the reviews for this product.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.reviews_breakdown","typeLabel":"object"},"featured_product_media":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.featured_product_media","typeLabel":"any | null"},"prices":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.prices.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.prices.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.prices","typeLabel":"any | null"},"product_collections":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_collections.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_collections","typeLabel":"any | null"},"product_group":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_group.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_group","typeLabel":"any | null"},"product_medias":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_medias.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_medias.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.product_medias","typeLabel":"any | null"},"shipping_profile":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_profile","typeLabel":"any | null"},"stock":{"type":"integer","description":"The total amount of stock on hand for this variant.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.stock","typeLabel":"integer"},"reviews":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.reviews.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.reviews.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.reviews","typeLabel":"any | null"},"variant_options":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.variant_options.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.variant_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.variant_options","typeLabel":"any | null"},"variants":{"oneOf":[{"type":"any","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.variants.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.variants.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.variants","typeLabel":"any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product.oneOf.1","typeLabel":"object"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.product","typeLabel":"string | object"},"renewal_price":{"oneOf":[{"type":"string","description":"If present, subscriptions will be updated to this price when they renew.\n\n[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.renewal_price.oneOf.0","typeLabel":"string"},{"description":"If present, subscriptions will be updated to this price when they renew.\n\n[Expanded](/api-reference/expanding-responses) – The associated price object.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.renewal_price.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"current_period.oneOf.1.price.oneOf.1.renewal_price.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.renewal_price","typeLabel":"string | any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.price.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.price.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.price.oneOf.1","typeLabel":"object"}],"uniqueKey":"current_period.oneOf.1.price","typeLabel":"string | object"},"subscription":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated subscription ID.","uniqueKey":"current_period.oneOf.1.subscription.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated subscription object.","uniqueKey":"current_period.oneOf.1.subscription.oneOf.1","typeLabel":"any"}],"uniqueKey":"current_period.oneOf.1.subscription","typeLabel":"string | any"},"variant":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated variant ID.","uniqueKey":"current_period.oneOf.1.variant.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated variant object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.object","typeLabel":"string"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular `Price` amount will be used. If the `Product` has multiple prices, then this amount will be ignored and the selected `Price` amount will be used.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular `Price` amount will be used. If the `Product` has multiple prices, then this amount will be ignored and the selected `Price` amount will be used.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.amount","typeLabel":"integer | null"},"allow_out_of_stock_purchases":{"oneOf":[{"type":"boolean","description":"Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.allow_out_of_stock_purchases.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.allow_out_of_stock_purchases.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean | null"},"auto_fulfill_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not this variant should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.auto_fulfill_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not this variant should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.auto_fulfill_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this variant. If `null`, inherits from the product.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this variant. If `null`, inherits from the product.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.dimensions","typeLabel":"object | null"},"downloads_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not downloads are enabled for this variant. When `false`, downloads will be disabled for this variant. When `true`, the downloads that are set for this variant will override the product downloads. If no downloads are set, then the product downloads will be used.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.downloads_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not downloads are enabled for this variant. When `false`, downloads will be disabled for this variant. When `true`, the downloads that are set for this variant will override the product downloads. If no downloads are set, then the product downloads will be used.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.downloads_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.downloads_enabled","typeLabel":"boolean | null"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, inherits from the product or price.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, inherits from the product or price.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"option_1":{"type":"string","description":"The value for the first variant option.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_1","typeLabel":"string"},"option_2":{"oneOf":[{"type":"string","description":"The value for the second variant option.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value for the second variant option.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_2","typeLabel":"string | null"},"option_3":{"oneOf":[{"type":"string","description":"The value for the third variant option.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value for the third variant option.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_3.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_3","typeLabel":"string | null"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this variant when displayed to customers.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this variant when displayed to customers.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.position","typeLabel":"integer | null"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times this variant can be purchased by a customer. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times this variant can be purchased by a customer. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.purchase_limit","typeLabel":"integer | null"},"shipping_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true` checkouts with this variant will require a full shipping address. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.shipping_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true` checkouts with this variant will require a full shipping address. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.shipping_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.shipping_enabled","typeLabel":"boolean | null"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this variant.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this variant.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.sku","typeLabel":"string | null"},"stock_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not stock will be tracked for this variant. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.stock_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not stock will be tracked for this variant. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.stock_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.stock_enabled","typeLabel":"boolean | null"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this variant. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this variant. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true`, this variant is considered taxable. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.tax_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true`, this variant is considered taxable. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.tax_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.tax_enabled","typeLabel":"boolean | null"},"weight":{"oneOf":[{"type":"number","description":"The variant weight, meant to be displayable to the customer. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"The variant weight, meant to be displayable to the customer. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.weight","typeLabel":"number | null"},"weight_unit":{"oneOf":[{"type":"string","description":"The weight unit for this variant. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.weight_unit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The weight unit for this variant. If `null`, inherits from the product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.weight_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.weight_unit","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.metadata","typeLabel":"object"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.available_stock","typeLabel":"integer"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This is inherited from the price.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.currency","typeLabel":"string"},"current_release_download":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated download ID.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.current_release_download.oneOf.0","typeLabel":"string"},{},{"type":"null","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.current_release_download.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.current_release_download","typeLabel":"string | null"},"current_version":{"type":"boolean","description":"Whether or not this object represents the current version of this variant. (This will be `false` if the association was created to this variant before it was altered. In this case, we will lookup the version of the variant at the time it was associated.)","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.current_version","typeLabel":"boolean"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.held_stock","typeLabel":"integer"},"image":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated media ID.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated media object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.object","typeLabel":"string"},"byte_size":{"type":"integer","description":"The size of the media in bytes.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"The content type (i.e. image/png, image/jpg, application/pdf).","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.content_type","typeLabel":"string"},"extension":{"type":"string","description":"The extension (i.e. png, jpg, pdf).","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.extension","typeLabel":"string"},"filename":{"type":"string","description":"The full filename with extension.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.filename","typeLabel":"string"},"height":{"oneOf":[{"type":"string","description":"If the media is an image, this will be the height in pixels.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.height.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the media is an image, this will be the height in pixels.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.height","typeLabel":"string | null"},"public_access":{"type":"boolean","description":"Whether or not this media is publicly accessible.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.public_access","typeLabel":"boolean"},"release_json":{"oneOf":[{"type":"object","description":"The JSON that was extracted from the `release.json` file within the ZIP file.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.release_json.oneOf.0","typeLabel":"object"},{"type":"null","description":"The JSON that was extracted from the `release.json` file within the ZIP file.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.release_json.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.release_json","typeLabel":"object | null"},"url":{"oneOf":[{"type":"string","description":"The URL for accessing this media. If the media is public, this will be a permanent URL. If the media is private, this will be a short-lived URL if the media has been exposed.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for accessing this media. If the media is public, this will be a permanent URL. If the media is private, this will be a short-lived URL if the media has been exposed.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.url","typeLabel":"string | null"},"url_expires_at":{"oneOf":[{"type":"integer","description":"The time at which the URL expires. This will only be present if the media is private and has been exposed.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.url_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the URL expires. This will only be present if the media is private and has been exposed.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.url_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.url_expires_at","typeLabel":"integer | null"},"width":{"oneOf":[{"type":"string","description":"If the media is an image, this will be the width in pixels.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.width.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the media is an image, this will be the width in pixels.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.width","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.image","typeLabel":"string | object | null"},"option_names":{"type":"array","description":"An array of the associated product's variant option names.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.option_names","typeLabel":"array"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.product.oneOf.0","typeLabel":"string"},{}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.product","typeLabel":"string"},"stock":{"type":"integer","description":"The total amount of stock on hand for this product.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.stock","typeLabel":"integer"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.variant.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1.variant.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"current_period.oneOf.1.variant.oneOf.2","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.variant","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"current_period.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_period.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"current_period.oneOf.1","typeLabel":"object"}],"uniqueKey":"current_period","typeLabel":"string | object"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"customer.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated customer object.","uniqueKey":"customer.oneOf.1","typeLabel":"any"}],"uniqueKey":"customer","typeLabel":"string | any"},"discount":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated discount ID.","uniqueKey":"discount.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated discount object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.object","typeLabel":"string"},"discount_amount":{"type":"integer","description":"The total discount amount applied to the associated checkout.","uniqueKey":"discount.oneOf.1.discount_amount","typeLabel":"integer"},"primary":{"type":"boolean","description":"Whether or not this discount is a primary or secondary discount. Primary discounts are the first discount in a series of discounts when the associated coupon can be used multiple times. Secondary discounts are the subsequent discounts in the series.","uniqueKey":"discount.oneOf.1.primary","typeLabel":"boolean"},"redeemable_status":{"type":"string","description":"The status indicating if this discount can be redeemed (finalized with) or not and why. Possible values are `invalid`, `gone`, `expired`, `less_than_min_subtotal_amount`, greater_than_max_subtotal_amount`, `not_applicable`, `not_applicable_to_customer`, or `redeemable`.","uniqueKey":"discount.oneOf.1.redeemable_status","typeLabel":"string"},"used_up":{"type":"boolean","description":"Whether or not this discount has been used up. If not used up, this discount will create secondary discounts on future checkouts.","uniqueKey":"discount.oneOf.1.used_up","typeLabel":"boolean"},"checkout":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated checkout ID.","uniqueKey":"discount.oneOf.1.checkout.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated checkout object.","uniqueKey":"discount.oneOf.1.checkout.oneOf.1","typeLabel":"any"}],"uniqueKey":"discount.oneOf.1.checkout","typeLabel":"string | any"},"coupon":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated coupon ID.","uniqueKey":"discount.oneOf.1.coupon.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated coupon object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this coupon is archived.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.archived","typeLabel":"boolean"},"amount_off":{"oneOf":[{"type":"integer","description":"Amount (in the `currency` specified) that will be taken off the subtotal of any checkout.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.amount_off.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount (in the `currency` specified) that will be taken off the subtotal of any checkout.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.amount_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.amount_off","typeLabel":"integer | null"},"duration":{"type":"string","description":"One of `forever`, `once`, and `repeating`. Describes how long a discount with this coupon will be applied. (The `repeating` and `forever` values only apply to subscriptions.)","default":"once","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.duration","typeLabel":"string"},"duration_in_months":{"oneOf":[{"type":"integer","description":"If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.duration_in_months.oneOf.0","typeLabel":"integer"},{"type":"null","description":"If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.duration_in_months.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.duration_in_months","typeLabel":"integer | null"},"max_redemptions":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed in total across all customers.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of times this coupon can be redeemed in total across all customers.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_redemptions","typeLabel":"integer | null"},"max_redemptions_per_customer":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed per customer.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_redemptions_per_customer.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of times this coupon can be redeemed per customer.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_redemptions_per_customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_redemptions_per_customer","typeLabel":"integer | null"},"max_subtotal_amount":{"oneOf":[{"type":"integer","description":"The maximum `subtotal_amount` that is allowed for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_subtotal_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `subtotal_amount` that is allowed for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_subtotal_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.max_subtotal_amount","typeLabel":"integer | null"},"min_subtotal_amount":{"oneOf":[{"type":"integer","description":"The minimum `subtotal_amount` that is required for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.min_subtotal_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `subtotal_amount` that is required for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.min_subtotal_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.min_subtotal_amount","typeLabel":"integer | null"},"name":{"type":"string","description":"Name of the coupon displayed to customers.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.name","typeLabel":"string"},"percent_off":{"oneOf":[{"type":"number","description":"Percent that will be taken off the subtotal of any checkout. For example, a coupon with percent_off of `50` will make a $100 checkout $50 instead.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.percent_off.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percent that will be taken off the subtotal of any checkout. For example, a coupon with percent_off of `50` will make a $100 checkout $50 instead.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.percent_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.percent_off","typeLabel":"number | null"},"product_ids":{"type":"array","description":"An array of product IDs that this coupon applies to.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.product_ids","typeLabel":"array"},"redeem_by":{"oneOf":[{"type":"integer","description":"Date after which the coupon can no longer be redeemed.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.redeem_by.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Date after which the coupon can no longer be redeemed.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.redeem_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.redeem_by","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.archived_at","typeLabel":"integer | null"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.currency","typeLabel":"string"},"discounts":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated discount objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discounts","typeLabel":"string | object | null"},"expired":{"type":"boolean","description":"Taking into account the above properties, whether this coupon can still be applied to a checkout.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.expired","typeLabel":"boolean"},"promotions":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated promotion objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.promotions","typeLabel":"string | object | null"},"times_redeemed":{"type":"integer","description":"Number of times this coupon has been applied to a checkout and/or subscription.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.times_redeemed","typeLabel":"integer"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.coupon.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.coupon.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.coupon.oneOf.1","typeLabel":"object"}],"uniqueKey":"discount.oneOf.1.coupon","typeLabel":"string | object"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated customer object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.object","typeLabel":"string"},"affiliation_expires_at":{"oneOf":[{"type":"integer","description":"Time at which the affiliation will expire.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the affiliation will expire.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation_expires_at","typeLabel":"integer | null"},"billing_matches_shipping":{"type":"boolean","description":"If set to `true` the shipping address will be used for the billing address.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_matches_shipping","typeLabel":"boolean"},"email":{"type":"string","description":"The customer’s email address.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","description":"The customer’s first name.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s first name.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this customer is in live mode, and set to `false` if it is in test mode.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.live_mode","typeLabel":"boolean"},"last_name":{"oneOf":[{"type":"string","description":"The customer’s last name.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s last name.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The customer’s phone number.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s phone number.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.phone","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"Whether or not tax should be calculated for checkouts associated with this customer.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_enabled","typeLabel":"boolean"},"unsubscribed":{"type":"boolean","description":"Set to `true` if this customer has unsubscribed from from opt-in emails (i.e. abandoned cart emails).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.unsubscribed","typeLabel":"boolean"},"indexed":{"type":"boolean","description":"Whether or not this customer is included in the `/customers` list endpoint. Only customers that have been manually created or have a purchase are indexed.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.indexed","typeLabel":"boolean"},"affiliation":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated affiliation ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated affiliation object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.object","typeLabel":"string"},"active":{"type":"boolean","description":"Whether or not the affiliate is active.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.active","typeLabel":"boolean"},"affiliation_products":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.affiliation_products.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.affiliation_products.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.affiliation_products","typeLabel":"any | null"},"commission_structure":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.commission_structure.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.commission_structure.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.commission_structure","typeLabel":"any | null"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this affiliation's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this affiliation's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.portal_url","typeLabel":"string | null"},"referral_url":{"type":"string","description":"The referral URL with the affiliate's code appended as a query parameter.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.referral_url","typeLabel":"string"},"total_commission_amount":{"type":"integer","description":"The total commission amount earned by the affiliate.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.total_commission_amount","typeLabel":"integer"},"total_not_paid_commission_amount":{"type":"integer","description":"The total commission amount earned by the affiliate that has not been paid out yet.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.total_not_paid_commission_amount","typeLabel":"integer"},"clicks":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.clicks.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.clicks.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.clicks","typeLabel":"any | null"},"referrals":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.referrals.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.referrals.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.referrals","typeLabel":"any | null"},"payouts":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.payouts.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.payouts.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.payouts","typeLabel":"any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.affiliation","typeLabel":"string | object | null"},"balances":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of this customer's balances.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.balances","typeLabel":"string | object | null"},"billing_address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.billing_address","typeLabel":"string | object | null"},"default_payment_method":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated payment method ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated payment method object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.object","typeLabel":"string"},"external_payment_method_id":{"type":"string","description":"The external processor ID representing this payment method.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.external_payment_method_id","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Set to `true` if this charge is in live mode, and set to `false` if it is in test mode.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.live_mode","typeLabel":"boolean"},"processor_type":{"type":"string","description":"The specific type of processor. The only allowed processors right now are `stripe` and `paypal`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.processor_type","typeLabel":"string"},"reusable":{"type":"boolean","description":"Whether or not this payment method can be reused. Only reusable payment methods can be attached to subscriptions and set as a customer's default.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.reusable","typeLabel":"boolean"},"supported_currencies":{"oneOf":[{"type":"array","description":"A list of currencies that this payment method supports. If `null`, this payment method supports all currencies.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.supported_currencies.oneOf.0","typeLabel":"array"},{"type":"null","description":"A list of currencies that this payment method supports. If `null`, this payment method supports all currencies.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.supported_currencies.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.supported_currencies","typeLabel":"array | null"},"type":{"type":"string","description":"The type of payment method. One of `bank_account, `card`, `payment_instrument`, or `paypal_account`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.type","typeLabel":"string"},"bank_account":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.bank_account.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.bank_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.bank_account","typeLabel":"any | null"},"card":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.card.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.card.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.card","typeLabel":"any | null"},"customer":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.customer.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.customer","typeLabel":"any | null"},"payment_instrument":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.payment_instrument.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.payment_instrument.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.payment_instrument","typeLabel":"any | null"},"paypal_account":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.paypal_account.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.paypal_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.paypal_account","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_payment_method","typeLabel":"string | object | null"},"default_saved_list":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated saved list ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated saved list object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.object","typeLabel":"string"},"customer":{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.customer","typeLabel":"any"},"default":{"type":"boolean","description":"Whether this is the customer's default list. Every customer has exactly one, and it can't be renamed or deleted.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.default","typeLabel":"boolean"},"live_mode":{"type":"boolean","description":"Set to true if this list belongs to a live mode customer.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.live_mode","typeLabel":"boolean"},"name":{"type":"string","description":"The name of the list. The default list has a fixed name.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.name","typeLabel":"string"},"saved_items":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.saved_items.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.saved_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.saved_items","typeLabel":"any | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.metadata","typeLabel":"object"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.default_saved_list","typeLabel":"string | object | null"},"saved_lists":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of this customer's saved lists, including the default one.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.saved_lists","typeLabel":"string | object | null"},"licenses":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated license objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.licenses","typeLabel":"string | object | null"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this customer's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this customer's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.portal_url","typeLabel":"string | null"},"purchases":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated purchase objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.purchases","typeLabel":"string | object | null"},"shipping_address":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated address ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated address object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.object","typeLabel":"string"},"city":{"type":"string","description":"City, district, suburb, town, or village.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.city","typeLabel":"string"},"country":{"type":"string","description":"The two-letter code of the country - ISO 3166-1. (Reference the Atlas API for all available codes.)","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.country","typeLabel":"string"},"line_1":{"type":"string","description":"Address line 1 (e.g., street, PO Box, or company name).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.line_1","typeLabel":"string"},"line_2":{"oneOf":[{"type":"string","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.line_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2 (e.g., apartment, suite, unit, or building).","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.line_2","typeLabel":"string | null"},"name":{"type":"string","description":"The full name or business name for this address. (If empty, this will fallback to the customer's name.)","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.name","typeLabel":"string"},"postal_code":{"type":"string","description":"ZIP or postal code.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.postal_code","typeLabel":"string"},"state":{"type":"string","description":"The code of the state - ISO 3166-2. (Reference the Atlas API for all available codes.)","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.state","typeLabel":"string"},"formatted_string":{"type":"string","description":"A formatted string representation of the address.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.formatted_string","typeLabel":"string"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.shipping_address","typeLabel":"string | object | null"},"tax_identifier":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated tax identifier ID.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated tax identifier object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.object","typeLabel":"string"},"number":{"oneOf":[{"type":"string","description":"The tax ID number.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax ID number.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.number","typeLabel":"string | null"},"number_type":{"type":"string","description":"The type of tax ID number.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.number_type","typeLabel":"string"},"eu_vat_verified":{"type":"boolean","description":"Whether or not this a verified EU VAT number based on regex validation and an attempted VIES check.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.eu_vat_verified","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.tax_identifier","typeLabel":"string | object | null"},"reviews":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated review objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.reviews","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.customer.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.customer.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.customer","typeLabel":"string | object | null"},"primary_discount":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated discount ID.","uniqueKey":"discount.oneOf.1.primary_discount.oneOf.0","typeLabel":"string"},{},{"type":"null","uniqueKey":"discount.oneOf.1.primary_discount.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.primary_discount","typeLabel":"string | null"},"promotion":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated promotion ID.","uniqueKey":"discount.oneOf.1.promotion.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated promotion object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this promotion is archived.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.archived","typeLabel":"boolean"},"code":{"type":"string","description":"The customer-facing code. Regardless of case, this code must be unique across all promotion codes on your account. If left blank, we will generate one automatically.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.code","typeLabel":"string"},"expired":{"type":"boolean","description":"Taking into account the above properties, whether this promotion can still be used.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.expired","typeLabel":"boolean"},"max_redemptions":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed in total across all customers.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.max_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of times this coupon can be redeemed in total across all customers.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.max_redemptions","typeLabel":"integer | null"},"redeem_by":{"oneOf":[{"type":"integer","description":"Date after which the coupon can no longer be redeemed.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.redeem_by.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Date after which the coupon can no longer be redeemed.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.redeem_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.redeem_by","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.archived_at","typeLabel":"integer | null"},"affiliation":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated affiliation ID.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated affiliation object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.object","typeLabel":"string"},"active":{"type":"boolean","description":"Whether or not the affiliate is active.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.active","typeLabel":"boolean"},"affiliation_products":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.affiliation_products.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.affiliation_products.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.affiliation_products","typeLabel":"any | null"},"commission_structure":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.commission_structure.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.commission_structure.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.commission_structure","typeLabel":"any | null"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this affiliation's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this affiliation's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.portal_url","typeLabel":"string | null"},"referral_url":{"type":"string","description":"The referral URL with the affiliate's code appended as a query parameter.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.referral_url","typeLabel":"string"},"total_commission_amount":{"type":"integer","description":"The total commission amount earned by the affiliate.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.total_commission_amount","typeLabel":"integer"},"total_not_paid_commission_amount":{"type":"integer","description":"The total commission amount earned by the affiliate that has not been paid out yet.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.total_not_paid_commission_amount","typeLabel":"integer"},"clicks":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.clicks.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.clicks.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.clicks","typeLabel":"any | null"},"referrals":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.referrals.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.referrals.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.referrals","typeLabel":"any | null"},"payouts":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.payouts.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.payouts.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.payouts","typeLabel":"any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.affiliation","typeLabel":"string | object | null"},"coupon":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated coupon ID.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated coupon object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this coupon is archived.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.archived","typeLabel":"boolean"},"amount_off":{"oneOf":[{"type":"integer","description":"Amount (in the `currency` specified) that will be taken off the subtotal of any checkout.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.amount_off.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Amount (in the `currency` specified) that will be taken off the subtotal of any checkout.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.amount_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.amount_off","typeLabel":"integer | null"},"duration":{"type":"string","description":"One of `forever`, `once`, and `repeating`. Describes how long a discount with this coupon will be applied. (The `repeating` and `forever` values only apply to subscriptions.)","default":"once","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.duration","typeLabel":"string"},"duration_in_months":{"oneOf":[{"type":"integer","description":"If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.duration_in_months.oneOf.0","typeLabel":"integer"},{"type":"null","description":"If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.duration_in_months.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.duration_in_months","typeLabel":"integer | null"},"max_redemptions":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed in total across all customers.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of times this coupon can be redeemed in total across all customers.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_redemptions","typeLabel":"integer | null"},"max_redemptions_per_customer":{"oneOf":[{"type":"integer","description":"Maximum number of times this coupon can be redeemed per customer.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_redemptions_per_customer.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of times this coupon can be redeemed per customer.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_redemptions_per_customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_redemptions_per_customer","typeLabel":"integer | null"},"max_subtotal_amount":{"oneOf":[{"type":"integer","description":"The maximum `subtotal_amount` that is allowed for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_subtotal_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `subtotal_amount` that is allowed for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_subtotal_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.max_subtotal_amount","typeLabel":"integer | null"},"min_subtotal_amount":{"oneOf":[{"type":"integer","description":"The minimum `subtotal_amount` that is required for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.min_subtotal_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `subtotal_amount` that is required for the coupon to be applicable to a checkout or subscription.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.min_subtotal_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.min_subtotal_amount","typeLabel":"integer | null"},"name":{"type":"string","description":"Name of the coupon displayed to customers.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.name","typeLabel":"string"},"percent_off":{"oneOf":[{"type":"number","description":"Percent that will be taken off the subtotal of any checkout. For example, a coupon with percent_off of `50` will make a $100 checkout $50 instead.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.percent_off.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percent that will be taken off the subtotal of any checkout. For example, a coupon with percent_off of `50` will make a $100 checkout $50 instead.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.percent_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.percent_off","typeLabel":"number | null"},"product_ids":{"type":"array","description":"An array of product IDs that this coupon applies to.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.product_ids","typeLabel":"array"},"redeem_by":{"oneOf":[{"type":"integer","description":"Date after which the coupon can no longer be redeemed.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.redeem_by.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Date after which the coupon can no longer be redeemed.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.redeem_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.redeem_by","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.archived_at","typeLabel":"integer | null"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.currency","typeLabel":"string"},"discounts":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.discounts.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.discounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.discounts","typeLabel":"any | null"},"expired":{"type":"boolean","description":"Taking into account the above properties, whether this coupon can still be applied to a checkout.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.expired","typeLabel":"boolean"},"promotions":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.promotions.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.promotions.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.promotions","typeLabel":"any | null"},"times_redeemed":{"type":"integer","description":"Number of times this coupon has been applied to a checkout and/or subscription.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.times_redeemed","typeLabel":"integer"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon.oneOf.1","typeLabel":"object"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.coupon","typeLabel":"string | object"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated customer object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.object","typeLabel":"string"},"affiliation_expires_at":{"oneOf":[{"type":"integer","description":"Time at which the affiliation will expire.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.affiliation_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the affiliation will expire.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.affiliation_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.affiliation_expires_at","typeLabel":"integer | null"},"billing_matches_shipping":{"type":"boolean","description":"If set to `true` the shipping address will be used for the billing address.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.billing_matches_shipping","typeLabel":"boolean"},"email":{"type":"string","description":"The customer’s email address.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.email","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","description":"The customer’s first name.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s first name.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.first_name","typeLabel":"string | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this customer is in live mode, and set to `false` if it is in test mode.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.live_mode","typeLabel":"boolean"},"last_name":{"oneOf":[{"type":"string","description":"The customer’s last name.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s last name.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.last_name","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s full name or business name. If set, this will take precedence over the separate `first_name` and `last_name` attributes.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.name","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The customer’s phone number.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer’s phone number.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.phone","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"Whether or not tax should be calculated for checkouts associated with this customer.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.tax_enabled","typeLabel":"boolean"},"unsubscribed":{"type":"boolean","description":"Set to `true` if this customer has unsubscribed from from opt-in emails (i.e. abandoned cart emails).","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.unsubscribed","typeLabel":"boolean"},"indexed":{"type":"boolean","description":"Whether or not this customer is included in the `/customers` list endpoint. Only customers that have been manually created or have a purchase are indexed.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.indexed","typeLabel":"boolean"},"affiliation":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.affiliation.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.affiliation.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.affiliation","typeLabel":"any | null"},"balances":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.balances.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.balances.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.balances","typeLabel":"any | null"},"billing_address":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.billing_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.billing_address","typeLabel":"any | null"},"default_payment_method":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.default_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.default_payment_method","typeLabel":"any | null"},"default_saved_list":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.default_saved_list.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.default_saved_list","typeLabel":"any | null"},"saved_lists":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.saved_lists.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.saved_lists.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.saved_lists","typeLabel":"any | null"},"licenses":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.licenses.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.licenses.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.licenses","typeLabel":"any | null"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this customer's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this customer's correct portal page (hosted or external).","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.portal_url","typeLabel":"string | null"},"purchases":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.purchases.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.purchases.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.purchases","typeLabel":"any | null"},"shipping_address":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.shipping_address.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.shipping_address","typeLabel":"any | null"},"tax_identifier":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.tax_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.tax_identifier","typeLabel":"any | null"},"reviews":{"oneOf":[{"type":"any","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.reviews.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.reviews.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.reviews","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.customer","typeLabel":"string | object | null"},"discounts":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated discount objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discounts","typeLabel":"string | object | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.promotion.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.promotion.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.promotion.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.promotion","typeLabel":"string | object | null"},"secondary_discounts":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated discount objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.1.secondary_discounts.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.secondary_discounts","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"discount.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"discount.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"discount.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"discount.oneOf.2","typeLabel":"null"}],"uniqueKey":"discount","typeLabel":"string | object | null"},"manual_payment_method":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated manual payment method ID.","uniqueKey":"manual_payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated manual payment method object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"manual_payment_method.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"manual_payment_method.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"manual_payment_method.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this manual payment method is archived.","uniqueKey":"manual_payment_method.oneOf.1.archived","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"The description of this payment method that will be shown in the checkout.","uniqueKey":"manual_payment_method.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of this payment method that will be shown in the checkout.","uniqueKey":"manual_payment_method.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.description","typeLabel":"string | null"},"instructions":{"oneOf":[{"type":"string","description":"The instructions that you want your customers to follow to pay for an order. These instructions are shown on the confirmation page after a customer completes the checkout.","uniqueKey":"manual_payment_method.oneOf.1.instructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"The instructions that you want your customers to follow to pay for an order. These instructions are shown on the confirmation page after a customer completes the checkout.","uniqueKey":"manual_payment_method.oneOf.1.instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.instructions","typeLabel":"string | null"},"name":{"type":"string","description":"The name of this manual payment method.","uniqueKey":"manual_payment_method.oneOf.1.name","typeLabel":"string"},"reuseable":{"type":"boolean","decription":"Whether or not this manual payment method can be reused.","uniqueKey":"manual_payment_method.oneOf.1.reuseable","typeLabel":"boolean"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.archived_at","typeLabel":"integer | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"manual_payment_method.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual_payment_method.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"manual_payment_method.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"manual_payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"manual_payment_method","typeLabel":"string | object | null"},"payment_method":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated payment method ID.","uniqueKey":"payment_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated payment method object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"payment_method.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"payment_method.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"payment_method.oneOf.1.object","typeLabel":"string"},"external_payment_method_id":{"type":"string","description":"The external processor ID representing this payment method.","uniqueKey":"payment_method.oneOf.1.external_payment_method_id","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Set to `true` if this charge is in live mode, and set to `false` if it is in test mode.","uniqueKey":"payment_method.oneOf.1.live_mode","typeLabel":"boolean"},"processor_type":{"type":"string","description":"The specific type of processor. The only allowed processors right now are `stripe` and `paypal`.","uniqueKey":"payment_method.oneOf.1.processor_type","typeLabel":"string"},"reusable":{"type":"boolean","description":"Whether or not this payment method can be reused. Only reusable payment methods can be attached to subscriptions and set as a customer's default.","uniqueKey":"payment_method.oneOf.1.reusable","typeLabel":"boolean"},"supported_currencies":{"oneOf":[{"type":"array","description":"A list of currencies that this payment method supports. If `null`, this payment method supports all currencies.","uniqueKey":"payment_method.oneOf.1.supported_currencies.oneOf.0","typeLabel":"array"},{"type":"null","description":"A list of currencies that this payment method supports. If `null`, this payment method supports all currencies.","uniqueKey":"payment_method.oneOf.1.supported_currencies.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.supported_currencies","typeLabel":"array | null"},"type":{"type":"string","description":"The type of payment method. One of `bank_account, `card`, `payment_instrument`, or `paypal_account`.","uniqueKey":"payment_method.oneOf.1.type","typeLabel":"string"},"bank_account":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated bank account ID.","uniqueKey":"payment_method.oneOf.1.bank_account.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated bank account object.","uniqueKey":"payment_method.oneOf.1.bank_account.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"payment_method.oneOf.1.bank_account.oneOf.2","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.bank_account","typeLabel":"string | any | null"},"card":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated card ID.","uniqueKey":"payment_method.oneOf.1.card.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated card object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.card.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.object","typeLabel":"string"},"brand":{"type":"string","description":"The brand of the card, which can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.brand","typeLabel":"string"},"exp_month":{"type":"integer","description":"Two-digit number representing the card’s expiration month.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.exp_month","typeLabel":"integer"},"exp_year":{"type":"integer","description":"Four-digit number representing the card’s expiration year.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.exp_year","typeLabel":"integer"},"last4":{"type":"string","description":"The last four digits of the card.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.last4","typeLabel":"string"},"wallet_type":{"oneOf":[{"type":"string","description":"If this card is part of a card wallet, this will be set to the type of wallet. The current types are `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.wallet_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"If this card is part of a card wallet, this will be set to the type of wallet. The current types are `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.wallet_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.card.oneOf.1.wallet_type","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.card.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.card.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.card.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"payment_method.oneOf.1.card.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"payment_method.oneOf.1.card.oneOf.2","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.card","typeLabel":"string | object | null"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"payment_method.oneOf.1.customer.oneOf.0","typeLabel":"string"},{},{"type":"null","uniqueKey":"payment_method.oneOf.1.customer.oneOf.2","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.customer","typeLabel":"string | null"},"payment_instrument":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated payment instrument ID.","uniqueKey":"payment_method.oneOf.1.payment_instrument.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated payment instrument object.","uniqueKey":"payment_method.oneOf.1.payment_instrument.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"payment_method.oneOf.1.payment_instrument.oneOf.2","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.payment_instrument","typeLabel":"string | any | null"},"paypal_account":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated paypal account ID.","uniqueKey":"payment_method.oneOf.1.paypal_account.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated paypal account object.","uniqueKey":"payment_method.oneOf.1.paypal_account.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"payment_method.oneOf.1.paypal_account.oneOf.2","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.paypal_account","typeLabel":"string | any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"payment_method.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_method.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"payment_method.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"payment_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"payment_method","typeLabel":"string | object | null"},"periods":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"periods.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated period objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"periods.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"periods.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"periods.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"periods.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"periods.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"periods.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"periods.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"periods.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"periods.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"periods.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"periods.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"periods.oneOf.2","typeLabel":"null"}],"uniqueKey":"periods","typeLabel":"string | object | null"},"price":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"price.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated price object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.object","typeLabel":"string"},"ad_hoc":{"type":"boolean","default":false,"description":"Whether or not this price accepts ad hoc amounts – also known as custom or user-defined amounts.","uniqueKey":"price.oneOf.1.ad_hoc","typeLabel":"boolean"},"ad_hoc_max_amount":{"oneOf":[{"type":"integer","description":"The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`.","uniqueKey":"price.oneOf.1.ad_hoc_max_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`.","uniqueKey":"price.oneOf.1.ad_hoc_max_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.ad_hoc_max_amount","typeLabel":"integer | null"},"ad_hoc_min_amount":{"oneOf":[{"type":"integer","description":"The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`. If left blank, this will be interpreted as `0`.","uniqueKey":"price.oneOf.1.ad_hoc_min_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`. If left blank, this will be interpreted as `0`.","uniqueKey":"price.oneOf.1.ad_hoc_min_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.ad_hoc_min_amount","typeLabel":"integer | null"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged, represented as a whole integer. For example `9900` is equivalent to `$99`. If `ad_hoc=true` the `amount` is optional.","uniqueKey":"price.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged, represented as a whole integer. For example `9900` is equivalent to `$99`. If `ad_hoc=true` the `amount` is optional.","uniqueKey":"price.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.amount","typeLabel":"integer | null"},"archived":{"type":"boolean","description":"Whether or not this price is archived.","uniqueKey":"price.oneOf.1.archived","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, this value will inherit from the value set on `Product`.","uniqueKey":"price.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, this value will inherit from the value set on `Product`.","uniqueKey":"price.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"oneOf":[{"type":"string","description":"The price name, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The price name, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.name","typeLabel":"string | null"},"portal_subscription_update_enabled":{"type":"boolean","description":"Whether existing subscriptions can be switched to this price from the customer dashboard. If set to false, existing subscriptions cannot be switched to this price, preventing customers from upgrading or downgrading their subscription to this price option.","uniqueKey":"price.oneOf.1.portal_subscription_update_enabled","typeLabel":"boolean"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this price when displayed to customers.","uniqueKey":"price.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this price when displayed to customers.","uniqueKey":"price.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.position","typeLabel":"integer | null"},"recurring_interval":{"oneOf":[{"type":"string","description":"The frequency at which a subscription is billed. One of `day`, `week`, `month`, or `year`. Only applicable during creation.","uniqueKey":"price.oneOf.1.recurring_interval.oneOf.0","typeLabel":"string"},{"type":"null","description":"The frequency at which a subscription is billed. One of `day`, `week`, `month`, or `year`. Only applicable during creation.","uniqueKey":"price.oneOf.1.recurring_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.recurring_interval","typeLabel":"string | null"},"recurring_interval_count":{"oneOf":[{"type":"integer","description":"The number of intervals (specified in the `recurring_interval` attribute) between subscription billings. For example, `recurring_interval=month` and `recurring_interval_count=3` bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.","uniqueKey":"price.oneOf.1.recurring_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of intervals (specified in the `recurring_interval` attribute) between subscription billings. For example, `recurring_interval=month` and `recurring_interval_count=3` bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.","uniqueKey":"price.oneOf.1.recurring_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.recurring_interval_count","typeLabel":"integer | null"},"recurring_period_count":{"oneOf":[{"type":"integer","description":"The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the `complete` state. Only applicable during creation.","uniqueKey":"price.oneOf.1.recurring_period_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the `complete` state. Only applicable during creation.","uniqueKey":"price.oneOf.1.recurring_period_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.recurring_period_count","typeLabel":"integer | null"},"revoke_after_days":{"oneOf":[{"type":"integer","description":"The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.","uniqueKey":"price.oneOf.1.revoke_after_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.","uniqueKey":"price.oneOf.1.revoke_after_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.revoke_after_days","typeLabel":"integer | null"},"revoke_purchases_on_completed":{"type":"boolean","description":"Whether or not purchases for this price should be revoked when subscriptions transition to the `complete` state.","uniqueKey":"price.oneOf.1.revoke_purchases_on_completed","typeLabel":"boolean"},"restart_subscription_on_completed":{"type":"boolean","description":"Whether installment subscriptions using this price should be automatically restarted when they reach the completed state.","uniqueKey":"price.oneOf.1.restart_subscription_on_completed","typeLabel":"boolean"},"setup_fee_amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged as a setup fee on the first billing period of a recurring price.","uniqueKey":"price.oneOf.1.setup_fee_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged as a setup fee on the first billing period of a recurring price.","uniqueKey":"price.oneOf.1.setup_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.setup_fee_amount","typeLabel":"integer | null"},"setup_fee_enabled":{"type":"boolean","description":"Whether or not this price has a setup fee.","uniqueKey":"price.oneOf.1.setup_fee_enabled","typeLabel":"boolean"},"setup_fee_name":{"oneOf":[{"type":"string","description":"The name that will display for the setup fee on the first billing period.","uniqueKey":"price.oneOf.1.setup_fee_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name that will display for the setup fee on the first billing period.","uniqueKey":"price.oneOf.1.setup_fee_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.setup_fee_name","typeLabel":"string | null"},"setup_fee_trial_enabled":{"type":"boolean","description":"Whether or not the setup fee should be deferred until the trial period ends. If set to true, the setup fee will not be charged until the trial period ends.","uniqueKey":"price.oneOf.1.setup_fee_trial_enabled","typeLabel":"boolean"},"scratch_amount":{"oneOf":[{"type":"integer","description":"The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.","uniqueKey":"price.oneOf.1.scratch_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.","uniqueKey":"price.oneOf.1.scratch_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.scratch_amount","typeLabel":"integer | null"},"trial_duration_days":{"oneOf":[{"type":"integer","description":"The default number of trial days when subscribing a customer to this price.","uniqueKey":"price.oneOf.1.trial_duration_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The default number of trial days when subscribing a customer to this price.","uniqueKey":"price.oneOf.1.trial_duration_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.trial_duration_days","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"price.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.archived_at","typeLabel":"integer | null"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"price.oneOf.1.currency","typeLabel":"string"},"full_amount":{"type":"integer","description":"The full amount to be charged across all periods, represented as a whole integer. For prices without a `recurring_period_count` defined this is the same as `amount`. For finite prices, this is equal to `amount` * `recurring_period_count`. For example, a price that has an amount of $25 and is set to recur over 4 periods, will have a `full_amount` of $100.","uniqueKey":"price.oneOf.1.full_amount","typeLabel":"integer"},"current_version":{"type":"boolean","description":"Whether or not this object represents the current version of this price. (This will be `false` if the association was created to this price before it was altered. In this case, we will lookup the version of the price at the time it was associated.)","uniqueKey":"price.oneOf.1.current_version","typeLabel":"boolean"},"current_swap":{"oneOf":[{"type":"string","description":"The current swap for this price.\n\n[Expandable](/api-reference/expanding-responses) – The associated swap ID.","uniqueKey":"price.oneOf.1.current_swap.oneOf.0","typeLabel":"string"},{"type":"object","description":"The current swap for this price.\n\n[Expanded](/api-reference/expanding-responses) – The associated swap object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this swap is archived.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.archived","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.description","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.archived_at","typeLabel":"integer | null"},"price":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.price.oneOf.0","typeLabel":"string"},{}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.price","typeLabel":"string"},"swap_price":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.swap_price.oneOf.0","typeLabel":"string"},{}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.swap_price","typeLabel":"string"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.current_swap.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.current_swap.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.current_swap.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.current_swap","typeLabel":"string | object | null"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"price.oneOf.1.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.object","typeLabel":"string"},"allow_out_of_stock_purchases":{"type":"boolean","description":"Whether or not to allow purchases of this product when stock runs out. If true, the stock levels for this can go below zero.","uniqueKey":"price.oneOf.1.product.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean"},"archived":{"type":"boolean","description":"Whether or not this product is archived.","uniqueKey":"price.oneOf.1.product.oneOf.1.archived","typeLabel":"boolean"},"auto_fulfill_enabled":{"type":"boolean","description":"Whether or not this product should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`.","uniqueKey":"price.oneOf.1.product.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean"},"cataloged_at":{"type":"integer","description":"The time when the product was added or made available. This value is used for sorting products on shop pages.","uniqueKey":"price.oneOf.1.product.oneOf.1.cataloged_at","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","description":"The product description, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product description, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.description","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.dimensions","typeLabel":"object | null"},"featured":{"type":"boolean","description":"Whether or not this product is featured.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured","typeLabel":"boolean"},"licensing_enabled":{"type":"boolean","description":"Whether or not licensing is enabled for this product.","uniqueKey":"price.oneOf.1.product.oneOf.1.licensing_enabled","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"price.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"price.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"type":"string","description":"The product name, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.product.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"price.oneOf.1.product.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"price.oneOf.1.product.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.purchase_limit","typeLabel":"integer | null"},"recurring":{"type":"boolean","default":false,"description":"Whether the product is for a one-time purchase or a recurring (subscription) purchase.","uniqueKey":"price.oneOf.1.product.oneOf.1.recurring","typeLabel":"boolean"},"reviews_enabled":{"type":"boolean","description":"Whether or not reviews are enabled for this product.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews_enabled","typeLabel":"boolean"},"shipping_enabled":{"type":"boolean","description":"If set to `true` checkouts with this product will require a full shipping address.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_enabled","typeLabel":"boolean"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"price.oneOf.1.product.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"price.oneOf.1.product.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.sku","typeLabel":"string | null"},"status":{"type":"string","description":"The status of this product – one of `draft` or `published`.","uniqueKey":"price.oneOf.1.product.oneOf.1.status","typeLabel":"string"},"slug":{"type":"string","description":"A unique and URL friendly string that represents this product. (This will be auto-generated when a product is created if not explicitly set.)","uniqueKey":"price.oneOf.1.product.oneOf.1.slug","typeLabel":"string"},"solicit_reviews":{"type":"boolean","description":"Whether or not to solicit reviews for this product with automatic emails to customers.","uniqueKey":"price.oneOf.1.product.oneOf.1.solicit_reviews","typeLabel":"boolean"},"stock_enabled":{"type":"boolean","description":"Whether or not stock will be tracked for this product.","uniqueKey":"price.oneOf.1.product.oneOf.1.stock_enabled","typeLabel":"boolean"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"price.oneOf.1.product.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"price.oneOf.1.product.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"If set to `true` this product is considered taxable.","uniqueKey":"price.oneOf.1.product.oneOf.1.tax_enabled","typeLabel":"boolean"},"weight":{"type":"number","description":"The product weight, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.product.oneOf.1.weight","typeLabel":"number"},"weight_unit":{"type":"string","description":"The weight unit for this product – one of `lb`, `oz`, `kg`, `g`.","uniqueKey":"price.oneOf.1.product.oneOf.1.weight_unit","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"price.oneOf.1.product.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.archived_at","typeLabel":"integer | null"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"price.oneOf.1.product.oneOf.1.available_stock","typeLabel":"integer"},"average_stars":{"type":"string","description":"The average stars for this product based on published reviews.","uniqueKey":"price.oneOf.1.product.oneOf.1.average_stars","typeLabel":"string"},"bundle_items":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated bundle item objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.bundle_items","typeLabel":"string | object | null"},"commission_structure":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated commission structure ID.","uniqueKey":"price.oneOf.1.product.oneOf.1.commission_structure.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated commission structure object.","uniqueKey":"price.oneOf.1.product.oneOf.1.commission_structure.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.commission_structure.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.commission_structure","typeLabel":"string | any | null"},"current_release_download":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated download ID.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated download object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.object","typeLabel":"string"},"alt":{"oneOf":[{"type":"string","description":"The HTML alt attribute for the download.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.alt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML alt attribute for the download.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.alt","typeLabel":"string | null"},"archived":{"type":"boolean","description":"Whether or not this download is archived.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"The name of this download which will be visible to customers. This is required if a `url` is used instead of attaching a `Media` record.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of this download which will be visible to customers. This is required if a `url` is used instead of attaching a `Media` record.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.name","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The HTML title attribute for the download.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML title attribute for the download.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.title","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Instead of attaching a `Media` record a public URL can be set. If set, customers will be directed to this URL.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instead of attaching a `Media` record a public URL can be set. If set, customers will be directed to this URL.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.url","typeLabel":"string | null"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived_at","typeLabel":"integer | null"},"media":{"oneOf":[{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.media.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.media","typeLabel":"any | null"},"product":{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.product","typeLabel":"any"},"variant":{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.variant","typeLabel":"any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.current_release_download","typeLabel":"string | object | null"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"price.oneOf.1.product.oneOf.1.held_stock","typeLabel":"integer"},"metrics":{"type":"object","properties":{"currency":{"type":"string","description":"The currency that was used to calculate these metrics. This will always be set to the account's currency.","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.currency","typeLabel":"string"},"max_price_amount":{"oneOf":[{"type":"integer","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.max_price_amount","typeLabel":"integer | null"},"min_price_amount":{"oneOf":[{"type":"integer","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.min_price_amount","typeLabel":"integer | null"},"prices_count":{"oneOf":[{"type":"integer","description":"The total number of prices that belong to this product.","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The total number of prices that belong to this product.","uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.metrics.prices_count","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.metrics","typeLabel":"object"},"downloads":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated download objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.downloads.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.downloads","typeLabel":"string | object | null"},"reviews_breakdown":{"type":"object","description":"A histogram breakdown of the reviews for this product.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews_breakdown","typeLabel":"object"},"featured_product_media":{"oneOf":[{"type":"string","description":"The featured (first) product media.\n\n[Expandable](/api-reference/expanding-responses) – The associated product media ID.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.0","typeLabel":"string"},{"type":"object","description":"The featured (first) product media.\n\n[Expanded](/api-reference/expanding-responses) – The associated product media object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.object","typeLabel":"string"},"alt":{"oneOf":[{"type":"string","description":"The HTML alt attribute for the product media.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.alt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML alt attribute for the product media.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.alt","typeLabel":"string | null"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this product media when displayed to customers.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this product media when displayed to customers.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.position","typeLabel":"integer | null"},"title":{"oneOf":[{"type":"string","description":"The HTML title attribute for the product media.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML title attribute for the product media.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.title","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Instead of attaching a `Media` record, a public URL can be set. If set, this URL will be used to serve the product media asset.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instead of attaching a `Media` record, a public URL can be set. If set, this URL will be used to serve the product media asset.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.url","typeLabel":"string | null"},"media":{"oneOf":[{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.media.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.media","typeLabel":"any | null"},"product":{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.product","typeLabel":"any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.featured_product_media","typeLabel":"string | object | null"},"prices":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated price objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.prices.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.prices","typeLabel":"string | object | null"},"product_collections":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated product collection objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_collections","typeLabel":"string | object | null"},"product_group":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product group ID.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product group object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this product group is archived.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived","typeLabel":"boolean"},"name":{"type":"string","description":"The product group’s name, meant to be displayable to the customer.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product group can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product group can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.purchase_limit","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived_at","typeLabel":"integer | null"},"products":{"oneOf":[{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.products.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.products","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.product_group.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_group","typeLabel":"string | object | null"},"product_medias":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated product media objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.product_medias","typeLabel":"string | object | null"},"shipping_profile":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated shipping profile ID.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated shipping profile object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.object","typeLabel":"string"},"name":{"type":"string","description":"A name for this shipping profile that will be visible to customers.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.name","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.metadata","typeLabel":"object"},"default":{"type":"boolean","description":"Whether or not this shipping profile is the default for the account.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.default","typeLabel":"boolean"},"fallback_shipping_zone":{"oneOf":[{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.fallback_shipping_zone.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.fallback_shipping_zone.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.fallback_shipping_zone","typeLabel":"any | null"},"products":{"oneOf":[{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.products.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.products","typeLabel":"any | null"},"shipping_zones":{"oneOf":[{"type":"any","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.shipping_zones.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.shipping_zones.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.shipping_zones","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.shipping_profile","typeLabel":"string | object | null"},"stock":{"type":"integer","description":"The total amount of stock on hand for this variant.","uniqueKey":"price.oneOf.1.product.oneOf.1.stock","typeLabel":"integer"},"reviews":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated review objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.reviews.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.reviews","typeLabel":"string | object | null"},"variant_options":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated variant option objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.variant_options","typeLabel":"string | object | null"},"variants":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated variant objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"price.oneOf.1.product.oneOf.1.variants.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.variants","typeLabel":"string | object | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.product.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.product.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1.product.oneOf.1","typeLabel":"object"}],"uniqueKey":"price.oneOf.1.product","typeLabel":"string | object"},"renewal_price":{"oneOf":[{"type":"string","description":"If present, subscriptions will be updated to this price when they renew.\n\n[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"price.oneOf.1.renewal_price.oneOf.0","typeLabel":"string"},{"description":"If present, subscriptions will be updated to this price when they renew.\n\n[Expanded](/api-reference/expanding-responses) – The associated price object.","uniqueKey":"price.oneOf.1.renewal_price.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"price.oneOf.1.renewal_price.oneOf.2","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.renewal_price","typeLabel":"string | any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"price.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"price.oneOf.1","typeLabel":"object"}],"uniqueKey":"price","typeLabel":"string | object"},"purchase":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated purchase ID.","uniqueKey":"purchase.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated purchase object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.object","typeLabel":"string"},"revoke_at":{"oneOf":[{"type":"integer","description":"Time at which the purchase should be revoked.","uniqueKey":"purchase.oneOf.1.revoke_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the purchase should be revoked.","uniqueKey":"purchase.oneOf.1.revoke_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.revoke_at","typeLabel":"integer | null"},"live_mode":{"type":"boolean","description":"Set to `true` if this purchase is in live mode, and set to `false` if it is in test mode.","uniqueKey":"purchase.oneOf.1.live_mode","typeLabel":"boolean"},"revoked":{"type":"boolean","description":"Whether or not this purchase is revoked.","uniqueKey":"purchase.oneOf.1.revoked","typeLabel":"boolean"},"revoked_at":{"oneOf":[{"type":"integer","description":"Time at which the purchase was revoked. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.revoked_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the purchase was revoked. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.revoked_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.revoked_at","typeLabel":"integer | null"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"purchase.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated customer object.","uniqueKey":"purchase.oneOf.1.customer.oneOf.1","typeLabel":"any"}],"uniqueKey":"purchase.oneOf.1.customer","typeLabel":"string | any"},"initial_order":{"oneOf":[{"type":"string","description":"The first order that initiated this purchase.\n\n[Expandable](/api-reference/expanding-responses) – The associated order ID.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.0","typeLabel":"string"},{"type":"object","description":"The first order that initiated this purchase.\n\n[Expanded](/api-reference/expanding-responses) – The associated order object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.object","typeLabel":"string"},"checkout":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated checkout ID.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.checkout.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated checkout object.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.checkout.oneOf.1","typeLabel":"any"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.checkout","typeLabel":"string | any"},"fulfillment_status":{"type":"string","description":"The overall fulfillment status of this order based on all fulfillments – one of `fulfilled`, `partially_fulfilled`, or `unfulfilled`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillment_status","typeLabel":"string"},"live_mode":{"type":"boolean","description":"Set to `true` if this order is in live mode, and set to `false` if it is in test mode.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.live_mode","typeLabel":"boolean"},"number":{"type":"string","description":"The unique identifier for this order that is auto generated based on this account's order protocol.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.number","typeLabel":"string"},"order_type":{"type":"string","description":"One of either `checkout` or `subscription`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.order_type","typeLabel":"string"},"portal_url":{"oneOf":[{"type":"string","description":"A URL that will redirect to this order's correct portal page (hosted or external).","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.portal_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL that will redirect to this order's correct portal page (hosted or external).","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.portal_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.portal_url","typeLabel":"string | null"},"return_status":{"type":"string","description":"The overall return status of this order based on all return requests – one of `not_returned`, `partially_returned`, `return_request_open`, or `returned`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.return_status","typeLabel":"string"},"shipment_status":{"type":"string","description":"The overall shipment status of this order based on all fulfillments – one of `unshippable`, `unshipped`, `partially_shipped`, `label_purchased`, `shipped`, `in_transit`, or `delivered`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.shipment_status","typeLabel":"string"},"statement_url":{"oneOf":[{"type":"string","description":"The link to view and download the \"invoice\" or \"receipt\" statement of this order.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.statement_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link to view and download the \"invoice\" or \"receipt\" statement of this order.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.statement_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.statement_url","typeLabel":"string | null"},"status":{"type":"string","description":"The current status of this order, which can be one of `draft`, `paid`, `payment_failed`, `processing`, or `void`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.status","typeLabel":"string"},"fulfillments":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated fulfillment objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.fulfillments","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.initial_order.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.initial_order.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.initial_order","typeLabel":"string | object | null"},"license":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated license ID.","uniqueKey":"purchase.oneOf.1.license.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated license object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.object","typeLabel":"string"},"activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed. If set to `null` then unlimited activations are allowed.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed. If set to `null` then unlimited activations are allowed.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.activation_limit","typeLabel":"integer | null"},"key":{"type":"string","description":"The unique identifier for this license. The default generated value is a UUID, but this can be set to any unique value within the scope of this account.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.key","typeLabel":"string"},"activations_count":{"type":"integer","description":"The current number of activations.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations_count","typeLabel":"integer"},"revokes_at":{"oneOf":[{"type":"integer","description":"Time at which the license will be revoked. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.revokes_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the license will be revoked. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.revokes_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.revokes_at","typeLabel":"integer | null"},"status":{"type":"string","description":"The status of this license which is one of `active`, `inactive`, or `revoked`. If the associated purchase is revoked then the license will be `revoked`. If the license has one or more activations then it will be `active`, otherwise it will be `inactive`.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.status","typeLabel":"string"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated customer object.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.customer.oneOf.1","typeLabel":"any"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.customer","typeLabel":"string | any"},"purchase":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated purchase ID.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.purchase.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated purchase object.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.purchase.oneOf.1","typeLabel":"any"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.purchase","typeLabel":"string | any"},"activations":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated activation objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.activations","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.license.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.license.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.license.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license","typeLabel":"string | object | null"},"license_key":{"oneOf":[{"type":"string","description":"License key for subscriptions","uniqueKey":"purchase.oneOf.1.license_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"License key for subscriptions","uniqueKey":"purchase.oneOf.1.license_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.license_key","typeLabel":"string | null"},"interpreted_downloads":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The resolved downloads for this purchase. Returns variant downloads when the variant has downloads, falls back to product downloads otherwise.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.interpreted_downloads.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.interpreted_downloads","typeLabel":"string | object | null"},"line_items":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated line item objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.line_items.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.line_items.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.line_items.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.line_items","typeLabel":"string | object | null"},"price":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"purchase.oneOf.1.price.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated price object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.object","typeLabel":"string"},"ad_hoc":{"type":"boolean","default":false,"description":"Whether or not this price accepts ad hoc amounts – also known as custom or user-defined amounts.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc","typeLabel":"boolean"},"ad_hoc_max_amount":{"oneOf":[{"type":"integer","description":"The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc_max_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc_max_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc_max_amount","typeLabel":"integer | null"},"ad_hoc_min_amount":{"oneOf":[{"type":"integer","description":"The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`. If left blank, this will be interpreted as `0`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc_min_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum ad hoc amount in cents to be allowed, represented as a whole integer. For example `9900` is equivalent to `$99`. If left blank, this will be interpreted as `0`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc_min_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.ad_hoc_min_amount","typeLabel":"integer | null"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged, represented as a whole integer. For example `9900` is equivalent to `$99`. If `ad_hoc=true` the `amount` is optional.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged, represented as a whole integer. For example `9900` is equivalent to `$99`. If `ad_hoc=true` the `amount` is optional.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.amount","typeLabel":"integer | null"},"archived":{"type":"boolean","description":"Whether or not this price is archived.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.archived","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, this value will inherit from the value set on `Product`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, this value will inherit from the value set on `Product`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"oneOf":[{"type":"string","description":"The price name, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The price name, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.name","typeLabel":"string | null"},"portal_subscription_update_enabled":{"type":"boolean","description":"Whether existing subscriptions can be switched to this price from the customer dashboard. If set to false, existing subscriptions cannot be switched to this price, preventing customers from upgrading or downgrading their subscription to this price option.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.portal_subscription_update_enabled","typeLabel":"boolean"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this price when displayed to customers.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this price when displayed to customers.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.position","typeLabel":"integer | null"},"recurring_interval":{"oneOf":[{"type":"string","description":"The frequency at which a subscription is billed. One of `day`, `week`, `month`, or `year`. Only applicable during creation.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_interval.oneOf.0","typeLabel":"string"},{"type":"null","description":"The frequency at which a subscription is billed. One of `day`, `week`, `month`, or `year`. Only applicable during creation.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_interval","typeLabel":"string | null"},"recurring_interval_count":{"oneOf":[{"type":"integer","description":"The number of intervals (specified in the `recurring_interval` attribute) between subscription billings. For example, `recurring_interval=month` and `recurring_interval_count=3` bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of intervals (specified in the `recurring_interval` attribute) between subscription billings. For example, `recurring_interval=month` and `recurring_interval_count=3` bills every 3 months. The total duration of a billing cycle is not allowed to exceed 1 year. Only applicable during creation.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_interval_count","typeLabel":"integer | null"},"recurring_period_count":{"oneOf":[{"type":"integer","description":"The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the `complete` state. Only applicable during creation.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_period_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of periods a subscription with this price will renew for. After this amount of periods, the subscription will move to the `complete` state. Only applicable during creation.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_period_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.recurring_period_count","typeLabel":"integer | null"},"revoke_after_days":{"oneOf":[{"type":"integer","description":"The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.revoke_after_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of days after which the purchase associated with this price will be automatically revoked. This can be used to create time-limited access for a one-time or finite recurring price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.revoke_after_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.revoke_after_days","typeLabel":"integer | null"},"revoke_purchases_on_completed":{"type":"boolean","description":"Whether or not purchases for this price should be revoked when subscriptions transition to the `complete` state.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.revoke_purchases_on_completed","typeLabel":"boolean"},"restart_subscription_on_completed":{"type":"boolean","description":"Whether installment subscriptions using this price should be automatically restarted when they reach the completed state.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.restart_subscription_on_completed","typeLabel":"boolean"},"setup_fee_amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged as a setup fee on the first billing period of a recurring price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged as a setup fee on the first billing period of a recurring price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_amount","typeLabel":"integer | null"},"setup_fee_enabled":{"type":"boolean","description":"Whether or not this price has a setup fee.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_enabled","typeLabel":"boolean"},"setup_fee_name":{"oneOf":[{"type":"string","description":"The name that will display for the setup fee on the first billing period.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name that will display for the setup fee on the first billing period.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_name","typeLabel":"string | null"},"setup_fee_trial_enabled":{"type":"boolean","description":"Whether or not the setup fee should be deferred until the trial period ends. If set to true, the setup fee will not be charged until the trial period ends.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.setup_fee_trial_enabled","typeLabel":"boolean"},"scratch_amount":{"oneOf":[{"type":"integer","description":"The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.scratch_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents that should be shown as the original amount before any price reductions, also known as the pre-sale price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.scratch_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.scratch_amount","typeLabel":"integer | null"},"trial_duration_days":{"oneOf":[{"type":"integer","description":"The default number of trial days when subscribing a customer to this price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.trial_duration_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The default number of trial days when subscribing a customer to this price.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.trial_duration_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.trial_duration_days","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.archived_at","typeLabel":"integer | null"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This value will match the `Account` currency.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.currency","typeLabel":"string"},"full_amount":{"type":"integer","description":"The full amount to be charged across all periods, represented as a whole integer. For prices without a `recurring_period_count` defined this is the same as `amount`. For finite prices, this is equal to `amount` * `recurring_period_count`. For example, a price that has an amount of $25 and is set to recur over 4 periods, will have a `full_amount` of $100.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.full_amount","typeLabel":"integer"},"current_version":{"type":"boolean","description":"Whether or not this object represents the current version of this price. (This will be `false` if the association was created to this price before it was altered. In this case, we will lookup the version of the price at the time it was associated.)","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_version","typeLabel":"boolean"},"current_swap":{"oneOf":[{"type":"string","description":"The current swap for this price.\n\n[Expandable](/api-reference/expanding-responses) – The associated swap ID.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.0","typeLabel":"string"},{"type":"object","description":"The current swap for this price.\n\n[Expanded](/api-reference/expanding-responses) – The associated swap object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this swap is archived.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","description":"A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of this swap. This text will be visibile to customers in the checkout summary when offered the swap.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.description","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.archived_at","typeLabel":"integer | null"},"price":{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.price","typeLabel":"any"},"swap_price":{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.swap_price","typeLabel":"any"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.current_swap","typeLabel":"string | object | null"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.object","typeLabel":"string"},"allow_out_of_stock_purchases":{"type":"boolean","description":"Whether or not to allow purchases of this product when stock runs out. If true, the stock levels for this can go below zero.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean"},"archived":{"type":"boolean","description":"Whether or not this product is archived.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.archived","typeLabel":"boolean"},"auto_fulfill_enabled":{"type":"boolean","description":"Whether or not this product should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean"},"cataloged_at":{"type":"integer","description":"The time when the product was added or made available. This value is used for sorting products on shop pages.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.cataloged_at","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","description":"The product description, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product description, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.description","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.dimensions","typeLabel":"object | null"},"featured":{"type":"boolean","description":"Whether or not this product is featured.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.featured","typeLabel":"boolean"},"licensing_enabled":{"type":"boolean","description":"Whether or not licensing is enabled for this product.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.licensing_enabled","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"type":"string","description":"The product name, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.purchase_limit","typeLabel":"integer | null"},"recurring":{"type":"boolean","default":false,"description":"Whether the product is for a one-time purchase or a recurring (subscription) purchase.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.recurring","typeLabel":"boolean"},"reviews_enabled":{"type":"boolean","description":"Whether or not reviews are enabled for this product.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.reviews_enabled","typeLabel":"boolean"},"shipping_enabled":{"type":"boolean","description":"If set to `true` checkouts with this product will require a full shipping address.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_enabled","typeLabel":"boolean"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.sku","typeLabel":"string | null"},"status":{"type":"string","description":"The status of this product – one of `draft` or `published`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.status","typeLabel":"string"},"slug":{"type":"string","description":"A unique and URL friendly string that represents this product. (This will be auto-generated when a product is created if not explicitly set.)","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.slug","typeLabel":"string"},"solicit_reviews":{"type":"boolean","description":"Whether or not to solicit reviews for this product with automatic emails to customers.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.solicit_reviews","typeLabel":"boolean"},"stock_enabled":{"type":"boolean","description":"Whether or not stock will be tracked for this product.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.stock_enabled","typeLabel":"boolean"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"If set to `true` this product is considered taxable.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.tax_enabled","typeLabel":"boolean"},"weight":{"type":"number","description":"The product weight, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.weight","typeLabel":"number"},"weight_unit":{"type":"string","description":"The weight unit for this product – one of `lb`, `oz`, `kg`, `g`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.weight_unit","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.archived_at","typeLabel":"integer | null"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.available_stock","typeLabel":"integer"},"average_stars":{"type":"string","description":"The average stars for this product based on published reviews.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.average_stars","typeLabel":"string"},"bundle_items":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.bundle_items.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.bundle_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.bundle_items","typeLabel":"any | null"},"commission_structure":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.commission_structure.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.commission_structure.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.commission_structure","typeLabel":"any | null"},"current_release_download":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.current_release_download.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.current_release_download.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.current_release_download","typeLabel":"any | null"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.held_stock","typeLabel":"integer"},"metrics":{"type":"object","properties":{"currency":{"type":"string","description":"The currency that was used to calculate these metrics. This will always be set to the account's currency.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.currency","typeLabel":"string"},"max_price_amount":{"oneOf":[{"type":"integer","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.max_price_amount","typeLabel":"integer | null"},"min_price_amount":{"oneOf":[{"type":"integer","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.min_price_amount","typeLabel":"integer | null"},"prices_count":{"oneOf":[{"type":"integer","description":"The total number of prices that belong to this product.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The total number of prices that belong to this product.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics.prices_count","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.metrics","typeLabel":"object"},"downloads":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.downloads.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.downloads.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.downloads","typeLabel":"any | null"},"reviews_breakdown":{"type":"object","description":"A histogram breakdown of the reviews for this product.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.reviews_breakdown","typeLabel":"object"},"featured_product_media":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.featured_product_media","typeLabel":"any | null"},"prices":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.prices.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.prices.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.prices","typeLabel":"any | null"},"product_collections":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_collections.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_collections","typeLabel":"any | null"},"product_group":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_group.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_group","typeLabel":"any | null"},"product_medias":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_medias.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_medias.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.product_medias","typeLabel":"any | null"},"shipping_profile":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.shipping_profile","typeLabel":"any | null"},"stock":{"type":"integer","description":"The total amount of stock on hand for this variant.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.stock","typeLabel":"integer"},"reviews":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.reviews.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.reviews.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.reviews","typeLabel":"any | null"},"variant_options":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.variant_options.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.variant_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.variant_options","typeLabel":"any | null"},"variants":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.variants.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.variants.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.variants","typeLabel":"any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product.oneOf.1","typeLabel":"object"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.product","typeLabel":"string | object"},"renewal_price":{"oneOf":[{"type":"string","description":"If present, subscriptions will be updated to this price when they renew.\n\n[Expandable](/api-reference/expanding-responses) – The associated price ID.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.renewal_price.oneOf.0","typeLabel":"string"},{"description":"If present, subscriptions will be updated to this price when they renew.\n\n[Expanded](/api-reference/expanding-responses) – The associated price object.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.renewal_price.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.price.oneOf.1.renewal_price.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.renewal_price","typeLabel":"string | any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.price.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.price.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.price.oneOf.1","typeLabel":"object"}],"uniqueKey":"purchase.oneOf.1.price","typeLabel":"string | object"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"purchase.oneOf.1.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.object","typeLabel":"string"},"allow_out_of_stock_purchases":{"type":"boolean","description":"Whether or not to allow purchases of this product when stock runs out. If true, the stock levels for this can go below zero.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean"},"archived":{"type":"boolean","description":"Whether or not this product is archived.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.archived","typeLabel":"boolean"},"auto_fulfill_enabled":{"type":"boolean","description":"Whether or not this product should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean"},"cataloged_at":{"type":"integer","description":"The time when the product was added or made available. This value is used for sorting products on shop pages.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.cataloged_at","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","description":"The product description, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product description, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.description","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.dimensions","typeLabel":"object | null"},"featured":{"type":"boolean","description":"Whether or not this product is featured.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured","typeLabel":"boolean"},"licensing_enabled":{"type":"boolean","description":"Whether or not licensing is enabled for this product.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.licensing_enabled","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"purchase.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"purchase.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"type":"string","description":"The product name, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.purchase_limit","typeLabel":"integer | null"},"recurring":{"type":"boolean","default":false,"description":"Whether the product is for a one-time purchase or a recurring (subscription) purchase.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.recurring","typeLabel":"boolean"},"reviews_enabled":{"type":"boolean","description":"Whether or not reviews are enabled for this product.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews_enabled","typeLabel":"boolean"},"shipping_enabled":{"type":"boolean","description":"If set to `true` checkouts with this product will require a full shipping address.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_enabled","typeLabel":"boolean"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.sku","typeLabel":"string | null"},"status":{"type":"string","description":"The status of this product – one of `draft` or `published`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.status","typeLabel":"string"},"slug":{"type":"string","description":"A unique and URL friendly string that represents this product. (This will be auto-generated when a product is created if not explicitly set.)","uniqueKey":"purchase.oneOf.1.product.oneOf.1.slug","typeLabel":"string"},"solicit_reviews":{"type":"boolean","description":"Whether or not to solicit reviews for this product with automatic emails to customers.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.solicit_reviews","typeLabel":"boolean"},"stock_enabled":{"type":"boolean","description":"Whether or not stock will be tracked for this product.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.stock_enabled","typeLabel":"boolean"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"If set to `true` this product is considered taxable.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.tax_enabled","typeLabel":"boolean"},"weight":{"type":"number","description":"The product weight, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.weight","typeLabel":"number"},"weight_unit":{"type":"string","description":"The weight unit for this product – one of `lb`, `oz`, `kg`, `g`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.weight_unit","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.archived_at","typeLabel":"integer | null"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.available_stock","typeLabel":"integer"},"average_stars":{"type":"string","description":"The average stars for this product based on published reviews.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.average_stars","typeLabel":"string"},"bundle_items":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated bundle item objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.bundle_items","typeLabel":"string | object | null"},"commission_structure":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated commission structure ID.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.commission_structure.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated commission structure object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.commission_structure.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.commission_structure.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.commission_structure","typeLabel":"string | any | null"},"current_release_download":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated download ID.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated download object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.object","typeLabel":"string"},"alt":{"oneOf":[{"type":"string","description":"The HTML alt attribute for the download.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.alt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML alt attribute for the download.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.alt","typeLabel":"string | null"},"archived":{"type":"boolean","description":"Whether or not this download is archived.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"The name of this download which will be visible to customers. This is required if a `url` is used instead of attaching a `Media` record.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of this download which will be visible to customers. This is required if a `url` is used instead of attaching a `Media` record.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.name","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The HTML title attribute for the download.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML title attribute for the download.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.title","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Instead of attaching a `Media` record a public URL can be set. If set, customers will be directed to this URL.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instead of attaching a `Media` record a public URL can be set. If set, customers will be directed to this URL.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.url","typeLabel":"string | null"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.archived_at","typeLabel":"integer | null"},"media":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.media.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.media","typeLabel":"any | null"},"product":{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.product","typeLabel":"any"},"variant":{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.variant","typeLabel":"any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.current_release_download","typeLabel":"string | object | null"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.held_stock","typeLabel":"integer"},"metrics":{"type":"object","properties":{"currency":{"type":"string","description":"The currency that was used to calculate these metrics. This will always be set to the account's currency.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.currency","typeLabel":"string"},"max_price_amount":{"oneOf":[{"type":"integer","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.max_price_amount","typeLabel":"integer | null"},"min_price_amount":{"oneOf":[{"type":"integer","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.min_price_amount","typeLabel":"integer | null"},"prices_count":{"oneOf":[{"type":"integer","description":"The total number of prices that belong to this product.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The total number of prices that belong to this product.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics.prices_count","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.metrics","typeLabel":"object"},"downloads":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated download objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.downloads","typeLabel":"string | object | null"},"reviews_breakdown":{"type":"object","description":"A histogram breakdown of the reviews for this product.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews_breakdown","typeLabel":"object"},"featured_product_media":{"oneOf":[{"type":"string","description":"The featured (first) product media.\n\n[Expandable](/api-reference/expanding-responses) – The associated product media ID.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.0","typeLabel":"string"},{"type":"object","description":"The featured (first) product media.\n\n[Expanded](/api-reference/expanding-responses) – The associated product media object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.object","typeLabel":"string"},"alt":{"oneOf":[{"type":"string","description":"The HTML alt attribute for the product media.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.alt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML alt attribute for the product media.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.alt","typeLabel":"string | null"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this product media when displayed to customers.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this product media when displayed to customers.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.position","typeLabel":"integer | null"},"title":{"oneOf":[{"type":"string","description":"The HTML title attribute for the product media.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HTML title attribute for the product media.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.title","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Instead of attaching a `Media` record, a public URL can be set. If set, this URL will be used to serve the product media asset.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Instead of attaching a `Media` record, a public URL can be set. If set, this URL will be used to serve the product media asset.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.url","typeLabel":"string | null"},"media":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.media.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.media","typeLabel":"any | null"},"product":{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.product","typeLabel":"any"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.featured_product_media","typeLabel":"string | object | null"},"prices":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated price objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.prices","typeLabel":"string | object | null"},"product_collections":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated product collection objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_collections","typeLabel":"string | object | null"},"product_group":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product group ID.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product group object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.object","typeLabel":"string"},"archived":{"type":"boolean","description":"Whether or not this product group is archived.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived","typeLabel":"boolean"},"name":{"type":"string","description":"The product group’s name, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product group can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product group can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.purchase_limit","typeLabel":"integer | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.archived_at","typeLabel":"integer | null"},"products":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.products.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.products","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_group","typeLabel":"string | object | null"},"product_medias":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated product media objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.product_medias","typeLabel":"string | object | null"},"shipping_profile":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated shipping profile ID.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated shipping profile object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.object","typeLabel":"string"},"name":{"type":"string","description":"A name for this shipping profile that will be visible to customers.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.name","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.metadata","typeLabel":"object"},"default":{"type":"boolean","description":"Whether or not this shipping profile is the default for the account.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.default","typeLabel":"boolean"},"fallback_shipping_zone":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.fallback_shipping_zone.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.fallback_shipping_zone.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.fallback_shipping_zone","typeLabel":"any | null"},"products":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.products.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.products","typeLabel":"any | null"},"shipping_zones":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.shipping_zones.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.shipping_zones.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.shipping_zones","typeLabel":"any | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.shipping_profile","typeLabel":"string | object | null"},"stock":{"type":"integer","description":"The total amount of stock on hand for this variant.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.stock","typeLabel":"integer"},"reviews":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated review objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.reviews","typeLabel":"string | object | null"},"variant_options":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated variant option objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variant_options","typeLabel":"string | object | null"},"variants":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated variant objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.variants","typeLabel":"string | object | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.product.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.product.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.product.oneOf.1","typeLabel":"object"}],"uniqueKey":"purchase.oneOf.1.product","typeLabel":"string | object"},"subscription":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated subscription ID.","uniqueKey":"purchase.oneOf.1.subscription.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated subscription object.","uniqueKey":"purchase.oneOf.1.subscription.oneOf.1","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.subscription.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.subscription","typeLabel":"string | any | null"},"variant":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated variant ID.","uniqueKey":"purchase.oneOf.1.variant.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated variant object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.object","typeLabel":"string"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular `Price` amount will be used. If the `Product` has multiple prices, then this amount will be ignored and the selected `Price` amount will be used.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular `Price` amount will be used. If the `Product` has multiple prices, then this amount will be ignored and the selected `Price` amount will be used.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.amount","typeLabel":"integer | null"},"allow_out_of_stock_purchases":{"oneOf":[{"type":"boolean","description":"Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.allow_out_of_stock_purchases.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.allow_out_of_stock_purchases.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean | null"},"auto_fulfill_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not this variant should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.auto_fulfill_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not this variant should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.auto_fulfill_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this variant. If `null`, inherits from the product.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this variant. If `null`, inherits from the product.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.dimensions","typeLabel":"object | null"},"downloads_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not downloads are enabled for this variant. When `false`, downloads will be disabled for this variant. When `true`, the downloads that are set for this variant will override the product downloads. If no downloads are set, then the product downloads will be used.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.downloads_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not downloads are enabled for this variant. When `false`, downloads will be disabled for this variant. When `true`, the downloads that are set for this variant will override the product downloads. If no downloads are set, then the product downloads will be used.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.downloads_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.downloads_enabled","typeLabel":"boolean | null"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, inherits from the product or price.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, inherits from the product or price.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"option_1":{"type":"string","description":"The value for the first variant option.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_1","typeLabel":"string"},"option_2":{"oneOf":[{"type":"string","description":"The value for the second variant option.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value for the second variant option.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_2","typeLabel":"string | null"},"option_3":{"oneOf":[{"type":"string","description":"The value for the third variant option.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value for the third variant option.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_3.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_3","typeLabel":"string | null"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this variant when displayed to customers.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this variant when displayed to customers.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.position","typeLabel":"integer | null"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times this variant can be purchased by a customer. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times this variant can be purchased by a customer. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.purchase_limit","typeLabel":"integer | null"},"shipping_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true` checkouts with this variant will require a full shipping address. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.shipping_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true` checkouts with this variant will require a full shipping address. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.shipping_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.shipping_enabled","typeLabel":"boolean | null"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this variant.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this variant.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.sku","typeLabel":"string | null"},"stock_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not stock will be tracked for this variant. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.stock_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not stock will be tracked for this variant. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.stock_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.stock_enabled","typeLabel":"boolean | null"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this variant. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this variant. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true`, this variant is considered taxable. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.tax_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true`, this variant is considered taxable. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.tax_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.tax_enabled","typeLabel":"boolean | null"},"weight":{"oneOf":[{"type":"number","description":"The variant weight, meant to be displayable to the customer. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"The variant weight, meant to be displayable to the customer. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.weight","typeLabel":"number | null"},"weight_unit":{"oneOf":[{"type":"string","description":"The weight unit for this variant. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.weight_unit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The weight unit for this variant. If `null`, inherits from the product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.weight_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.weight_unit","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.metadata","typeLabel":"object"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.available_stock","typeLabel":"integer"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This is inherited from the price.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.currency","typeLabel":"string"},"current_release_download":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated download ID.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.current_release_download.oneOf.0","typeLabel":"string"},{},{"type":"null","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.current_release_download.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.current_release_download","typeLabel":"string | null"},"current_version":{"type":"boolean","description":"Whether or not this object represents the current version of this variant. (This will be `false` if the association was created to this variant before it was altered. In this case, we will lookup the version of the variant at the time it was associated.)","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.current_version","typeLabel":"boolean"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.held_stock","typeLabel":"integer"},"image":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated media ID.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated media object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.object","typeLabel":"string"},"byte_size":{"type":"integer","description":"The size of the media in bytes.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"The content type (i.e. image/png, image/jpg, application/pdf).","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.content_type","typeLabel":"string"},"extension":{"type":"string","description":"The extension (i.e. png, jpg, pdf).","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.extension","typeLabel":"string"},"filename":{"type":"string","description":"The full filename with extension.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.filename","typeLabel":"string"},"height":{"oneOf":[{"type":"string","description":"If the media is an image, this will be the height in pixels.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.height.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the media is an image, this will be the height in pixels.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.height","typeLabel":"string | null"},"public_access":{"type":"boolean","description":"Whether or not this media is publicly accessible.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.public_access","typeLabel":"boolean"},"release_json":{"oneOf":[{"type":"object","description":"The JSON that was extracted from the `release.json` file within the ZIP file.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.release_json.oneOf.0","typeLabel":"object"},{"type":"null","description":"The JSON that was extracted from the `release.json` file within the ZIP file.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.release_json.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.release_json","typeLabel":"object | null"},"url":{"oneOf":[{"type":"string","description":"The URL for accessing this media. If the media is public, this will be a permanent URL. If the media is private, this will be a short-lived URL if the media has been exposed.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for accessing this media. If the media is public, this will be a permanent URL. If the media is private, this will be a short-lived URL if the media has been exposed.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.url","typeLabel":"string | null"},"url_expires_at":{"oneOf":[{"type":"integer","description":"The time at which the URL expires. This will only be present if the media is private and has been exposed.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.url_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the URL expires. This will only be present if the media is private and has been exposed.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.url_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.url_expires_at","typeLabel":"integer | null"},"width":{"oneOf":[{"type":"string","description":"If the media is an image, this will be the width in pixels.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.width.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the media is an image, this will be the width in pixels.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.width","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.image","typeLabel":"string | object | null"},"option_names":{"type":"array","description":"An array of the associated product's variant option names.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.option_names","typeLabel":"array"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.product.oneOf.0","typeLabel":"string"},{}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.product","typeLabel":"string"},"stock":{"type":"integer","description":"The total amount of stock on hand for this product.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.stock","typeLabel":"integer"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.variant.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.variant.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.variant.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.variant","typeLabel":"string | object | null"},"review":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated review ID.","uniqueKey":"purchase.oneOf.1.review.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated review object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.object","typeLabel":"string"},"title":{"oneOf":[{"type":"string","description":"The title of the review.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The title of the review.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.title","typeLabel":"string | null"},"body":{"oneOf":[{"type":"string","description":"The content/body of the review.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.body.oneOf.0","typeLabel":"string"},{"type":"null","description":"The content/body of the review.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.body","typeLabel":"string | null"},"stars":{"oneOf":[{"type":"number","format":"float","description":"The numerical rating provided in the review. Can be a decimal from 1.0 to 5.0.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.stars.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"The numerical rating provided in the review. Can be a decimal from 1.0 to 5.0.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.stars.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.stars","typeLabel":"number\u003cfloat> | null"},"status":{"oneOf":[{"type":"string","description":"The status of the review (e.g. `in_review`, `published`, `unpublished`).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The status of the review (e.g. `in_review`, `published`, `unpublished`).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.status","typeLabel":"string | null"},"verified":{"type":"boolean","description":"Indicates whether the reviewer has purchased the product (based on presence of a purchase).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.verified","typeLabel":"boolean"},"customer":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated customer ID.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.customer.oneOf.0","typeLabel":"string"},{"description":"[Expanded](/api-reference/expanding-responses) – The associated customer object.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.customer.oneOf.1","typeLabel":"any"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.customer","typeLabel":"string | any"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated product object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.object","typeLabel":"string"},"allow_out_of_stock_purchases":{"type":"boolean","description":"Whether or not to allow purchases of this product when stock runs out. If true, the stock levels for this can go below zero.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean"},"archived":{"type":"boolean","description":"Whether or not this product is archived.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.archived","typeLabel":"boolean"},"auto_fulfill_enabled":{"type":"boolean","description":"Whether or not this product should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean"},"cataloged_at":{"type":"integer","description":"The time when the product was added or made available. This value is used for sorting products on shop pages.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.cataloged_at","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","description":"The product description, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product description, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.description","typeLabel":"string | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this product for shipping calculations.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.dimensions","typeLabel":"object | null"},"featured":{"type":"boolean","description":"Whether or not this product is featured.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.featured","typeLabel":"boolean"},"licensing_enabled":{"type":"boolean","description":"Whether or not licensing is enabled for this product.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.licensing_enabled","typeLabel":"boolean"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, then unlimited license activations are allowed. (The activation limit can also be set on `Price` which will override this value.)","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"name":{"type":"string","description":"The product name, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.name","typeLabel":"string"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times the product can be purchased by a customer. If `null`, then unlimited purchases are allowed.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.purchase_limit","typeLabel":"integer | null"},"recurring":{"type":"boolean","default":false,"description":"Whether the product is for a one-time purchase or a recurring (subscription) purchase.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.recurring","typeLabel":"boolean"},"reviews_enabled":{"type":"boolean","description":"Whether or not reviews are enabled for this product.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.reviews_enabled","typeLabel":"boolean"},"shipping_enabled":{"type":"boolean","description":"If set to `true` checkouts with this product will require a full shipping address.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.shipping_enabled","typeLabel":"boolean"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this product. If the `Product` has variants, each variant has a specific `sku`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.sku","typeLabel":"string | null"},"status":{"type":"string","description":"The status of this product – one of `draft` or `published`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.status","typeLabel":"string"},"slug":{"type":"string","description":"A unique and URL friendly string that represents this product. (This will be auto-generated when a product is created if not explicitly set.)","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.slug","typeLabel":"string"},"solicit_reviews":{"type":"boolean","description":"Whether or not to solicit reviews for this product with automatic emails to customers.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.solicit_reviews","typeLabel":"boolean"},"stock_enabled":{"type":"boolean","description":"Whether or not stock will be tracked for this product.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.stock_enabled","typeLabel":"boolean"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this product – one of `digital`, `tangible`, `service`, or `saas`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"type":"boolean","description":"If set to `true` this product is considered taxable.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.tax_enabled","typeLabel":"boolean"},"weight":{"type":"number","description":"The product weight, meant to be displayable to the customer.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.weight","typeLabel":"number"},"weight_unit":{"type":"string","description":"The weight unit for this product – one of `lb`, `oz`, `kg`, `g`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.weight_unit","typeLabel":"string"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metadata","typeLabel":"object"},"archived_at":{"oneOf":[{"type":"integer","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.archived_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was archived. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.archived_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.archived_at","typeLabel":"integer | null"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.available_stock","typeLabel":"integer"},"average_stars":{"type":"string","description":"The average stars for this product based on published reviews.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.average_stars","typeLabel":"string"},"bundle_items":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.bundle_items.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.bundle_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.bundle_items","typeLabel":"any | null"},"commission_structure":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.commission_structure.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.commission_structure.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.commission_structure","typeLabel":"any | null"},"current_release_download":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.current_release_download.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.current_release_download.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.current_release_download","typeLabel":"any | null"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.held_stock","typeLabel":"integer"},"metrics":{"type":"object","properties":{"currency":{"type":"string","description":"The currency that was used to calculate these metrics. This will always be set to the account's currency.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.currency","typeLabel":"string"},"max_price_amount":{"oneOf":[{"type":"integer","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.max_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.max_price_amount","typeLabel":"integer | null"},"min_price_amount":{"oneOf":[{"type":"integer","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum `amount` among this product's prices (including variant price overrides).","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.min_price_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.min_price_amount","typeLabel":"integer | null"},"prices_count":{"oneOf":[{"type":"integer","description":"The total number of prices that belong to this product.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The total number of prices that belong to this product.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.prices_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics.prices_count","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.metrics","typeLabel":"object"},"downloads":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.downloads.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.downloads.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.downloads","typeLabel":"any | null"},"reviews_breakdown":{"type":"object","description":"A histogram breakdown of the reviews for this product.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.reviews_breakdown","typeLabel":"object"},"featured_product_media":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.featured_product_media.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.featured_product_media.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.featured_product_media","typeLabel":"any | null"},"prices":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.prices.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.prices.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.prices","typeLabel":"any | null"},"product_collections":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_collections.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_collections","typeLabel":"any | null"},"product_group":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_group.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_group","typeLabel":"any | null"},"product_medias":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_medias.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_medias.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.product_medias","typeLabel":"any | null"},"shipping_profile":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.shipping_profile.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.shipping_profile.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.shipping_profile","typeLabel":"any | null"},"stock":{"type":"integer","description":"The total amount of stock on hand for this variant.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.stock","typeLabel":"integer"},"reviews":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.reviews.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.reviews.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.reviews","typeLabel":"any | null"},"variant_options":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.variant_options.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.variant_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.variant_options","typeLabel":"any | null"},"variants":{"oneOf":[{"type":"any","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.variants.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.variants.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.variants","typeLabel":"any | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product.oneOf.1","typeLabel":"object"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.product","typeLabel":"string | object"},"purchase":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated purchase ID.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.purchase.oneOf.0","typeLabel":"string"},{},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.purchase.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.purchase","typeLabel":"string | null"},"review_medias":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated review media objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.review_medias","typeLabel":"string | object | null"},"discarded_at":{"oneOf":[{"type":"integer","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.discarded_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was discarded. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.discarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.discarded_at","typeLabel":"integer | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.review.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1.review.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.1.review.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.review","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"purchase.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"purchase.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"purchase.oneOf.2","typeLabel":"null"}],"uniqueKey":"purchase","typeLabel":"string | object | null"},"shipping_method":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated shipping method ID.","uniqueKey":"shipping_method.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated shipping method object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"shipping_method.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"shipping_method.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"shipping_method.oneOf.1.object","typeLabel":"string"},"name":{"type":"string","description":"A name for this shipping method that will be visible to customers.","uniqueKey":"shipping_method.oneOf.1.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"A short description for this shipping method that will be visible to customers.","uniqueKey":"shipping_method.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A short description for this shipping method that will be visible to customers.","uniqueKey":"shipping_method.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.description","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"shipping_method.oneOf.1.metadata","typeLabel":"object"},"shipping_rates":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – Property not returned unless expanded.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – A list of associated shipping rate objects.","properties":{"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.object","typeLabel":"string"},"pagination":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of items.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.count","typeLabel":"integer"},"limit":{"oneOf":[{"type":"integer","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of items per page. The default is `20` and the maximum is `100`.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"The current page.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The current page.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination.page","typeLabel":"integer | null"}},"uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.pagination","typeLabel":"object"},"data":{"type":"array","description":"An array of objects.","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1.data","typeLabel":"array"}},"uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"shipping_method.oneOf.1.shipping_rates.oneOf.2","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.shipping_rates","typeLabel":"string | object | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_method.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_method.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_method.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"shipping_method.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping_method.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"shipping_method.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"shipping_method.oneOf.2","typeLabel":"null"}],"uniqueKey":"shipping_method","typeLabel":"string | object | null"},"variant":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated variant ID.","uniqueKey":"variant.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated variant object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"variant.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"variant.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"variant.oneOf.1.object","typeLabel":"string"},"amount":{"oneOf":[{"type":"integer","description":"The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular `Price` amount will be used. If the `Product` has multiple prices, then this amount will be ignored and the selected `Price` amount will be used.","uniqueKey":"variant.oneOf.1.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The amount in cents to be charged, represented as a whole integer for this specific integer. If empty, the regular `Price` amount will be used. If the `Product` has multiple prices, then this amount will be ignored and the selected `Price` amount will be used.","uniqueKey":"variant.oneOf.1.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.amount","typeLabel":"integer | null"},"allow_out_of_stock_purchases":{"oneOf":[{"type":"boolean","description":"Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.allow_out_of_stock_purchases.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not to allow purchases of this variant when stock runs out. If true, the stock levels for this variant can go below zero. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.allow_out_of_stock_purchases.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.allow_out_of_stock_purchases","typeLabel":"boolean | null"},"auto_fulfill_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not this variant should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.auto_fulfill_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not this variant should be auto fulfilled when it is purchased. This can only be `true` when `shipping_enabled` is `false`. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.auto_fulfill_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.auto_fulfill_enabled","typeLabel":"boolean | null"},"dimensions":{"oneOf":[{"type":"object","description":"The physical dimensions of this variant. If `null`, inherits from the product.","properties":{"length":{"type":"number","description":"The length dimension.","uniqueKey":"variant.oneOf.1.dimensions.oneOf.0.length","typeLabel":"number"},"width":{"type":"number","description":"The width dimension.","uniqueKey":"variant.oneOf.1.dimensions.oneOf.0.width","typeLabel":"number"},"height":{"type":"number","description":"The height dimension.","uniqueKey":"variant.oneOf.1.dimensions.oneOf.0.height","typeLabel":"number"},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`.","uniqueKey":"variant.oneOf.1.dimensions.oneOf.0.unit","typeLabel":"string"}},"uniqueKey":"variant.oneOf.1.dimensions.oneOf.0","typeLabel":"object"},{"type":"null","description":"The physical dimensions of this variant. If `null`, inherits from the product.","properties":{"length":{"type":"number","description":"The length dimension."},"width":{"type":"number","description":"The width dimension."},"height":{"type":"number","description":"The height dimension."},"unit":{"type":"string","description":"The unit of measurement – one of `cm`, `mm`, `m`, `in`, `ft`."}},"uniqueKey":"variant.oneOf.1.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.dimensions","typeLabel":"object | null"},"downloads_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not downloads are enabled for this variant. When `false`, downloads will be disabled for this variant. When `true`, the downloads that are set for this variant will override the product downloads. If no downloads are set, then the product downloads will be used.","uniqueKey":"variant.oneOf.1.downloads_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not downloads are enabled for this variant. When `false`, downloads will be disabled for this variant. When `true`, the downloads that are set for this variant will override the product downloads. If no downloads are set, then the product downloads will be used.","uniqueKey":"variant.oneOf.1.downloads_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.downloads_enabled","typeLabel":"boolean | null"},"license_activation_limit":{"oneOf":[{"type":"integer","description":"The max number of activations allowed per license. If `null`, inherits from the product or price.","uniqueKey":"variant.oneOf.1.license_activation_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of activations allowed per license. If `null`, inherits from the product or price.","uniqueKey":"variant.oneOf.1.license_activation_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.license_activation_limit","typeLabel":"integer | null"},"option_1":{"type":"string","description":"The value for the first variant option.","uniqueKey":"variant.oneOf.1.option_1","typeLabel":"string"},"option_2":{"oneOf":[{"type":"string","description":"The value for the second variant option.","uniqueKey":"variant.oneOf.1.option_2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value for the second variant option.","uniqueKey":"variant.oneOf.1.option_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.option_2","typeLabel":"string | null"},"option_3":{"oneOf":[{"type":"string","description":"The value for the third variant option.","uniqueKey":"variant.oneOf.1.option_3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value for the third variant option.","uniqueKey":"variant.oneOf.1.option_3.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.option_3","typeLabel":"string | null"},"position":{"oneOf":[{"type":"integer","description":"The ordering position of this variant when displayed to customers.","uniqueKey":"variant.oneOf.1.position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ordering position of this variant when displayed to customers.","uniqueKey":"variant.oneOf.1.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.position","typeLabel":"integer | null"},"purchase_limit":{"oneOf":[{"type":"integer","description":"The max number of times this variant can be purchased by a customer. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.purchase_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The max number of times this variant can be purchased by a customer. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.purchase_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.purchase_limit","typeLabel":"integer | null"},"shipping_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true` checkouts with this variant will require a full shipping address. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.shipping_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true` checkouts with this variant will require a full shipping address. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.shipping_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.shipping_enabled","typeLabel":"boolean | null"},"sku":{"oneOf":[{"type":"string","description":"The stock keeping unit for this variant.","uniqueKey":"variant.oneOf.1.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stock keeping unit for this variant.","uniqueKey":"variant.oneOf.1.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.sku","typeLabel":"string | null"},"stock_enabled":{"oneOf":[{"type":"boolean","description":"Whether or not stock will be tracked for this variant. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.stock_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether or not stock will be tracked for this variant. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.stock_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.stock_enabled","typeLabel":"boolean | null"},"tax_category":{"oneOf":[{"type":"string","description":"The tax category/code that matches this variant. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.tax_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax category/code that matches this variant. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.tax_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.tax_category","typeLabel":"string | null"},"tax_enabled":{"oneOf":[{"type":"boolean","description":"If set to `true`, this variant is considered taxable. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.tax_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If set to `true`, this variant is considered taxable. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.tax_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.tax_enabled","typeLabel":"boolean | null"},"weight":{"oneOf":[{"type":"number","description":"The variant weight, meant to be displayable to the customer. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"The variant weight, meant to be displayable to the customer. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.weight","typeLabel":"number | null"},"weight_unit":{"oneOf":[{"type":"string","description":"The weight unit for this variant. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.weight_unit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The weight unit for this variant. If `null`, inherits from the product.","uniqueKey":"variant.oneOf.1.weight_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.weight_unit","typeLabel":"string | null"},"metadata":{"type":"object","description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","uniqueKey":"variant.oneOf.1.metadata","typeLabel":"object"},"available_stock":{"type":"integer","description":"The total amount of stock available for purchase. This is the total `stock` on hand minus `held_stock`.","uniqueKey":"variant.oneOf.1.available_stock","typeLabel":"integer"},"currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. This is inherited from the price.","uniqueKey":"variant.oneOf.1.currency","typeLabel":"string"},"current_release_download":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated download ID.","uniqueKey":"variant.oneOf.1.current_release_download.oneOf.0","typeLabel":"string"},{},{"type":"null","uniqueKey":"variant.oneOf.1.current_release_download.oneOf.2","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.current_release_download","typeLabel":"string | null"},"current_version":{"type":"boolean","description":"Whether or not this object represents the current version of this variant. (This will be `false` if the association was created to this variant before it was altered. In this case, we will lookup the version of the variant at the time it was associated.)","uniqueKey":"variant.oneOf.1.current_version","typeLabel":"boolean"},"held_stock":{"type":"integer","description":"The total amount of stock being held by unfulfilled line items.","uniqueKey":"variant.oneOf.1.held_stock","typeLabel":"integer"},"image":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated media ID.","uniqueKey":"variant.oneOf.1.image.oneOf.0","typeLabel":"string"},{"type":"object","description":"[Expanded](/api-reference/expanding-responses) – The associated media object.","properties":{"id":{"oneOf":[{"type":"string","description":"The UUID of the specific object.","uniqueKey":"variant.oneOf.1.image.oneOf.1.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The UUID of the specific object.","uniqueKey":"variant.oneOf.1.image.oneOf.1.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.id","typeLabel":"string | null"},"object":{"type":"string","description":"A string describing the object type returned.","uniqueKey":"variant.oneOf.1.image.oneOf.1.object","typeLabel":"string"},"byte_size":{"type":"integer","description":"The size of the media in bytes.","uniqueKey":"variant.oneOf.1.image.oneOf.1.byte_size","typeLabel":"integer"},"content_type":{"type":"string","description":"The content type (i.e. image/png, image/jpg, application/pdf).","uniqueKey":"variant.oneOf.1.image.oneOf.1.content_type","typeLabel":"string"},"extension":{"type":"string","description":"The extension (i.e. png, jpg, pdf).","uniqueKey":"variant.oneOf.1.image.oneOf.1.extension","typeLabel":"string"},"filename":{"type":"string","description":"The full filename with extension.","uniqueKey":"variant.oneOf.1.image.oneOf.1.filename","typeLabel":"string"},"height":{"oneOf":[{"type":"string","description":"If the media is an image, this will be the height in pixels.","uniqueKey":"variant.oneOf.1.image.oneOf.1.height.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the media is an image, this will be the height in pixels.","uniqueKey":"variant.oneOf.1.image.oneOf.1.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.height","typeLabel":"string | null"},"public_access":{"type":"boolean","description":"Whether or not this media is publicly accessible.","uniqueKey":"variant.oneOf.1.image.oneOf.1.public_access","typeLabel":"boolean"},"release_json":{"oneOf":[{"type":"object","description":"The JSON that was extracted from the `release.json` file within the ZIP file.","uniqueKey":"variant.oneOf.1.image.oneOf.1.release_json.oneOf.0","typeLabel":"object"},{"type":"null","description":"The JSON that was extracted from the `release.json` file within the ZIP file.","uniqueKey":"variant.oneOf.1.image.oneOf.1.release_json.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.release_json","typeLabel":"object | null"},"url":{"oneOf":[{"type":"string","description":"The URL for accessing this media. If the media is public, this will be a permanent URL. If the media is private, this will be a short-lived URL if the media has been exposed.","uniqueKey":"variant.oneOf.1.image.oneOf.1.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for accessing this media. If the media is public, this will be a permanent URL. If the media is private, this will be a short-lived URL if the media has been exposed.","uniqueKey":"variant.oneOf.1.image.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.url","typeLabel":"string | null"},"url_expires_at":{"oneOf":[{"type":"integer","description":"The time at which the URL expires. This will only be present if the media is private and has been exposed.","uniqueKey":"variant.oneOf.1.image.oneOf.1.url_expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The time at which the URL expires. This will only be present if the media is private and has been exposed.","uniqueKey":"variant.oneOf.1.image.oneOf.1.url_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.url_expires_at","typeLabel":"integer | null"},"width":{"oneOf":[{"type":"string","description":"If the media is an image, this will be the width in pixels.","uniqueKey":"variant.oneOf.1.image.oneOf.1.width.oneOf.0","typeLabel":"string"},{"type":"null","description":"If the media is an image, this will be the width in pixels.","uniqueKey":"variant.oneOf.1.image.oneOf.1.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.width","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.image.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.image.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.image.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.image.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"variant.oneOf.1.image.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"variant.oneOf.1.image.oneOf.2","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.image","typeLabel":"string | object | null"},"option_names":{"type":"array","description":"An array of the associated product's variant option names.","uniqueKey":"variant.oneOf.1.option_names","typeLabel":"array"},"product":{"oneOf":[{"type":"string","description":"[Expandable](/api-reference/expanding-responses) – The associated product ID.","uniqueKey":"variant.oneOf.1.product.oneOf.0","typeLabel":"string"},{}],"uniqueKey":"variant.oneOf.1.product","typeLabel":"string"},"stock":{"type":"integer","description":"The total amount of stock on hand for this product.","uniqueKey":"variant.oneOf.1.stock","typeLabel":"integer"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"variant.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant.oneOf.1.updated_at","typeLabel":"integer | null"}},"uniqueKey":"variant.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"variant.oneOf.2","typeLabel":"null"}],"uniqueKey":"variant","typeLabel":"string | object | null"},"variant_options":{"oneOf":[{"type":"array","description":"An array of the associated variant's options.","uniqueKey":"variant_options.oneOf.0","typeLabel":"array"},{"type":"null","description":"An array of the associated variant's options.","uniqueKey":"variant_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"variant_options","typeLabel":"array | null"},"created_at":{"oneOf":[{"type":"integer","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"created_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was created. Measured in seconds since the Unix epoch.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"integer | null"},"updated_at":{"oneOf":[{"type":"integer","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"updated_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Time at which the object was last updated. Measured in seconds since the Unix epoch.","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"18bf5f94-14f3-4d95-84af-f1f2a05d5837","object":"subscription","ad_hoc_amount":null,"affiliation_expires_at":null,"cancel_at_period_end":true,"currency":"usd","current_period_end_at":1795079800,"current_period_start_at":1792401400,"ended_at":null,"finite":false,"last_renewal_reminder_sent_at":null,"live_mode":true,"manual_payment":false,"metadata":{},"pending_update":{},"price_readonly":false,"portal_url":"http://app.example.com/portal_redirect/subscriptions/18bf5f94-14f3-4d95-84af-f1f2a05d5837","quantity":1,"remaining_period_count":null,"restart_on_completed":false,"restore_at":1797671800,"subtotal_amount":2900,"status":"active","tax_enabled":false,"trial_end_at":null,"trial_start_at":null,"variant_options":null,"affiliation":null,"current_cancellation_act":"637c113b-68d5-4b4a-9a7a-f0125086cc97","current_period":"cc465ce1-8457-4756-8ebc-348c657a61ac","customer":"451a1b48-35dd-47d6-bd04-61e072a7e796","discount":null,"manual_payment_method":null,"payment_method":"c5d1b8de-f81e-4795-b5b9-2978ecabf4d0","price":"8f0c0f08-d46b-4bec-a299-aca8de0fb9aa","purchase":"7f30a475-128b-4058-95f3-7f88a6ce5e68","shipping_method":null,"variant":null,"created_at":1792401400,"updated_at":1792401400}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f4a9acc0-f626-41c8-bade-ae8daf7233ea":{"bearer_auth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"}}},"servers":{"0d4fcd2d-651c-42a5-a696-14d1bb02e291":{"url":"https://{defaultHost}","variables":{"defaultHost":{"default":"api.surecart.com"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"},"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":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"openapi/v1/subscriptions.json"},"subdomain":"surecart","siteName":"SureCart","title":"Cancel/Pause - SureCart","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T09:57:05.689Z","originalFileLocation":"api-reference/subscriptions/cancelpause.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=\"Cancels a specific subscription. If a restore_at value is provided, the subscription will be effectively \u0026quot;paused\u0026quot; until that date when it will automatically renew.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SureCart\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_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/surecart/5YN85bnU-7QpL9oU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel/Pause - SureCart\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancels a specific subscription. If a restore_at value is provided, the subscription will be effectively \u0026quot;paused\u0026quot; until that date when it will automatically renew.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SureCart\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.surecart.com/api-reference/subscriptions/cancelpause\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://surecart.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Cancel%2FPause\u0026amp;description=Cancels+a+specific+subscription.+If+a+%60restore_at%60+value+is+provided%2C+the+subscription+will+be+effectively+%22paused%22+until+that+date+when+it+will+automatically+r\u0026amp;theme=9b88c4f1d9bfad53237eccf2\u0026amp;signature=177f2f6ae063b1429430c7b4ae0963c80a8f10c982ae07e38536ed41d8381db2\">\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=\"Cancel/Pause - SureCart\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancels a specific subscription. If a restore_at value is provided, the subscription will be effectively \u0026quot;paused\u0026quot; until that date when it will automatically renew.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://surecart.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Cancel%2FPause\u0026amp;description=Cancels+a+specific+subscription.+If+a+%60restore_at%60+value+is+provided%2C+the+subscription+will+be+effectively+%22paused%22+until+that+date+when+it+will+automatically+r\u0026amp;theme=9b88c4f1d9bfad53237eccf2\u0026amp;signature=177f2f6ae063b1429430c7b4ae0963c80a8f10c982ae07e38536ed41d8381db2\">\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/surecart/5YN85bnU-7QpL9oU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SureCart\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00824c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.surecart.com/api-reference/subscriptions/cancelpause\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscriptions/cancelpause.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.surecart.com/#organization\",\"name\":\"SureCart\",\"url\":\"https://developer.surecart.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/surecart/ETeQN6deVZFb6K1z/logo/surecart-logo-light.svg?fit=max\u0026auto=format\u0026n=ETeQN6deVZFb6K1z\u0026q=85\u0026s=38315d1a606d0a91773837ea01e08a74\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.surecart.com#website\",\"name\":\"SureCart\",\"url\":\"https://developer.surecart.com\",\"publisher\":{\"@id\":\"https://developer.surecart.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause#webpage\",\"url\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause\",\"name\":\"Cancel/Pause\",\"description\":\"Cancels a specific subscription. If a restore_at value is provided, the subscription will be effectively \\\"paused\\\" until that date when it will automatically renew.\",\"dateModified\":\"2026-10-19T09:57:05.689Z\",\"isPartOf\":{\"@id\":\"https://developer.surecart.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://developer.surecart.com/api-reference/cancellation-acts/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscriptions\",\"item\":\"https://developer.surecart.com/api-reference/subscriptions/filter-schema\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Cancel/Pause\",\"item\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause#apireference\",\"headline\":\"Cancel/Pause\",\"name\":\"Cancel/Pause\",\"description\":\"Cancels a specific subscription. If a restore_at value is provided, the subscription will be effectively \\\"paused\\\" until that date when it will automatically renew.\",\"url\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause\",\"mainEntityOfPage\":{\"@id\":\"https://developer.surecart.com/api-reference/subscriptions/cancelpause#webpage\"},\"dateModified\":\"2026-10-19T09:57:05.689Z\",\"publisher\":{\"@id\":\"https://developer.surecart.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.surecart.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SureCart\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SureCart","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Expanding Responses","href":"/api-reference/expanding-responses"},{"title":"Metadata","href":"/api-reference/metadata"},{"title":"Live \u0026 Test Mode","href":"/api-reference/modes"},{"title":"Pagination \u0026 Sorting","href":"/api-reference/pagination"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Core Endpoints","expanded":false,"pages":[{"group":"Account Seeds","pages":[{"title":"Seed","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/account/seed","href":"/api-reference/account-seeds/seed"}]},{"group":"Accounts","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/account","href":"/api-reference/accounts/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/account","href":"/api-reference/accounts/update"}]},{"group":"Batch Operations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batch_operations","href":"/api-reference/batch-operations/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batch_operations/{id}","href":"/api-reference/batch-operations/retrieve"}]},{"group":"Batches","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batches","href":"/api-reference/batches/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/batches","href":"/api-reference/batches/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/batches/{id}","href":"/api-reference/batches/retrieve"}]},{"group":"Brands","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/brand","href":"/api-reference/brands/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/brand","href":"/api-reference/brands/update"}]},{"group":"Bulk Actions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/bulk_actions","href":"/api-reference/bulk-actions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/bulk_actions","href":"/api-reference/bulk-actions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/bulk_actions/{id}","href":"/api-reference/bulk-actions/retrieve"}]},{"group":"Display Currencies","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/display_currencies","href":"/api-reference/display-currencies/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/display_currencies","href":"/api-reference/display-currencies/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/display_currencies/{id}","href":"/api-reference/display-currencies/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/display_currencies/{id}","href":"/api-reference/display-currencies/delete"}]},{"group":"Events","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/events","href":"/api-reference/events/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/events/{id}","href":"/api-reference/events/retrieve"}]},{"group":"Exports","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/exports","href":"/api-reference/exports/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/exports","href":"/api-reference/exports/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/exports/{id}","href":"/api-reference/exports/retrieve"}]},{"group":"Import Rows","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/import_rows","href":"/api-reference/import-rows/list"}]},{"group":"Imports","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/imports","href":"/api-reference/imports/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/imports/{id}","href":"/api-reference/imports/retrieve"},{"title":"Batch Create Products","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/imports/products","href":"/api-reference/imports/batch-create-products"},{"title":"Batch Create Coupons","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/imports/coupons","href":"/api-reference/imports/batch-create-coupons"},{"title":"Batch Create Product Collections","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/imports/product_collections","href":"/api-reference/imports/batch-create-product-collections"}]},{"group":"Medias","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/medias","href":"/api-reference/medias/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/medias","href":"/api-reference/medias/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/medias/{id}","href":"/api-reference/medias/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/medias/{id}","href":"/api-reference/medias/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/medias/{id}","href":"/api-reference/medias/update"}]},{"group":"Notes","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/notes","href":"/api-reference/notes/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/notes","href":"/api-reference/notes/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/notes/{id}","href":"/api-reference/notes/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/notes/{id}","href":"/api-reference/notes/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/notes/{id}","href":"/api-reference/notes/update"}]},{"group":"Processors","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/processors","href":"/api-reference/processors/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/processors/{id}","href":"/api-reference/processors/retrieve"},{"title":"Payment Method Types","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/processors/{id}/payment_method_types","href":"/api-reference/processors/payment-method-types"}]},{"group":"Statistics","pages":[{"title":"Orders","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/stats/orders","href":"/api-reference/statistics/orders"}]},{"group":"Webhook Endpoints","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/webhook_endpoints","href":"/api-reference/webhook-endpoints/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/webhook_endpoints","href":"/api-reference/webhook-endpoints/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json get /v1/webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json delete /v1/webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json patch /v1/webhook_endpoints/{id}","href":"/api-reference/webhook-endpoints/update"},{"title":"Test","deprecated":null,"version":null,"openapi":"/openapi/v1/core.json post /v1/webhook_endpoints/{id}/test","href":"/api-reference/webhook-endpoints/test"}]}]},{"group":"Customers","pages":[{"group":"Balance Transactions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/balance_transactions","href":"/api-reference/balance-transactions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/balance_transactions","href":"/api-reference/balance-transactions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/balance_transactions/{id}","href":"/api-reference/balance-transactions/retrieve"}]},{"group":"Balances","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/balances","href":"/api-reference/balances/list"}]},{"group":"Customer Notification Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customer_notification_protocol","href":"/api-reference/customer-notification-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/customer_notification_protocol","href":"/api-reference/customer-notification-protocols/update"}]},{"group":"Customer Portal Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customer_portal_protocol","href":"/api-reference/customer-portal-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/customer_portal_protocol","href":"/api-reference/customer-portal-protocols/update"}]},{"group":"Customers","pages":[{"title":"Filter Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers/filter_schema","href":"/api-reference/customers/filter-schema"},{"title":"Filter","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/customers/filter","href":"/api-reference/customers/filter"},{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers","href":"/api-reference/customers/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/customers","href":"/api-reference/customers/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers/{id}","href":"/api-reference/customers/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json delete /v1/customers/{id}","href":"/api-reference/customers/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/customers/{id}","href":"/api-reference/customers/update"},{"title":"Expose Media","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/customers/{id}/expose/{media_id}","href":"/api-reference/customers/expose-media"}]},{"group":"Saved Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_items","href":"/api-reference/saved-items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_items","href":"/api-reference/saved-items/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_items/{id}","href":"/api-reference/saved-items/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json delete /v1/saved_items/{id}","href":"/api-reference/saved-items/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/saved_items/{id}","href":"/api-reference/saved-items/update"},{"title":"Move to checkout","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_items/{saved_item_id}/line_item","href":"/api-reference/saved-items/move-to-checkout"},{"title":"Save line item","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/line_items/{line_item_id}/saved_item","href":"/api-reference/saved-items/save-line-item"}]},{"group":"Saved Lists","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_lists","href":"/api-reference/saved-lists/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_lists","href":"/api-reference/saved-lists/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json get /v1/saved_lists/{id}","href":"/api-reference/saved-lists/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json delete /v1/saved_lists/{id}","href":"/api-reference/saved-lists/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json patch /v1/saved_lists/{id}","href":"/api-reference/saved-lists/update"},{"title":"Move to checkout","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/saved_lists/{saved_list_id}/line_items","href":"/api-reference/saved-lists/move-to-checkout"}]},{"group":"Verification Codes","pages":[{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/verification_codes","href":"/api-reference/verification-codes/create"},{"title":"Verify","deprecated":null,"version":null,"openapi":"/openapi/v1/customers.json post /v1/verification_codes/verify","href":"/api-reference/verification-codes/verify"}]}]},{"group":"Products","pages":[{"group":"Auto Fee Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fee_protocol","href":"/api-reference/auto-fee-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/auto_fee_protocol","href":"/api-reference/auto-fee-protocols/update"}]},{"group":"Auto Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fees","href":"/api-reference/auto-fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/auto_fees","href":"/api-reference/auto-fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fees/{id}","href":"/api-reference/auto-fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/auto_fees/{id}","href":"/api-reference/auto-fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/auto_fees/{id}","href":"/api-reference/auto-fees/update"},{"title":"Rule Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/auto_fees/rule_schema/{fee_target}","href":"/api-reference/auto-fees/rule-schema"}]},{"group":"Bumps","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bumps","href":"/api-reference/bumps/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/bumps","href":"/api-reference/bumps/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bumps/{id}","href":"/api-reference/bumps/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/bumps/{id}","href":"/api-reference/bumps/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/bumps/{id}","href":"/api-reference/bumps/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/bumps/{id}/duplicate","href":"/api-reference/bumps/duplicate"}]},{"group":"Bundle Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bundle_items","href":"/api-reference/bundle-items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/bundle_items","href":"/api-reference/bundle-items/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/bundle_items/{id}","href":"/api-reference/bundle-items/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/bundle_items/{id}","href":"/api-reference/bundle-items/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/bundle_items/{id}","href":"/api-reference/bundle-items/update"}]},{"group":"Coupons","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/coupons","href":"/api-reference/coupons/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/coupons","href":"/api-reference/coupons/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/coupons/{id}","href":"/api-reference/coupons/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/coupons/{id}","href":"/api-reference/coupons/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/coupons/{id}","href":"/api-reference/coupons/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/coupons/{id}/duplicate","href":"/api-reference/coupons/duplicate"}]},{"group":"Discounts","pages":[{"title":"List Discounts","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/discounts","href":"/api-reference/discounts/list-discounts"},{"title":"Retrieve Discount","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/discounts/{id}","href":"/api-reference/discounts/retrieve-discount"}]},{"group":"Downloads","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/downloads","href":"/api-reference/downloads/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/downloads","href":"/api-reference/downloads/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/downloads/{id}","href":"/api-reference/downloads/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/downloads/{id}","href":"/api-reference/downloads/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/downloads/{id}","href":"/api-reference/downloads/update"}]},{"group":"Prices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/prices","href":"/api-reference/prices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/prices","href":"/api-reference/prices/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/prices/{id}","href":"/api-reference/prices/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/prices/{id}","href":"/api-reference/prices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/prices/{id}","href":"/api-reference/prices/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/prices/{id}/duplicate","href":"/api-reference/prices/duplicate"}]},{"group":"Product Collections","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_collections","href":"/api-reference/product-collections/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/product_collections","href":"/api-reference/product-collections/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_collections/{id}","href":"/api-reference/product-collections/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/product_collections/{id}","href":"/api-reference/product-collections/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/product_collections/{id}","href":"/api-reference/product-collections/update"}]},{"group":"Product Groups","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_groups","href":"/api-reference/product-groups/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/product_groups","href":"/api-reference/product-groups/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_groups/{id}","href":"/api-reference/product-groups/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/product_groups/{id}","href":"/api-reference/product-groups/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/product_groups/{id}","href":"/api-reference/product-groups/update"}]},{"group":"Product Medias","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_medias","href":"/api-reference/product-medias/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/product_medias","href":"/api-reference/product-medias/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/product_medias/{id}","href":"/api-reference/product-medias/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/product_medias/{id}","href":"/api-reference/product-medias/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/product_medias/{id}","href":"/api-reference/product-medias/update"}]},{"group":"Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/products","href":"/api-reference/products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/products","href":"/api-reference/products/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/products/{id}","href":"/api-reference/products/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/products/{id}","href":"/api-reference/products/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/products/{id}","href":"/api-reference/products/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/products/{id}/duplicate","href":"/api-reference/products/duplicate"}]},{"group":"Promotions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/promotions","href":"/api-reference/promotions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/promotions","href":"/api-reference/promotions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/promotions/{id}","href":"/api-reference/promotions/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/promotions/{id}","href":"/api-reference/promotions/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/promotions/{id}","href":"/api-reference/promotions/update"}]},{"group":"Review Medias","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/review_medias","href":"/api-reference/review-medias/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/review_medias","href":"/api-reference/review-medias/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/review_medias/{id}","href":"/api-reference/review-medias/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/review_medias/{id}","href":"/api-reference/review-medias/delete"}]},{"group":"Review Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/review_protocol","href":"/api-reference/review-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/review_protocol","href":"/api-reference/review-protocols/update"}]},{"group":"Reviews","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/reviews","href":"/api-reference/reviews/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/reviews","href":"/api-reference/reviews/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/reviews/{id}","href":"/api-reference/reviews/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/reviews/{id}","href":"/api-reference/reviews/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/reviews/{id}","href":"/api-reference/reviews/update"},{"title":"Publish","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/reviews/{id}/publish","href":"/api-reference/reviews/publish"},{"title":"Unpublish","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/reviews/{id}/unpublish","href":"/api-reference/reviews/unpublish"}]},{"group":"Swaps","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/swaps","href":"/api-reference/swaps/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/swaps","href":"/api-reference/swaps/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/swaps/{id}","href":"/api-reference/swaps/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/swaps/{id}","href":"/api-reference/swaps/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/swaps/{id}","href":"/api-reference/swaps/update"}]},{"group":"Upsell Funnels","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsell_funnels","href":"/api-reference/upsell-funnels/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/upsell_funnels","href":"/api-reference/upsell-funnels/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsell_funnels/{id}","href":"/api-reference/upsell-funnels/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/upsell_funnels/{id}","href":"/api-reference/upsell-funnels/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/upsell_funnels/{id}","href":"/api-reference/upsell-funnels/update"},{"title":"Duplicate","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/upsell_funnels/{id}/duplicate","href":"/api-reference/upsell-funnels/duplicate"}]},{"group":"Upsells","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsells","href":"/api-reference/upsells/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/upsells","href":"/api-reference/upsells/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/upsells/{id}","href":"/api-reference/upsells/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/upsells/{id}","href":"/api-reference/upsells/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/upsells/{id}","href":"/api-reference/upsells/update"}]},{"group":"Variant Options","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variant_options","href":"/api-reference/variant-options/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variant_options/{id}","href":"/api-reference/variant-options/retrieve"}]},{"group":"Variants","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variants","href":"/api-reference/variants/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json post /v1/variants","href":"/api-reference/variants/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json get /v1/variants/{id}","href":"/api-reference/variants/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json delete /v1/variants/{id}","href":"/api-reference/variants/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/products.json patch /v1/variants/{id}","href":"/api-reference/variants/update"}]}]},{"group":"Orders \u0026 Payments","pages":[{"group":"Abandoned Checkout Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/abandoned_checkout_protocol","href":"/api-reference/abandoned-checkout-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/abandoned_checkout_protocol","href":"/api-reference/abandoned-checkout-protocols/update"}]},{"group":"Abandonded Checkouts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/abandoned_checkouts","href":"/api-reference/abandonded-checkouts/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/abandoned_checkouts/{id}","href":"/api-reference/abandonded-checkouts/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/abandoned_checkouts/{id}","href":"/api-reference/abandonded-checkouts/update"}]},{"group":"Charges","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/charges","href":"/api-reference/charges/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/charges/{id}","href":"/api-reference/charges/retrieve"}]},{"group":"Checkout Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkout_fees","href":"/api-reference/checkout-fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/checkout_fees","href":"/api-reference/checkout-fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkout_fees/{id}","href":"/api-reference/checkout-fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/checkout_fees/{id}","href":"/api-reference/checkout-fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkout_fees/{id}","href":"/api-reference/checkout-fees/update"}]},{"group":"Checkout Portal Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkout_portal_protocol","href":"/api-reference/checkout-portal-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkout_portal_protocol","href":"/api-reference/checkout-portal-protocols/update"}]},{"group":"Checkouts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkouts","href":"/api-reference/checkouts/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/checkouts","href":"/api-reference/checkouts/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/checkouts/{id}","href":"/api-reference/checkouts/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}","href":"/api-reference/checkouts/update"},{"title":"Finalize","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/finalize","href":"/api-reference/checkouts/finalize"},{"title":"Manually Pay","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/manually_pay","href":"/api-reference/checkouts/manually-pay"},{"title":"Cancel","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/cancel","href":"/api-reference/checkouts/cancel"},{"title":"Offer Bump","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/offer_bump/{bump_id}","href":"/api-reference/checkouts/offer-bump"},{"title":"Offer Upsell","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/offer_upsell/{upsell_id}","href":"/api-reference/checkouts/offer-upsell"},{"title":"Decline Upsell","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/checkouts/{id}/decline_upsell/{upsell_id}","href":"/api-reference/checkouts/decline-upsell"}]},{"group":"Disputes","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/disputes","href":"/api-reference/disputes/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/disputes/{id}","href":"/api-reference/disputes/retrieve"}]},{"group":"Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/fees","href":"/api-reference/fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/fees","href":"/api-reference/fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/fees/{id}","href":"/api-reference/fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/fees/{id}","href":"/api-reference/fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/fees/{id}","href":"/api-reference/fees/update"}]},{"group":"Invoices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/invoices","href":"/api-reference/invoices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/invoices","href":"/api-reference/invoices/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/invoices/{id}","href":"/api-reference/invoices/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/invoices/{id}","href":"/api-reference/invoices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/invoices/{id}","href":"/api-reference/invoices/update"},{"title":"Make Draft","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/invoices/{id}/make_draft","href":"/api-reference/invoices/make-draft"},{"title":"Open","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/invoices/{id}/open","href":"/api-reference/invoices/open"},{"title":"Resend Notification","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/invoices/{id}/resend_notification","href":"/api-reference/invoices/resend-notification"}]},{"group":"Line Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/line_items","href":"/api-reference/line-items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/line_items","href":"/api-reference/line-items/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/line_items/{id}","href":"/api-reference/line-items/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/line_items/{id}","href":"/api-reference/line-items/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}","href":"/api-reference/line-items/update"},{"title":"Upsell","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/line_items/upsell","href":"/api-reference/line-items/upsell"},{"title":"Swap","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}/swap","href":"/api-reference/line-items/swap"},{"title":"Unswap","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}/unswap","href":"/api-reference/line-items/unswap"},{"title":"Offer Swap","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/line_items/{id}/offer_swap","href":"/api-reference/line-items/offer-swap"}]},{"group":"Manual Charges","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_charges","href":"/api-reference/manual-charges/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_charges/{id}","href":"/api-reference/manual-charges/retrieve"}]},{"group":"Manual Payment Methods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_payment_methods","href":"/api-reference/manual-payment-methods/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/manual_payment_methods","href":"/api-reference/manual-payment-methods/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/manual_payment_methods/{id}","href":"/api-reference/manual-payment-methods/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/manual_payment_methods/{id}","href":"/api-reference/manual-payment-methods/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/manual_payment_methods/{id}","href":"/api-reference/manual-payment-methods/update"}]},{"group":"Order Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/order_protocol","href":"/api-reference/order-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/order_protocol","href":"/api-reference/order-protocols/update"}]},{"group":"Orders","pages":[{"title":"Filter Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/orders/filter_schema","href":"/api-reference/orders/filter-schema"},{"title":"Filter","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/orders/filter","href":"/api-reference/orders/filter"},{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/orders","href":"/api-reference/orders/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/orders/{id}","href":"/api-reference/orders/retrieve"},{"title":"Resend Notification","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/orders/{id}/resend_notification","href":"/api-reference/orders/resend-notification"}]},{"group":"Payment Failures","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_failures","href":"/api-reference/payment-failures/list"}]},{"group":"Payment Intents","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_intents","href":"/api-reference/payment-intents/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/payment_intents","href":"/api-reference/payment-intents/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_intents/{id}","href":"/api-reference/payment-intents/retrieve"},{"title":"Capture","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/payment_intents/{id}/capture","href":"/api-reference/payment-intents/capture"}]},{"group":"Payment Methods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_methods","href":"/api-reference/payment-methods/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/payment_methods/{id}","href":"/api-reference/payment-methods/retrieve"},{"title":"Detach","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/payment_methods/{id}/detach","href":"/api-reference/payment-methods/detach"}]},{"group":"Purchases","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/purchases","href":"/api-reference/purchases/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/purchases","href":"/api-reference/purchases/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/purchases/{id}","href":"/api-reference/purchases/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/purchases/{id}","href":"/api-reference/purchases/update"},{"title":"Invoke","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/purchases/{id}/invoke","href":"/api-reference/purchases/invoke"},{"title":"Revoke","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/purchases/{id}/revoke","href":"/api-reference/purchases/revoke"}]},{"group":"Refund Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refund_items","href":"/api-reference/refund-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refund_items/{id}","href":"/api-reference/refund-items/retrieve"}]},{"group":"Refunds","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refunds","href":"/api-reference/refunds/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/refunds","href":"/api-reference/refunds/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/refunds/{id}","href":"/api-reference/refunds/retrieve"}]},{"group":"Shipping Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/shipping_fees","href":"/api-reference/shipping-fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json post /v1/shipping_fees","href":"/api-reference/shipping-fees/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json get /v1/shipping_fees/{id}","href":"/api-reference/shipping-fees/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json delete /v1/shipping_fees/{id}","href":"/api-reference/shipping-fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/orders.json patch /v1/shipping_fees/{id}","href":"/api-reference/shipping-fees/update"}]}]},{"group":"Subscriptions","pages":[{"group":"Cancellation Acts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_acts","href":"/api-reference/cancellation-acts/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_acts/{id}","href":"/api-reference/cancellation-acts/retrieve"}]},{"group":"Cancellation Reasons","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_reasons","href":"/api-reference/cancellation-reasons/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json post /v1/cancellation_reasons","href":"/api-reference/cancellation-reasons/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/cancellation_reasons/{id}","href":"/api-reference/cancellation-reasons/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json delete /v1/cancellation_reasons/{id}","href":"/api-reference/cancellation-reasons/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/cancellation_reasons/{id}","href":"/api-reference/cancellation-reasons/update"}]},{"group":"Periods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/periods","href":"/api-reference/periods/list"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/periods/{id}","href":"/api-reference/periods/update"},{"title":"Retry Payment","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/periods/{id}/retry_payment","href":"/api-reference/periods/retry-payment"}]},{"group":"Subscription Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscription_protocol","href":"/api-reference/subscription-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscription_protocol","href":"/api-reference/subscription-protocols/update"}]},{"group":"Subscriptions","pages":[{"title":"Filter Schema","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscriptions/filter_schema","href":"/api-reference/subscriptions/filter-schema"},{"title":"Filter","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json post /v1/subscriptions/filter","href":"/api-reference/subscriptions/filter"},{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscriptions","href":"/api-reference/subscriptions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json post /v1/subscriptions","href":"/api-reference/subscriptions/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json get /v1/subscriptions/{id}","href":"/api-reference/subscriptions/retrieve"},{"title":"Update","description":"Updates a specific subscription.","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}","href":"/api-reference/subscriptions/update"},{"title":"Cancel/Pause","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancelpause"},{"title":"Complete","description":"Completes a specific subscription.","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/complete","href":"/api-reference/subscriptions/complete"},{"title":"Pay Off","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/pay_off","href":"/api-reference/subscriptions/pay-off"},{"title":"Preserve","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/preserve","href":"/api-reference/subscriptions/preserve"},{"title":"Restore","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/restore","href":"/api-reference/subscriptions/restore"},{"title":"Upcoming Period","deprecated":null,"version":null,"openapi":"/openapi/v1/subscriptions.json patch /v1/subscriptions/{id}/upcoming_period","href":"/api-reference/subscriptions/upcoming-period"}]}]},{"group":"Shipping \u0026 Fulfillment","pages":[{"group":"Fulfillment Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillment_items","href":"/api-reference/fulfillment-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillment_items/{id}","href":"/api-reference/fulfillment-items/retrieve"}]},{"group":"Fulfillments","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillments","href":"/api-reference/fulfillments/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/fulfillments","href":"/api-reference/fulfillments/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/fulfillments/{id}","href":"/api-reference/fulfillments/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/fulfillments/{id}","href":"/api-reference/fulfillments/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/fulfillments/{id}","href":"/api-reference/fulfillments/update"}]},{"group":"Parcel Templates","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/parcel_templates","href":"/api-reference/parcel-templates/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/parcel_templates","href":"/api-reference/parcel-templates/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/parcel_templates/{id}","href":"/api-reference/parcel-templates/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/parcel_templates/{id}","href":"/api-reference/parcel-templates/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/parcel_templates/{id}","href":"/api-reference/parcel-templates/update"}]},{"group":"Return Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_items","href":"/api-reference/return-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_items/{id}","href":"/api-reference/return-items/retrieve"}]},{"group":"Return Requests","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_requests","href":"/api-reference/return-requests/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/return_requests","href":"/api-reference/return-requests/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_requests/{id}","href":"/api-reference/return-requests/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/return_requests/{id}","href":"/api-reference/return-requests/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/return_requests/{id}","href":"/api-reference/return-requests/update"},{"title":"Open","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/return_requests/{id}/open","href":"/api-reference/return-requests/open"},{"title":"Complete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/return_requests/{id}/complete","href":"/api-reference/return-requests/complete"},{"title":"List Return Reasons","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/return_reasons","href":"/api-reference/return-requests/list-return-reasons"}]},{"group":"Shipments","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipments","href":"/api-reference/shipments/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipments","href":"/api-reference/shipments/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipments/{id}","href":"/api-reference/shipments/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}","href":"/api-reference/shipments/update"},{"title":"Quote","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/quote","href":"/api-reference/shipments/quote"},{"title":"Purchase","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/purchase","href":"/api-reference/shipments/purchase"},{"title":"Void","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipments/{id}/void","href":"/api-reference/shipments/void"}]},{"group":"Shipping Choices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_choices","href":"/api-reference/shipping-choices/list"}]},{"group":"Shipping Methods","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_methods","href":"/api-reference/shipping-methods/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_methods","href":"/api-reference/shipping-methods/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_methods/{id}","href":"/api-reference/shipping-methods/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_methods/{id}","href":"/api-reference/shipping-methods/update"}]},{"group":"Shipping Profiles","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_profiles","href":"/api-reference/shipping-profiles/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_profiles","href":"/api-reference/shipping-profiles/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_profiles/{id}","href":"/api-reference/shipping-profiles/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/shipping_profiles/{id}","href":"/api-reference/shipping-profiles/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_profiles/{id}","href":"/api-reference/shipping-profiles/update"}]},{"group":"Shipping Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_protocol","href":"/api-reference/shipping-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_protocol","href":"/api-reference/shipping-protocols/update"}]},{"group":"Carrier Accounts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers/{shipping_provider_id}/carrier_accounts","href":"/api-reference/carrier-accounts/list"}]},{"group":"Carrier Parcel Templates","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates","href":"/api-reference/carrier-parcel-templates/list"}]},{"group":"Shipping Providers","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers","href":"/api-reference/shipping-providers/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_providers/{id}","href":"/api-reference/shipping-providers/retrieve"}]},{"group":"Shipping Rates","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_rates","href":"/api-reference/shipping-rates/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_rates","href":"/api-reference/shipping-rates/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/update"}]},{"group":"Shipping Zones","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_zones","href":"/api-reference/shipping-zones/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/shipping_zones","href":"/api-reference/shipping-zones/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/shipping_zones/{id}","href":"/api-reference/shipping-zones/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/shipping_zones/{id}","href":"/api-reference/shipping-zones/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/shipping_zones/{id}","href":"/api-reference/shipping-zones/update"}]},{"group":"Trackings","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/trackings","href":"/api-reference/trackings/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/trackings/{id}","href":"/api-reference/trackings/retrieve"}]},{"group":"Warehouses","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/warehouses","href":"/api-reference/warehouses/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json post /v1/warehouses","href":"/api-reference/warehouses/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json get /v1/warehouses/{id}","href":"/api-reference/warehouses/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json delete /v1/warehouses/{id}","href":"/api-reference/warehouses/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/shipping.json patch /v1/warehouses/{id}","href":"/api-reference/warehouses/update"}]}]},{"group":"Tax","pages":[{"group":"Tax Overrides","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_overrides","href":"/api-reference/tax-overrides/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json post /v1/tax_overrides","href":"/api-reference/tax-overrides/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_overrides/{id}","href":"/api-reference/tax-overrides/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json delete /v1/tax_overrides/{id}","href":"/api-reference/tax-overrides/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json patch /v1/tax_overrides/{id}","href":"/api-reference/tax-overrides/update"}]},{"group":"Tax Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_protocol","href":"/api-reference/tax-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json patch /v1/tax_protocol","href":"/api-reference/tax-protocols/update"}]},{"group":"Tax Registrations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_registrations","href":"/api-reference/tax-registrations/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json post /v1/tax_registrations","href":"/api-reference/tax-registrations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_registrations/{id}","href":"/api-reference/tax-registrations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json delete /v1/tax_registrations/{id}","href":"/api-reference/tax-registrations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json patch /v1/tax_registrations/{id}","href":"/api-reference/tax-registrations/update"}]},{"group":"Tax Zones","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/tax.json get /v1/tax_zones","href":"/api-reference/tax-zones/list"}]}]},{"group":"Affiliates","pages":[{"group":"Affiliation Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_products","href":"/api-reference/affiliation-products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/affiliation_products","href":"/api-reference/affiliation-products/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_products/{id}","href":"/api-reference/affiliation-products/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/affiliation_products/{id}","href":"/api-reference/affiliation-products/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_products/{id}","href":"/api-reference/affiliation-products/update"}]},{"group":"Affiliation Protocols","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_protocol","href":"/api-reference/affiliation-protocols/retrieve"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_protocol","href":"/api-reference/affiliation-protocols/update"}]},{"group":"Affiliation Requests","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_requests","href":"/api-reference/affiliation-requests/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/affiliation_requests","href":"/api-reference/affiliation-requests/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliation_requests/{id}","href":"/api-reference/affiliation-requests/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/affiliation_requests/{id}","href":"/api-reference/affiliation-requests/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_requests/{id}","href":"/api-reference/affiliation-requests/update"},{"title":"Activate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_requests/{id}/approve","href":"/api-reference/affiliation-requests/activate"},{"title":"Deactivate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliation_requests/{id}/deny","href":"/api-reference/affiliation-requests/deactivate"}]},{"group":"Affiliations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliations","href":"/api-reference/affiliations/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/affiliations","href":"/api-reference/affiliations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/affiliations/{id}","href":"/api-reference/affiliations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/affiliations/{id}","href":"/api-reference/affiliations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliations/{id}","href":"/api-reference/affiliations/update"},{"title":"Activate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliations/{id}/activate","href":"/api-reference/affiliations/activate"},{"title":"Deactivate","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/affiliations/{id}/deactivate","href":"/api-reference/affiliations/deactivate"}]},{"group":"Clicks","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/clicks","href":"/api-reference/clicks/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/clicks/{id}","href":"/api-reference/clicks/retrieve"}]},{"group":"Payout Groups","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payout_groups","href":"/api-reference/payout-groups/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/payout_groups","href":"/api-reference/payout-groups/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payout_groups/{id}","href":"/api-reference/payout-groups/retrieve"}]},{"group":"Payouts","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payouts","href":"/api-reference/payouts/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/payouts","href":"/api-reference/payouts/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/payouts/{id}","href":"/api-reference/payouts/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/payouts/{id}","href":"/api-reference/payouts/delete"},{"title":"Complete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/payouts/{id}/complete","href":"/api-reference/payouts/complete"},{"title":"Make Processing","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/payouts/{id}/make_processing","href":"/api-reference/payouts/make-processing"}]},{"group":"Referral Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referral_items","href":"/api-reference/referral-items/list"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referral_items/{id}","href":"/api-reference/referral-items/retrieve"}]},{"group":"Referrals","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referrals","href":"/api-reference/referrals/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json post /v1/referrals","href":"/api-reference/referrals/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json get /v1/referrals/{id}","href":"/api-reference/referrals/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json delete /v1/referrals/{id}","href":"/api-reference/referrals/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}","href":"/api-reference/referrals/update"},{"title":"Approve","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}/approve","href":"/api-reference/referrals/approve"},{"title":"Deny","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}/deny","href":"/api-reference/referrals/deny"},{"title":"Make Reviewing","deprecated":null,"version":null,"openapi":"/openapi/v1/affiliates.json patch /v1/referrals/{id}/make_reviewing","href":"/api-reference/referrals/make-reviewing"}]}]},{"group":"Licensing","pages":[{"group":"Activations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json get /v1/activations","href":"/api-reference/activations/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json post /v1/public/activations","href":"/api-reference/activations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/activations/{id}","href":"/api-reference/activations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json delete /v1/public/activations/{id}","href":"/api-reference/activations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json patch /v1/public/activations/{id}","href":"/api-reference/activations/update"}]},{"group":"Licenses","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json get /v1/licenses","href":"/api-reference/licenses/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json post /v1/licenses","href":"/api-reference/licenses/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/licenses/{key}","href":"/api-reference/licenses/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json delete /v1/licenses/{id}","href":"/api-reference/licenses/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/licensing.json patch /v1/licenses/{id}","href":"/api-reference/licenses/update"}]}]},{"group":"Public Endpoints","pages":[{"group":"Activations","pages":[{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json post /v1/public/activations","href":"/api-reference/activations/create"},{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/activations/{id}","href":"/api-reference/activations/retrieve"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json delete /v1/public/activations/{id}","href":"/api-reference/activations/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json patch /v1/public/activations/{id}","href":"/api-reference/activations/update"}]},{"group":"Atlas","pages":[{"title":"List Countries","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/atlas","href":"/api-reference/atlas/list-countries"},{"title":"Retrieve Country","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/atlas/{country_code}","href":"/api-reference/atlas/retrieve-country"}]},{"group":"Clicks","pages":[{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json post /v1/public/clicks","href":"/api-reference/clicks/create"}]},{"group":"Licenses","pages":[{"title":"Retrieve","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/licenses/{key}","href":"/api-reference/licenses/retrieve"},{"title":"Expose Current Release","deprecated":null,"version":null,"openapi":"/openapi/v1/public.json get /v1/public/licenses/{key}/expose_current_release","href":"/api-reference/licenses/expose-current-release"}]}]}]}]},"title":"Cancel/Pause - SureCart","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}