{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Hyperline","colors":{"primary":"#1A1A1A","light":"#999999","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55","dark":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-light.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=c81125a44e9fdf8006623ab1f597ce7f"},"favicon":"https://mintcdn.com/hyperline/xZrQhb6Rphak0y92/favicon.png?fit=max\u0026auto=format\u0026n=xZrQhb6Rphak0y92\u0026q=85\u0026s=c52ed2ba655f301d3a99a7987888c622","api":{"openapi":["https://api.hyperline.co/openapi","https://ingest.hyperline.co/openapi"],"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":["https://api.hyperline.co","https://ingest.hyperline.co"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#fafafa","dark":"#1f1f1f"}},"navbar":{"links":[{"href":"https://www.hyperline.co/talk-to-sales","label":"Book a call"}],"primary":{"type":"button","label":"Get Started","href":"https://app.hyperline.co"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Status","href":"https://status.hyperline.co"},{"label":"Changelog","href":"https://docs.hyperline.co/changelog"},{"label":"Glossary","href":"https://docs.hyperline.co/docs/introduction/glossary"},{"label":"Contact support","href":"mailto:support@hyperline.co"}]},{"header":"Company","items":[{"label":"Customers","href":"https://www.hyperline.co/resources/customers"},{"label":"Blog","href":"https://www.hyperline.co/resources/blog"},{"label":"Careers","href":"https://www.welcometothejungle.com/fr/companies/hyperline"},{"label":"Media Kit","href":"https://drive.google.com/drive/folders/1KIlufVDz6tgwohTFFv1jSyoqeHO0pKOm"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://www.hyperline.co/privacy-policy"},{"label":"Terms of Service","href":"https://www.hyperline.co/terms-of-service"},{"label":"Security","href":"https://docs.hyperline.co/security"}]}]},"seo":{"metatags":{"og:image":"https://app.hyperline.co/auth/background.svg"},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"posthog":{"apiKey":"phc_KmmpIQ7SFNwnur6ZqVC118l5EkS1pqo313t4qxwL32n","apiHost":"https://eu.posthog.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperline","hasAudioNarration":false,"actualSubdomain":"hyperline","customDomains":["docs.hyperline.co"],"gitSource":{"type":"github","owner":"meterly","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afae6777ce488d58d5c04d6","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Developers","count":363},{"language":"default","tag":"Documentation","count":112},{"language":"default","tag":"Integrations","count":43},{"language":"default","tag":"Subscriptions","count":38},{"language":"default","tag":"Invoices","count":35},{"language":"default","tag":"AI > Billing","count":27},{"language":"default","tag":"Quotes","count":25},{"language":"default","tag":"Customers","count":21},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"Changelog","count":17}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@hyperline.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[{"filePath":"index.css","content":"a[href*=\"mintlify.com\"]{display:none;visibility:hidden}.text-2xl{font-weight:600}.tag-blue{height:20px;line-height:20px;display:inline-block;background:#93c5fd;margin:0;padding:0 6px;border-radius:4px;color:#0166ff;border:1px solid #0166ff;font-weight:600;font-size:12px}.tag-orange{height:20px;line-height:20px;display:inline-block;background:#fef9e0;margin:0;padding:0 6px;border-radius:4px;color:#da9e09;border:1px solid #da9e09;font-weight:600;font-size:12px}#footer>div>div:not(:first-child){display:none;visibility:hidden}"},{"filePath":"developers/getting-started.css","content":"#content-area:has(#developer-home){max-width:56rem;margin-inline:auto}"}],"page":{"pagePath":"api-reference/endpoints/quotes/list-quotes","slug":"/api-reference/endpoints/quotes/list-quotes","pageMetadata":{"openapi":"get /v1/quotes","title":"List quotes","description":"Retrieve existing quotes.","href":"/api-reference/endpoints/quotes/list-quotes"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve existing quotes.\"\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":{"openapi":"get /v1/quotes","title":"List quotes","description":"Retrieve existing quotes.","href":"/api-reference/endpoints/quotes/list-quotes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listQuotes","tags":["Quotes"],"security":["f5abb228-be83-4d68-898d-e367be417430"],"summary":"List quotes","description":"Retrieve existing quotes.","parameters":["b6c63efc-6b36-43d1-823d-ddebe271ad9b","e5714b97-4136-4b28-bfb3-2bdc3348913e","197cd825-dc22-45c0-a962-16d94eac71e3","7367d6dd-6991-47d7-8483-6e51aba16835","7beee641-fa69-44c8-856a-670e345430f9","58e4f68c-b1ae-4359-ad9c-393dac555145","ac70f6c5-82b1-4870-88dc-82bf09a24f61","4d947501-3299-472a-839b-996da97a966c","4f051a44-f89f-4dd3-b9cc-18a827cc3387","c255bafa-3d00-420d-97b1-582a51ed4b69","37ab5b9e-3f14-44d3-84cf-da7d60d965b3","14313409-e0e8-4020-bd32-7bd9eb5519be","c144f90c-647e-4825-9d89-12debd2489b1","d7090c38-583c-4058-8f00-89fb06de5da4","02391d16-7201-4a0e-af34-04ce6fc547a0","633c41c5-30b3-4570-82fe-043eeec2ce06","215b8d74-a232-4cf5-a7f1-66ac623a5cd4","ca19ab9f-cddf-4ac2-83df-e96d99f555d0","b69ef640-8643-4f47-9d39-2b1b8d509dba","3243c44a-138d-4aef-8180-fb0334545c37","d0d0c641-f866-4a0b-af9a-63af652a91d1","efab93fb-e823-4718-a8f4-5600af4cc648","e37907a0-b24e-4044-a0f6-5b1be78926b8","45a1061d-d4de-40dc-9763-c8364028e3da","ae9b3460-264b-463b-bc05-3f1b506664c8","32e7e57b-4b65-48d4-87a5-2b1ab4f518d1","02aec0ea-465d-472d-87ea-5456c96cf7fe","b3ff7e78-b7a9-430d-ae11-fee92b94cf5d","9b22a2b0-30dc-49c8-9201-a812d9417db1","518bc42f-99ba-46ed-8189-7b7056f8103f","61d80207-0b88-41a4-a598-178134f3737e","f9c24fe2-040b-468d-a314-48470601f734","1aa84121-4aa0-4faa-aaf9-283cea804f22","5c9a6487-0765-4570-bcf7-7251662d5154","62cdf8a2-ae28-4143-b3b2-84a7bd4ce902","d43d530b-884f-4872-b792-19cf2877476c","2ba44836-003a-4b0c-a2f9-3b1d2b7dd897","15e0f0ab-9408-4af6-8ab4-618a6d771346","0ae52956-78de-4058-8aab-35af9b51ecf7","5ee980c1-4261-4d31-9f95-90ff881e9512","74f409a3-a804-4cb0-9f50-3c2595c173be","5d525c88-9e6e-477e-9165-45da1328dbda","78fd99cd-fcf2-4f5c-8818-2cdfca41d56f","cc3c53c1-4204-4947-98cf-6dede9f3ed31","315f397f-3034-412d-8b4e-426617eed388","1784a9e3-f9e0-4aec-9e65-882771d8b798"],"responses":{"200":"25c91431-4055-45c5-a470-6433eb2be030"},"method":"get","type":"path","servers":["09993eee-d706-4786-83dc-094b23d5da0e","47e2e692-210a-4cfb-8dfc-5fc05358a42e"],"path":"/v1/quotes","baseUrlOptions":["https://api.hyperline.co","https://sandbox.api.hyperline.co"],"title":"List quotes","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b6c63efc-6b36-43d1-823d-ddebe271ad9b":{"schema":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"default":50,"uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"default":50,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"},"required":false,"name":"take","in":"query"},"e5714b97-4136-4b28-bfb3-2bdc3348913e":{"schema":{"oneOf":[{"type":"number","minimum":0,"default":0,"uniqueKey":"oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"default":0,"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"number | null"},"required":false,"name":"skip","in":"query"},"197cd825-dc22-45c0-a962-16d94eac71e3":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"id","in":"query"},"7367d6dd-6991-47d7-8483-6e51aba16835":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"id__not","in":"query"},"7beee641-fa69-44c8-856a-670e345430f9":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"id__equals","in":"query"},"58e4f68c-b1ae-4359-ad9c-393dac555145":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"id__contains","in":"query"},"ac70f6c5-82b1-4870-88dc-82bf09a24f61":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"id__startsWith","in":"query"},"4d947501-3299-472a-839b-996da97a966c":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"id__endWith","in":"query"},"4f051a44-f89f-4dd3-b9cc-18a827cc3387":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"number","in":"query"},"c255bafa-3d00-420d-97b1-582a51ed4b69":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"number__not","in":"query"},"37ab5b9e-3f14-44d3-84cf-da7d60d965b3":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"number__equals","in":"query"},"14313409-e0e8-4020-bd32-7bd9eb5519be":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"number__contains","in":"query"},"c144f90c-647e-4825-9d89-12debd2489b1":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"number__startsWith","in":"query"},"d7090c38-583c-4058-8f00-89fb06de5da4":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"number__endWith","in":"query"},"02391d16-7201-4a0e-af34-04ce6fc547a0":{"schema":{"oneOf":[{"type":"string","enum":["all","draft","pending_approval","changes_requested","approved","pending_signature","expired","signed","voided"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"all,draft","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"status","in":"query"},"633c41c5-30b3-4570-82fe-043eeec2ce06":{"schema":{"oneOf":[{"type":"string","enum":["all","draft","pending_approval","changes_requested","approved","pending_signature","expired","signed","voided"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"all,draft","uniqueKey":"oneOf.1","typeLabel":"string"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | string"},"required":false,"name":"status__in","in":"query"},"215b8d74-a232-4cf5-a7f1-66ac623a5cd4":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id","in":"query"},"ca19ab9f-cddf-4ac2-83df-e96d99f555d0":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__not","in":"query"},"b69ef640-8643-4f47-9d39-2b1b8d509dba":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__equals","in":"query"},"3243c44a-138d-4aef-8180-fb0334545c37":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__contains","in":"query"},"d0d0c641-f866-4a0b-af9a-63af652a91d1":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__startsWith","in":"query"},"efab93fb-e823-4718-a8f4-5600af4cc648":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"customer_id__endWith","in":"query"},"e37907a0-b24e-4044-a0f6-5b1be78926b8":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"template_id","in":"query"},"45a1061d-d4de-40dc-9763-c8364028e3da":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"template_id__not","in":"query"},"ae9b3460-264b-463b-bc05-3f1b506664c8":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"template_id__equals","in":"query"},"32e7e57b-4b65-48d4-87a5-2b1ab4f518d1":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"template_id__contains","in":"query"},"02aec0ea-465d-472d-87ea-5456c96cf7fe":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"template_id__startsWith","in":"query"},"b3ff7e78-b7a9-430d-ae11-fee92b94cf5d":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"template_id__endWith","in":"query"},"9b22a2b0-30dc-49c8-9201-a812d9417db1":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"template_id__isNull","in":"query"},"518bc42f-99ba-46ed-8189-7b7056f8103f":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"template_id__isNotNull","in":"query"},"61d80207-0b88-41a4-a598-178134f3737e":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"crm_opportunity_id","in":"query"},"f9c24fe2-040b-468d-a314-48470601f734":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"crm_opportunity_id__not","in":"query"},"1aa84121-4aa0-4faa-aaf9-283cea804f22":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"crm_opportunity_id__equals","in":"query"},"5c9a6487-0765-4570-bcf7-7251662d5154":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"crm_opportunity_id__contains","in":"query"},"62cdf8a2-ae28-4143-b3b2-84a7bd4ce902":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"crm_opportunity_id__startsWith","in":"query"},"d43d530b-884f-4872-b792-19cf2877476c":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"crm_opportunity_id__endWith","in":"query"},"2ba44836-003a-4b0c-a2f9-3b1d2b7dd897":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"crm_opportunity_id__isNull","in":"query"},"15e0f0ab-9408-4af6-8ab4-618a6d771346":{"schema":{"oneOf":[{"type":"boolean","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"string","enum":["true","false"],"uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean · enum\u003cstring> · enum\u003cstring>"},"required":false,"name":"crm_opportunity_id__isNotNull","in":"query"},"0ae52956-78de-4058-8aab-35af9b51ecf7":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"type","in":"query"},"5ee980c1-4261-4d31-9f95-90ff881e9512":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at","in":"query"},"74f409a3-a804-4cb0-9f50-3c2595c173be":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__not","in":"query"},"5d525c88-9e6e-477e-9165-45da1328dbda":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__equals","in":"query"},"78fd99cd-fcf2-4f5c-8818-2cdfca41d56f":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__lt","in":"query"},"cc3c53c1-4204-4947-98cf-6dede9f3ed31":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__lte","in":"query"},"315f397f-3034-412d-8b4e-426617eed388":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__gt","in":"query"},"1784a9e3-f9e0-4aec-9e65-882771d8b798":{"schema":{"type":"string","format":"date-time","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time>"},"required":false,"name":"updated_at__gte","in":"query"}},"responses":{"25c91431-4055-45c5-a470-6433eb2be030":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total of existing items.","example":1,"isRequired":true,"uniqueKey":"meta.total","typeLabel":"number"},"taken":{"type":"number","description":"Number of items returned.","example":1,"isRequired":true,"uniqueKey":"meta.taken","typeLabel":"number"},"skipped":{"type":"number","description":"Number of items skipped.","example":0,"isRequired":true,"uniqueKey":"meta.skipped","typeLabel":"number"}},"required":["total","taken","skipped"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"data":{"type":"array","items":{"oneOf":[{"type":"object","title":"Draft","required":["id","type","status","amount","customer_id","invoicing_entity_id","configurations","template_id","crm_opportunity_id","custom_properties","contract_value","number","comments","terms","owner_email","collect_payment_details","collect_custom_property_ids","require_tax_id","display_quote_value","display_quote_value_with_tax","display_taxes","display_price_tiers","display_phase_value","display_discounts_on_total","display_first_invoice_amount","display_documents_in_preview","subscription_update_display","post_signature_activation_enabled","generate_draft_invoices","attachments","signed_file","url","created_at","updated_at","expires_at","subscription_id","display_subscription_on_update"],"properties":{"id":{"type":"string","description":"Quote ID.","example":"quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"oneOf":[{"type":"string","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","enum":["draft"],"description":"\nQuote status.\n\n- `draft`: The quote is a draft.\n- `pending_approval`: The quote is pending manager review and approval.\n- `changes_requested`: Some changes have been requested following manager review.\n- `approved`: The quote is approved and ready to be sent to the customer.\n- `pending_signature`: The quote is awaiting the customer's signature.\n- `signed`: The quote is signed and fully finalized.\n- `voided`: The quote is voided.\n","example":"draft","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"amount":{"oneOf":[{"type":"number","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":200000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":200000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.amount","typeLabel":"number | null"},"customer_id":{"type":"string","description":"ID of the customer.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.customer_id","typeLabel":"string"},"invoicing_entity_id":{"type":"string","description":"ID of the invoicing entity attached to the quote.","example":"ive_47484fjdhy5","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.invoicing_entity_id","typeLabel":"string"},"configurations":{"type":"array","items":{"oneOf":[{"type":"object","title":"Subscription or update","required":["id","customer_id","position","amount","applied_at","type","subscription_id","contract_terms","estimates"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["subscription","subscription_update"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"subscription_id":{"oneOf":[{"type":"string","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.subscription_id","typeLabel":"string | null"},"contract_terms":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.status","typeLabel":"enum\u003cstring>"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.activation_strategy","typeLabel":"enum\u003cstring>"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.end_strategy","typeLabel":"enum\u003cstring>"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at","typeLabel":"string\u003cdate-time> | null"},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration","typeLabel":"object | null"},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically","typeLabel":"boolean | enum\u003cstring>"},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration","typeLabel":"object | null"},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at","typeLabel":"string\u003cdate-time> | null"},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at","typeLabel":"string\u003cdate-time> | null"}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"}]},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"}]},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}}]},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true}]},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}}]},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"}]},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"}]}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.contract_terms","typeLabel":"object | null"},"estimates":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","description":"ID of the estimated product in the catalog.","example":"itm_3kXODIM1sBwBbJ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].product_id","typeLabel":"string"},"price_configuration_id":{"oneOf":[{"type":"string","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id","typeLabel":"string | null"},"phase_order":{"type":"integer","description":"Order of the quote phase holding the estimated line.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].phase_order","typeLabel":"integer"},"period_start":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start","typeLabel":"string\u003cdate-time> | null"},"period_end":{"oneOf":[{"type":"string","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end","typeLabel":"string\u003cdate-time> | null"},"estimated_count":{"type":"number","description":"Estimated number of units per billing period.","example":200,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_count","typeLabel":"number"},"estimated_amount":{"oneOf":[{"type":"number","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount","typeLabel":"number | null"},"estimated_total_amount":{"oneOf":[{"type":"number","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount","typeLabel":"number | null"}},"required":["product_id","price_configuration_id","phase_order","period_start","period_end","estimated_count","estimated_amount","estimated_total_amount"],"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX]","typeLabel":"object"},"description":"Estimated quantities declared on the quote for its usage-based and connected seat lines of the configuration. They price the quote value and are never billed. Once the quote is signed (a subscription update quote: once applied) they are frozen with their periods and amounts, as the record of what the quote sold.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0.estimates","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.0","typeLabel":"Subscription or update · object"},{"type":"object","title":"One-off invoice","required":["id","customer_id","position","amount","applied_at","type","invoice_id"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["one_off"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"invoice_id":{"oneOf":[{"type":"string","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX].oneOf.1","typeLabel":"One-off invoice · object"}],"uniqueKey":"data.items.[INDEX].oneOf.0.configurations.items.[INDEX]","typeLabel":"Subscription or update · object | One-off invoice · object"},"description":"Ordered configurations included in the quote.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.configurations","typeLabel":"(Subscription or update · object | One-off invoice · object)[]"},"template_id":{"oneOf":[{"type":"string","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.template_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.template_id","typeLabel":"string | null"},"crm_opportunity_id":{"oneOf":[{"type":"string","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.crm_opportunity_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.crm_opportunity_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.crm_opportunity_id","typeLabel":"string | null"},"custom_properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.custom_properties","typeLabel":"object | null"},"contract_value":{"oneOf":[{"type":"number","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.contract_value.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.contract_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.contract_value","typeLabel":"number | null"},"number":{"type":"string","description":"Quote sequential number.","example":"327","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.number","typeLabel":"string"},"comments":{"oneOf":[{"type":"string","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.comments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.comments","typeLabel":"string | null"},"terms":{"oneOf":[{"type":"string","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.terms","typeLabel":"string | null"},"owner_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.owner_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.owner_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.owner_email","typeLabel":"string\u003cemail> | null"},"collect_payment_details":{"type":"boolean","description":"Collect customer payment method mandate during signature flow or not.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.collect_payment_details","typeLabel":"boolean"},"collect_custom_property_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.collect_custom_property_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of the customer custom properties required to be filled during the signature flow.","example":[],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.collect_custom_property_ids","typeLabel":"string[]"},"require_tax_id":{"type":"boolean","description":"Require the customer to provide a tax ID during the signature flow.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.require_tax_id","typeLabel":"boolean"},"display_quote_value":{"type":"boolean","description":"Display the total quote value on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_quote_value","typeLabel":"boolean"},"display_quote_value_with_tax":{"type":"boolean","description":"Display the total quote value including tax on the quote. Only applies to `one_off` quotes.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_quote_value_with_tax","typeLabel":"boolean"},"display_taxes":{"type":"boolean","description":"Display tax breakdown on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_taxes","typeLabel":"boolean"},"display_price_tiers":{"type":"string","enum":["all","matching","none"],"description":"Controls which price tiers are displayed on the quote.\n\n- `all`: Display all pricing tiers.\n- `matching`: Only display the tiers used to compute the price based on quantity.\n- `none`: Hide all pricing tiers.\n","example":"matching","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_price_tiers","typeLabel":"enum\u003cstring>"},"display_phase_value":{"type":"boolean","description":"Display per-phase value breakdown on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_phase_value","typeLabel":"boolean"},"display_discounts_on_total":{"type":"boolean","description":"Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_discounts_on_total","typeLabel":"boolean"},"display_first_invoice_amount":{"type":"boolean","description":"Display the first invoice amount on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_first_invoice_amount","typeLabel":"boolean"},"display_documents_in_preview":{"type":"boolean","description":"Display attached documents in the quote preview.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_documents_in_preview","typeLabel":"boolean"},"subscription_update_display":{"type":"string","enum":["quote_update_details","subscription_details","both"],"description":"Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.","example":"quote_update_details","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscription_update_display","typeLabel":"enum\u003cstring>"},"post_signature_activation_enabled":{"type":"boolean","description":"Whether the subscription is automatically orchestrated after the quote is signed. Only applies to the Hyperline CPQ-only product.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.post_signature_activation_enabled","typeLabel":"boolean"},"generate_draft_invoices":{"type":"boolean","description":"When `true`, the invoice issued after signature stays in `draft` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to `false`.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.generate_draft_invoices","typeLabel":"boolean"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.attachments.items.[INDEX].name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.attachments.items.[INDEX].mimetype","typeLabel":"string"}},"required":["id","name","mimetype"],"uniqueKey":"data.items.[INDEX].oneOf.0.attachments.items.[INDEX]","typeLabel":"object"},"description":"List of documents attached to the quote.","example":[{"id":"quof_5GYXy8P3QCdaXh","name":"General Conditions of Sale","mimetype":"application/pdf"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.attachments","typeLabel":"object[]"},"signed_file":{"type":"object","description":"Final signed quote (manually uploaded).","required":["id","name","mimetype"],"example":null,"properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.signed_file.id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.signed_file.name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.signed_file.mimetype","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.signed_file","typeLabel":"object"},"url":{"oneOf":[{"type":"string","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.url","typeLabel":"string\u003curi> | null"},"created_at":{"type":"string","format":"date-time","description":"Quote creation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Quote update date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T10:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"subscription_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscription_id","typeLabel":"string | null"},"display_subscription_on_update":{"type":"boolean","deprecated":true,"description":"Deprecated. Use subscription_update_display. False displays quote update details; true displays both sections.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.display_subscription_on_update","typeLabel":"boolean"},"invoice_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.0.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.0.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.invoice_id","typeLabel":"string | null"},"child_subscription_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.child_subscription_ids.items.[INDEX]","typeLabel":"string"},"deprecated":true,"description":"Deprecated field, please use `GET /v2/subscriptions` with the `original_quote_id` filter.","uniqueKey":"data.items.[INDEX].oneOf.0.child_subscription_ids","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX].oneOf.0","typeLabel":"Draft · object"},{"type":"object","title":"Awaiting approval","required":["id","type","status","amount","customer_id","invoicing_entity_id","configurations","template_id","crm_opportunity_id","custom_properties","contract_value","number","comments","terms","owner_email","collect_payment_details","collect_custom_property_ids","require_tax_id","display_quote_value","display_quote_value_with_tax","display_taxes","display_price_tiers","display_phase_value","display_discounts_on_total","display_first_invoice_amount","display_documents_in_preview","subscription_update_display","post_signature_activation_enabled","generate_draft_invoices","attachments","signed_file","url","created_at","updated_at","expires_at","subscription_id","display_subscription_on_update"],"properties":{"id":{"type":"string","description":"Quote ID.","example":"quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"oneOf":[{"type":"string","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","enum":["pending_approval","changes_requested"],"description":"\nQuote status.\n\n- `draft`: The quote is a draft.\n- `pending_approval`: The quote is pending manager review and approval.\n- `changes_requested`: Some changes have been requested following manager review.\n- `approved`: The quote is approved and ready to be sent to the customer.\n- `pending_signature`: The quote is awaiting the customer's signature.\n- `signed`: The quote is signed and fully finalized.\n- `voided`: The quote is voided.\n","example":"pending_approval","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.amount","typeLabel":"number"},"customer_id":{"type":"string","description":"ID of the customer.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.customer_id","typeLabel":"string"},"invoicing_entity_id":{"type":"string","description":"ID of the invoicing entity attached to the quote.","example":"ive_47484fjdhy5","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.invoicing_entity_id","typeLabel":"string"},"configurations":{"type":"array","items":{"oneOf":[{"type":"object","title":"Subscription or update","required":["id","customer_id","position","amount","applied_at","type","subscription_id","contract_terms","estimates"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["subscription","subscription_update"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"subscription_id":{"oneOf":[{"type":"string","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.subscription_id","typeLabel":"string | null"},"contract_terms":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.status","typeLabel":"enum\u003cstring>"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.activation_strategy","typeLabel":"enum\u003cstring>"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.end_strategy","typeLabel":"enum\u003cstring>"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at","typeLabel":"string\u003cdate-time> | null"},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration","typeLabel":"object | null"},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically","typeLabel":"boolean | enum\u003cstring>"},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration","typeLabel":"object | null"},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at","typeLabel":"string\u003cdate-time> | null"},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at","typeLabel":"string\u003cdate-time> | null"}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"}]},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"}]},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}}]},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true}]},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}}]},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"}]},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"}]}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.contract_terms","typeLabel":"object | null"},"estimates":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","description":"ID of the estimated product in the catalog.","example":"itm_3kXODIM1sBwBbJ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].product_id","typeLabel":"string"},"price_configuration_id":{"oneOf":[{"type":"string","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id","typeLabel":"string | null"},"phase_order":{"type":"integer","description":"Order of the quote phase holding the estimated line.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].phase_order","typeLabel":"integer"},"period_start":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start","typeLabel":"string\u003cdate-time> | null"},"period_end":{"oneOf":[{"type":"string","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end","typeLabel":"string\u003cdate-time> | null"},"estimated_count":{"type":"number","description":"Estimated number of units per billing period.","example":200,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_count","typeLabel":"number"},"estimated_amount":{"oneOf":[{"type":"number","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount","typeLabel":"number | null"},"estimated_total_amount":{"oneOf":[{"type":"number","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount","typeLabel":"number | null"}},"required":["product_id","price_configuration_id","phase_order","period_start","period_end","estimated_count","estimated_amount","estimated_total_amount"],"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX]","typeLabel":"object"},"description":"Estimated quantities declared on the quote for its usage-based and connected seat lines of the configuration. They price the quote value and are never billed. Once the quote is signed (a subscription update quote: once applied) they are frozen with their periods and amounts, as the record of what the quote sold.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0.estimates","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.0","typeLabel":"Subscription or update · object"},{"type":"object","title":"One-off invoice","required":["id","customer_id","position","amount","applied_at","type","invoice_id"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["one_off"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"invoice_id":{"oneOf":[{"type":"string","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX].oneOf.1","typeLabel":"One-off invoice · object"}],"uniqueKey":"data.items.[INDEX].oneOf.1.configurations.items.[INDEX]","typeLabel":"Subscription or update · object | One-off invoice · object"},"description":"Ordered configurations included in the quote.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.configurations","typeLabel":"(Subscription or update · object | One-off invoice · object)[]"},"template_id":{"oneOf":[{"type":"string","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.template_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.template_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.template_id","typeLabel":"string | null"},"crm_opportunity_id":{"oneOf":[{"type":"string","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.crm_opportunity_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.crm_opportunity_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.crm_opportunity_id","typeLabel":"string | null"},"custom_properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.custom_properties","typeLabel":"object | null"},"contract_value":{"oneOf":[{"type":"number","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.contract_value.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.contract_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.contract_value","typeLabel":"number | null"},"number":{"type":"string","description":"Quote sequential number.","example":"327","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.number","typeLabel":"string"},"comments":{"oneOf":[{"type":"string","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.comments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.comments","typeLabel":"string | null"},"terms":{"oneOf":[{"type":"string","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.terms","typeLabel":"string | null"},"owner_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.owner_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.owner_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.owner_email","typeLabel":"string\u003cemail> | null"},"collect_payment_details":{"type":"boolean","description":"Collect customer payment method mandate during signature flow or not.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.collect_payment_details","typeLabel":"boolean"},"collect_custom_property_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.collect_custom_property_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of the customer custom properties required to be filled during the signature flow.","example":[],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.collect_custom_property_ids","typeLabel":"string[]"},"require_tax_id":{"type":"boolean","description":"Require the customer to provide a tax ID during the signature flow.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.require_tax_id","typeLabel":"boolean"},"display_quote_value":{"type":"boolean","description":"Display the total quote value on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_quote_value","typeLabel":"boolean"},"display_quote_value_with_tax":{"type":"boolean","description":"Display the total quote value including tax on the quote. Only applies to `one_off` quotes.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_quote_value_with_tax","typeLabel":"boolean"},"display_taxes":{"type":"boolean","description":"Display tax breakdown on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_taxes","typeLabel":"boolean"},"display_price_tiers":{"type":"string","enum":["all","matching","none"],"description":"Controls which price tiers are displayed on the quote.\n\n- `all`: Display all pricing tiers.\n- `matching`: Only display the tiers used to compute the price based on quantity.\n- `none`: Hide all pricing tiers.\n","example":"matching","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_price_tiers","typeLabel":"enum\u003cstring>"},"display_phase_value":{"type":"boolean","description":"Display per-phase value breakdown on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_phase_value","typeLabel":"boolean"},"display_discounts_on_total":{"type":"boolean","description":"Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_discounts_on_total","typeLabel":"boolean"},"display_first_invoice_amount":{"type":"boolean","description":"Display the first invoice amount on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_first_invoice_amount","typeLabel":"boolean"},"display_documents_in_preview":{"type":"boolean","description":"Display attached documents in the quote preview.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_documents_in_preview","typeLabel":"boolean"},"subscription_update_display":{"type":"string","enum":["quote_update_details","subscription_details","both"],"description":"Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.","example":"quote_update_details","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscription_update_display","typeLabel":"enum\u003cstring>"},"post_signature_activation_enabled":{"type":"boolean","description":"Whether the subscription is automatically orchestrated after the quote is signed. Only applies to the Hyperline CPQ-only product.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.post_signature_activation_enabled","typeLabel":"boolean"},"generate_draft_invoices":{"type":"boolean","description":"When `true`, the invoice issued after signature stays in `draft` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to `false`.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.generate_draft_invoices","typeLabel":"boolean"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.attachments.items.[INDEX].name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.attachments.items.[INDEX].mimetype","typeLabel":"string"}},"required":["id","name","mimetype"],"uniqueKey":"data.items.[INDEX].oneOf.1.attachments.items.[INDEX]","typeLabel":"object"},"description":"List of documents attached to the quote.","example":[{"id":"quof_5GYXy8P3QCdaXh","name":"General Conditions of Sale","mimetype":"application/pdf"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.attachments","typeLabel":"object[]"},"signed_file":{"type":"object","description":"Final signed quote (manually uploaded).","required":["id","name","mimetype"],"example":null,"properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.signed_file.id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.signed_file.name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.signed_file.mimetype","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.signed_file","typeLabel":"object"},"url":{"oneOf":[{"type":"string","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.url","typeLabel":"string\u003curi> | null"},"created_at":{"type":"string","format":"date-time","description":"Quote creation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Quote update date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T10:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-28T14:12:09.293Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.expires_at","typeLabel":"string\u003cdate-time>"},"subscription_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscription_id","typeLabel":"string | null"},"display_subscription_on_update":{"type":"boolean","deprecated":true,"description":"Deprecated. Use subscription_update_display. False displays quote update details; true displays both sections.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.display_subscription_on_update","typeLabel":"boolean"},"invoice_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"},"child_subscription_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.child_subscription_ids.items.[INDEX]","typeLabel":"string"},"deprecated":true,"description":"Deprecated field, please use `GET /v2/subscriptions` with the `original_quote_id` filter.","uniqueKey":"data.items.[INDEX].oneOf.1.child_subscription_ids","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX].oneOf.1","typeLabel":"Awaiting approval · object"},{"type":"object","title":"Ready for signature","required":["id","type","status","amount","customer_id","invoicing_entity_id","configurations","template_id","crm_opportunity_id","custom_properties","contract_value","number","comments","terms","owner_email","collect_payment_details","collect_custom_property_ids","require_tax_id","display_quote_value","display_quote_value_with_tax","display_taxes","display_price_tiers","display_phase_value","display_discounts_on_total","display_first_invoice_amount","display_documents_in_preview","subscription_update_display","post_signature_activation_enabled","generate_draft_invoices","attachments","signed_file","url","created_at","updated_at","expires_at","approved_at","subscription_id","display_subscription_on_update"],"properties":{"id":{"type":"string","description":"Quote ID.","example":"quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.id","typeLabel":"string"},"type":{"oneOf":[{"type":"string","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","enum":["approved","pending_signature"],"description":"\nQuote status.\n\n- `draft`: The quote is a draft.\n- `pending_approval`: The quote is pending manager review and approval.\n- `changes_requested`: Some changes have been requested following manager review.\n- `approved`: The quote is approved and ready to be sent to the customer.\n- `pending_signature`: The quote is awaiting the customer's signature.\n- `signed`: The quote is signed and fully finalized.\n- `voided`: The quote is voided.\n","example":"pending_signature","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.amount","typeLabel":"number"},"customer_id":{"type":"string","description":"ID of the customer.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.customer_id","typeLabel":"string"},"invoicing_entity_id":{"type":"string","description":"ID of the invoicing entity attached to the quote.","example":"ive_47484fjdhy5","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.invoicing_entity_id","typeLabel":"string"},"configurations":{"type":"array","items":{"oneOf":[{"type":"object","title":"Subscription or update","required":["id","customer_id","position","amount","applied_at","type","subscription_id","contract_terms","estimates"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["subscription","subscription_update"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"subscription_id":{"oneOf":[{"type":"string","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.subscription_id","typeLabel":"string | null"},"contract_terms":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.status","typeLabel":"enum\u003cstring>"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.activation_strategy","typeLabel":"enum\u003cstring>"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.end_strategy","typeLabel":"enum\u003cstring>"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at","typeLabel":"string\u003cdate-time> | null"},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration","typeLabel":"object | null"},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically","typeLabel":"boolean | enum\u003cstring>"},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration","typeLabel":"object | null"},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at","typeLabel":"string\u003cdate-time> | null"},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at","typeLabel":"string\u003cdate-time> | null"}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"}]},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"}]},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}}]},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true}]},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}}]},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"}]},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"}]}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.contract_terms","typeLabel":"object | null"},"estimates":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","description":"ID of the estimated product in the catalog.","example":"itm_3kXODIM1sBwBbJ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].product_id","typeLabel":"string"},"price_configuration_id":{"oneOf":[{"type":"string","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id","typeLabel":"string | null"},"phase_order":{"type":"integer","description":"Order of the quote phase holding the estimated line.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].phase_order","typeLabel":"integer"},"period_start":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start","typeLabel":"string\u003cdate-time> | null"},"period_end":{"oneOf":[{"type":"string","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end","typeLabel":"string\u003cdate-time> | null"},"estimated_count":{"type":"number","description":"Estimated number of units per billing period.","example":200,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_count","typeLabel":"number"},"estimated_amount":{"oneOf":[{"type":"number","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount","typeLabel":"number | null"},"estimated_total_amount":{"oneOf":[{"type":"number","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount","typeLabel":"number | null"}},"required":["product_id","price_configuration_id","phase_order","period_start","period_end","estimated_count","estimated_amount","estimated_total_amount"],"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX]","typeLabel":"object"},"description":"Estimated quantities declared on the quote for its usage-based and connected seat lines of the configuration. They price the quote value and are never billed. Once the quote is signed (a subscription update quote: once applied) they are frozen with their periods and amounts, as the record of what the quote sold.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0.estimates","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.0","typeLabel":"Subscription or update · object"},{"type":"object","title":"One-off invoice","required":["id","customer_id","position","amount","applied_at","type","invoice_id"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["one_off"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"invoice_id":{"oneOf":[{"type":"string","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX].oneOf.1","typeLabel":"One-off invoice · object"}],"uniqueKey":"data.items.[INDEX].oneOf.2.configurations.items.[INDEX]","typeLabel":"Subscription or update · object | One-off invoice · object"},"description":"Ordered configurations included in the quote.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.configurations","typeLabel":"(Subscription or update · object | One-off invoice · object)[]"},"template_id":{"oneOf":[{"type":"string","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.template_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.template_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.template_id","typeLabel":"string | null"},"crm_opportunity_id":{"oneOf":[{"type":"string","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.crm_opportunity_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.crm_opportunity_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.crm_opportunity_id","typeLabel":"string | null"},"custom_properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.custom_properties","typeLabel":"object | null"},"contract_value":{"oneOf":[{"type":"number","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.contract_value.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.contract_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.contract_value","typeLabel":"number | null"},"number":{"type":"string","description":"Quote sequential number.","example":"327","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.number","typeLabel":"string"},"comments":{"oneOf":[{"type":"string","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.comments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.comments","typeLabel":"string | null"},"terms":{"oneOf":[{"type":"string","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.terms","typeLabel":"string | null"},"owner_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.owner_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.owner_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.owner_email","typeLabel":"string\u003cemail> | null"},"collect_payment_details":{"type":"boolean","description":"Collect customer payment method mandate during signature flow or not.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.collect_payment_details","typeLabel":"boolean"},"collect_custom_property_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.collect_custom_property_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of the customer custom properties required to be filled during the signature flow.","example":[],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.collect_custom_property_ids","typeLabel":"string[]"},"require_tax_id":{"type":"boolean","description":"Require the customer to provide a tax ID during the signature flow.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.require_tax_id","typeLabel":"boolean"},"display_quote_value":{"type":"boolean","description":"Display the total quote value on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_quote_value","typeLabel":"boolean"},"display_quote_value_with_tax":{"type":"boolean","description":"Display the total quote value including tax on the quote. Only applies to `one_off` quotes.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_quote_value_with_tax","typeLabel":"boolean"},"display_taxes":{"type":"boolean","description":"Display tax breakdown on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_taxes","typeLabel":"boolean"},"display_price_tiers":{"type":"string","enum":["all","matching","none"],"description":"Controls which price tiers are displayed on the quote.\n\n- `all`: Display all pricing tiers.\n- `matching`: Only display the tiers used to compute the price based on quantity.\n- `none`: Hide all pricing tiers.\n","example":"matching","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_price_tiers","typeLabel":"enum\u003cstring>"},"display_phase_value":{"type":"boolean","description":"Display per-phase value breakdown on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_phase_value","typeLabel":"boolean"},"display_discounts_on_total":{"type":"boolean","description":"Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_discounts_on_total","typeLabel":"boolean"},"display_first_invoice_amount":{"type":"boolean","description":"Display the first invoice amount on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_first_invoice_amount","typeLabel":"boolean"},"display_documents_in_preview":{"type":"boolean","description":"Display attached documents in the quote preview.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_documents_in_preview","typeLabel":"boolean"},"subscription_update_display":{"type":"string","enum":["quote_update_details","subscription_details","both"],"description":"Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.","example":"quote_update_details","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscription_update_display","typeLabel":"enum\u003cstring>"},"post_signature_activation_enabled":{"type":"boolean","description":"Whether the subscription is automatically orchestrated after the quote is signed. Only applies to the Hyperline CPQ-only product.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.post_signature_activation_enabled","typeLabel":"boolean"},"generate_draft_invoices":{"type":"boolean","description":"When `true`, the invoice issued after signature stays in `draft` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to `false`.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.generate_draft_invoices","typeLabel":"boolean"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.attachments.items.[INDEX].name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.attachments.items.[INDEX].mimetype","typeLabel":"string"}},"required":["id","name","mimetype"],"uniqueKey":"data.items.[INDEX].oneOf.2.attachments.items.[INDEX]","typeLabel":"object"},"description":"List of documents attached to the quote.","example":[{"id":"quof_5GYXy8P3QCdaXh","name":"General Conditions of Sale","mimetype":"application/pdf"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.attachments","typeLabel":"object[]"},"signed_file":{"type":"object","description":"Final signed quote (manually uploaded).","required":["id","name","mimetype"],"example":null,"properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.signed_file.id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.signed_file.name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.signed_file.mimetype","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.signed_file","typeLabel":"object"},"url":{"oneOf":[{"type":"string","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.url","typeLabel":"string\u003curi> | null"},"created_at":{"type":"string","format":"date-time","description":"Quote creation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Quote update date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T10:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.updated_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-28T14:12:09.293Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.expires_at","typeLabel":"string\u003cdate-time>"},"approved_at":{"type":"string","format":"date-time","description":"Quote approbation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-24T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.approved_at","typeLabel":"string\u003cdate-time>"},"subscription_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscription_id","typeLabel":"string | null"},"display_subscription_on_update":{"type":"boolean","deprecated":true,"description":"Deprecated. Use subscription_update_display. False displays quote update details; true displays both sections.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.display_subscription_on_update","typeLabel":"boolean"},"invoice_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.2.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.2.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.invoice_id","typeLabel":"string | null"},"child_subscription_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.child_subscription_ids.items.[INDEX]","typeLabel":"string"},"deprecated":true,"description":"Deprecated field, please use `GET /v2/subscriptions` with the `original_quote_id` filter.","uniqueKey":"data.items.[INDEX].oneOf.2.child_subscription_ids","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX].oneOf.2","typeLabel":"Ready for signature · object"},{"type":"object","title":"Signed","required":["id","type","status","amount","customer_id","invoicing_entity_id","configurations","template_id","crm_opportunity_id","custom_properties","contract_value","number","comments","terms","owner_email","collect_payment_details","collect_custom_property_ids","require_tax_id","display_quote_value","display_quote_value_with_tax","display_taxes","display_price_tiers","display_phase_value","display_discounts_on_total","display_first_invoice_amount","display_documents_in_preview","subscription_update_display","post_signature_activation_enabled","generate_draft_invoices","attachments","signed_file","url","created_at","updated_at","expires_at","approved_at","signature","signed_at","subscription_id","display_subscription_on_update"],"properties":{"id":{"type":"string","description":"Quote ID.","example":"quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.id","typeLabel":"string"},"type":{"oneOf":[{"type":"string","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","enum":["signed"],"description":"\nQuote status.\n\n- `draft`: The quote is a draft.\n- `pending_approval`: The quote is pending manager review and approval.\n- `changes_requested`: Some changes have been requested following manager review.\n- `approved`: The quote is approved and ready to be sent to the customer.\n- `pending_signature`: The quote is awaiting the customer's signature.\n- `signed`: The quote is signed and fully finalized.\n- `voided`: The quote is voided.\n","example":"signed","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.amount","typeLabel":"number"},"customer_id":{"type":"string","description":"ID of the customer.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.customer_id","typeLabel":"string"},"invoicing_entity_id":{"type":"string","description":"ID of the invoicing entity attached to the quote.","example":"ive_47484fjdhy5","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.invoicing_entity_id","typeLabel":"string"},"configurations":{"type":"array","items":{"oneOf":[{"type":"object","title":"Subscription or update","required":["id","customer_id","position","amount","applied_at","type","subscription_id","contract_terms","estimates"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["subscription","subscription_update"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"subscription_id":{"oneOf":[{"type":"string","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.subscription_id","typeLabel":"string | null"},"contract_terms":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.status","typeLabel":"enum\u003cstring>"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.activation_strategy","typeLabel":"enum\u003cstring>"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.end_strategy","typeLabel":"enum\u003cstring>"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at","typeLabel":"string\u003cdate-time> | null"},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration","typeLabel":"object | null"},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically","typeLabel":"boolean | enum\u003cstring>"},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration","typeLabel":"object | null"},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at","typeLabel":"string\u003cdate-time> | null"},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at","typeLabel":"string\u003cdate-time> | null"}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"}]},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"}]},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}}]},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true}]},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}}]},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"}]},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"}]}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.contract_terms","typeLabel":"object | null"},"estimates":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","description":"ID of the estimated product in the catalog.","example":"itm_3kXODIM1sBwBbJ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].product_id","typeLabel":"string"},"price_configuration_id":{"oneOf":[{"type":"string","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id","typeLabel":"string | null"},"phase_order":{"type":"integer","description":"Order of the quote phase holding the estimated line.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].phase_order","typeLabel":"integer"},"period_start":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start","typeLabel":"string\u003cdate-time> | null"},"period_end":{"oneOf":[{"type":"string","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end","typeLabel":"string\u003cdate-time> | null"},"estimated_count":{"type":"number","description":"Estimated number of units per billing period.","example":200,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_count","typeLabel":"number"},"estimated_amount":{"oneOf":[{"type":"number","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount","typeLabel":"number | null"},"estimated_total_amount":{"oneOf":[{"type":"number","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount","typeLabel":"number | null"}},"required":["product_id","price_configuration_id","phase_order","period_start","period_end","estimated_count","estimated_amount","estimated_total_amount"],"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX]","typeLabel":"object"},"description":"Estimated quantities declared on the quote for its usage-based and connected seat lines of the configuration. They price the quote value and are never billed. Once the quote is signed (a subscription update quote: once applied) they are frozen with their periods and amounts, as the record of what the quote sold.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0.estimates","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.0","typeLabel":"Subscription or update · object"},{"type":"object","title":"One-off invoice","required":["id","customer_id","position","amount","applied_at","type","invoice_id"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["one_off"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"invoice_id":{"oneOf":[{"type":"string","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX].oneOf.1","typeLabel":"One-off invoice · object"}],"uniqueKey":"data.items.[INDEX].oneOf.3.configurations.items.[INDEX]","typeLabel":"Subscription or update · object | One-off invoice · object"},"description":"Ordered configurations included in the quote.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.configurations","typeLabel":"(Subscription or update · object | One-off invoice · object)[]"},"template_id":{"oneOf":[{"type":"string","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.template_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.template_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.template_id","typeLabel":"string | null"},"crm_opportunity_id":{"oneOf":[{"type":"string","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.crm_opportunity_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.crm_opportunity_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.crm_opportunity_id","typeLabel":"string | null"},"custom_properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.custom_properties","typeLabel":"object | null"},"contract_value":{"oneOf":[{"type":"number","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.contract_value.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.contract_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.contract_value","typeLabel":"number | null"},"number":{"type":"string","description":"Quote sequential number.","example":"327","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.number","typeLabel":"string"},"comments":{"oneOf":[{"type":"string","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.comments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.comments","typeLabel":"string | null"},"terms":{"oneOf":[{"type":"string","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.terms","typeLabel":"string | null"},"owner_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.owner_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.owner_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.owner_email","typeLabel":"string\u003cemail> | null"},"collect_payment_details":{"type":"boolean","description":"Collect customer payment method mandate during signature flow or not.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.collect_payment_details","typeLabel":"boolean"},"collect_custom_property_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.3.collect_custom_property_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of the customer custom properties required to be filled during the signature flow.","example":[],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.collect_custom_property_ids","typeLabel":"string[]"},"require_tax_id":{"type":"boolean","description":"Require the customer to provide a tax ID during the signature flow.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.require_tax_id","typeLabel":"boolean"},"display_quote_value":{"type":"boolean","description":"Display the total quote value on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_quote_value","typeLabel":"boolean"},"display_quote_value_with_tax":{"type":"boolean","description":"Display the total quote value including tax on the quote. Only applies to `one_off` quotes.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_quote_value_with_tax","typeLabel":"boolean"},"display_taxes":{"type":"boolean","description":"Display tax breakdown on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_taxes","typeLabel":"boolean"},"display_price_tiers":{"type":"string","enum":["all","matching","none"],"description":"Controls which price tiers are displayed on the quote.\n\n- `all`: Display all pricing tiers.\n- `matching`: Only display the tiers used to compute the price based on quantity.\n- `none`: Hide all pricing tiers.\n","example":"matching","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_price_tiers","typeLabel":"enum\u003cstring>"},"display_phase_value":{"type":"boolean","description":"Display per-phase value breakdown on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_phase_value","typeLabel":"boolean"},"display_discounts_on_total":{"type":"boolean","description":"Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_discounts_on_total","typeLabel":"boolean"},"display_first_invoice_amount":{"type":"boolean","description":"Display the first invoice amount on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_first_invoice_amount","typeLabel":"boolean"},"display_documents_in_preview":{"type":"boolean","description":"Display attached documents in the quote preview.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_documents_in_preview","typeLabel":"boolean"},"subscription_update_display":{"type":"string","enum":["quote_update_details","subscription_details","both"],"description":"Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.","example":"quote_update_details","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.subscription_update_display","typeLabel":"enum\u003cstring>"},"post_signature_activation_enabled":{"type":"boolean","description":"Whether the subscription is automatically orchestrated after the quote is signed. Only applies to the Hyperline CPQ-only product.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.post_signature_activation_enabled","typeLabel":"boolean"},"generate_draft_invoices":{"type":"boolean","description":"When `true`, the invoice issued after signature stays in `draft` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to `false`.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.generate_draft_invoices","typeLabel":"boolean"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.attachments.items.[INDEX].name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.attachments.items.[INDEX].mimetype","typeLabel":"string"}},"required":["id","name","mimetype"],"uniqueKey":"data.items.[INDEX].oneOf.3.attachments.items.[INDEX]","typeLabel":"object"},"description":"List of documents attached to the quote.","example":[{"id":"quof_5GYXy8P3QCdaXh","name":"General Conditions of Sale","mimetype":"application/pdf"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.attachments","typeLabel":"object[]"},"signed_file":{"type":"object","description":"Final signed quote (manually uploaded).","required":["id","name","mimetype"],"example":null,"properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signed_file.id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signed_file.name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signed_file.mimetype","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signed_file","typeLabel":"object"},"url":{"oneOf":[{"type":"string","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.url","typeLabel":"string\u003curi> | null"},"created_at":{"type":"string","format":"date-time","description":"Quote creation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Quote update date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T10:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.updated_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"type":"string","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-28T14:12:09.293Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.expires_at","typeLabel":"string\u003cdate-time>"},"approved_at":{"type":"string","format":"date-time","description":"Quote approbation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-24T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.approved_at","typeLabel":"string\u003cdate-time>"},"signature":{"oneOf":[{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode","signerName"],"example":{"mode":"basic","signerName":"Acme"},"properties":{"mode":{"type":"string","enum":["basic"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"basic","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"signerName":{"type":"string","description":"Signer name of the quote.","example":"Acme","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.0.signerName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.0","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode","signerName"],"example":{"mode":"basic","signerName":"Acme"},"properties":{"mode":{"type":"string","enum":["electronic"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"electronic","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"signerName":{"type":"string","description":"Signer name of the quote.","example":"Acme","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.1.signerName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.1","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode"],"example":{"mode":"basic"},"properties":{"mode":{"type":"string","enum":["external"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"external","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.2.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signature","typeLabel":"object"},"signed_at":{"type":"string","format":"date-time","description":"Quote signature date. Only applies to the `signed` quote.","example":"2024-04-25T12:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.signed_at","typeLabel":"string\u003cdate-time>"},"subscription_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.subscription_id","typeLabel":"string | null"},"display_subscription_on_update":{"type":"boolean","deprecated":true,"description":"Deprecated. Use subscription_update_display. False displays quote update details; true displays both sections.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.3.display_subscription_on_update","typeLabel":"boolean"},"invoice_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.3.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.3.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.3.invoice_id","typeLabel":"string | null"},"child_subscription_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.3.child_subscription_ids.items.[INDEX]","typeLabel":"string"},"deprecated":true,"description":"Deprecated field, please use `GET /v2/subscriptions` with the `original_quote_id` filter.","uniqueKey":"data.items.[INDEX].oneOf.3.child_subscription_ids","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX].oneOf.3","typeLabel":"Signed · object"},{"type":"object","title":"Voided","required":["id","type","status","amount","customer_id","invoicing_entity_id","configurations","template_id","crm_opportunity_id","custom_properties","contract_value","number","comments","terms","owner_email","collect_payment_details","collect_custom_property_ids","require_tax_id","display_quote_value","display_quote_value_with_tax","display_taxes","display_price_tiers","display_phase_value","display_discounts_on_total","display_first_invoice_amount","display_documents_in_preview","subscription_update_display","post_signature_activation_enabled","generate_draft_invoices","attachments","signed_file","url","created_at","updated_at","void_reason","voided_at","expires_at","approved_at","signature","signed_at","subscription_id","display_subscription_on_update"],"properties":{"id":{"type":"string","description":"Quote ID.","example":"quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.id","typeLabel":"string"},"type":{"oneOf":[{"type":"string","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["subscription","subscription_update","one_off","mixed"],"description":"\nQuote type.\n\n- `subscription`: The quote will create one or more subscriptions.\n- `subscription_update`: The quote will update one or more existing subscriptions.\n- `one_off`: The quote will issue one or more one-off invoices.\n- `mixed`: Mixed configuration types.\n- `null`: Empty quote.\n","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.type","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","enum":["voided"],"description":"\nQuote status.\n\n- `draft`: The quote is a draft.\n- `pending_approval`: The quote is pending manager review and approval.\n- `changes_requested`: Some changes have been requested following manager review.\n- `approved`: The quote is approved and ready to be sent to the customer.\n- `pending_signature`: The quote is awaiting the customer's signature.\n- `signed`: The quote is signed and fully finalized.\n- `voided`: The quote is voided.\n","example":"voided","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.status","typeLabel":"enum\u003cstring>"},"amount":{"oneOf":[{"type":"number","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Estimated contract value. When computed, a subscription phase with neither an end date nor a fixed duration is counted over a conventional horizon: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is not an end date: the subscription can run past it. Usage-based and connected seat lines are priced at their estimated quantity when it exceeds the committed quantity and, for seats, the live seat count.","example":20000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.amount","typeLabel":"number | null"},"customer_id":{"type":"string","description":"ID of the customer.","example":"cus_QalW2vTAdkR6IY","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.customer_id","typeLabel":"string"},"invoicing_entity_id":{"type":"string","description":"ID of the invoicing entity attached to the quote.","example":"ive_47484fjdhy5","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.invoicing_entity_id","typeLabel":"string"},"configurations":{"type":"array","items":{"oneOf":[{"type":"object","title":"Subscription or update","required":["id","customer_id","position","amount","applied_at","type","subscription_id","contract_terms","estimates"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["subscription","subscription_update"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"subscription_id":{"oneOf":[{"type":"string","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subscription configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.subscription_id","typeLabel":"string | null"},"contract_terms":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.status","typeLabel":"enum\u003cstring>"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.activation_strategy","typeLabel":"enum\u003cstring>"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.end_strategy","typeLabel":"enum\u003cstring>"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.starts_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.ends_at","typeLabel":"string\u003cdate-time> | null"},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.duration","typeLabel":"object | null"},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_automatically","typeLabel":"boolean | enum\u003cstring>"},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.period","typeLabel":"enum\u003cstring>"},"count":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0.count","typeLabel":"number"}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.renew_for_duration","typeLabel":"object | null"},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_started_at","typeLabel":"string\u003cdate-time> | null"},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0.current_period_ends_at","typeLabel":"string\u003cdate-time> | null"}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"status":{"type":"string","enum":["active","pending","finished"],"description":"\nContract status.\n\n- `active`: The contract is active.\n- `pending`: The contract is pending. It will be activated according to the activation strategy.\n- `finished`: The contract has ended.\n","example":"active"},"activation_strategy":{"type":"string","enum":["start_date","immediately","manual","quote_signature","checkout"],"description":"\nActivation strategy of the contract.\n\n- `immediately`: The contract will be activated immediately.\n- `manual`: The contract will be activated when a user manually activates it.\n- `start_date`: The contract will be activated on a specified date.\n- `quote_signature`: The contract will be activated when the subscription quote is signed.\n- `checkout`: The contract will be activated when the subscription checkout is completed.\n","example":"start_date"},"end_strategy":{"type":"string","enum":["end_date","duration","manual"],"description":"\nEnd strategy of contract.\n\n- `manual`: The contract ends when a user manually stops it.\n- `end_date`: The contract ends on a specified date.\n- `duration`: The contract ends after a specific relative duration, unless `renew_automatically` is true.\n","example":"duration"},"starts_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-12-31T23:00:00.000Z"}]},"ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the contract. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T21:59:59.999Z"}]},"duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"Interval over which the contract initially spans. Only applies to `duration` end strategy.","example":{"count":6,"period":"months"}}]},"renew_automatically":{"oneOf":[{"type":"boolean","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","example":true},{"type":"string","description":"\nIndicates if the contract should be renewed automatically.\n\n- `true`: The contract will be renewed automatically.\n- `false`: The contract will not be renewed automatically.\n","enum":["true","false"],"example":true}]},"renew_for_duration":{"oneOf":[{"type":"object","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}},{"type":"null","properties":{"period":{"type":"string","enum":["days","weeks","months","years"]},"count":{"type":"number","exclusiveMinimum":0}},"required":["period","count"],"description":"\nInterval over which the contract will be renewed. Only applies if `renew_automatically` is true.\n","example":{"count":1,"period":"years"}}]},"current_period_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"},{"type":"null","format":"date-time","description":"Start date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2025-06-30T22:00:00.000Z"}]},"current_period_ends_at":{"oneOf":[{"type":"string","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"},{"type":"null","format":"date-time","description":"End date of the current contract period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2026-06-30T21:59:59.999Z"}]}},"required":["status","activation_strategy","end_strategy","starts_at","ends_at","duration","renew_automatically","renew_for_duration","current_period_started_at","current_period_ends_at"],"description":"Contract terms (start, duration, renewal) of the configuration's subscription, or null when it has no custom contract. On a `subscription_update` configuration, these are the terms the quote proposes, read from its draft copy of the subscription: `status` is the amended contract's status when the quote was created, and `current_period_started_at` and `current_period_ends_at` are null (read them on the subscription).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.contract_terms","typeLabel":"object | null"},"estimates":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string","description":"ID of the estimated product in the catalog.","example":"itm_3kXODIM1sBwBbJ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].product_id","typeLabel":"string"},"price_configuration_id":{"oneOf":[{"type":"string","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the catalog price configuration the line was priced from, if any.","example":"prc_8f3kXODIM1sBwB","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].price_configuration_id","typeLabel":"string | null"},"phase_order":{"type":"integer","description":"Order of the quote phase holding the estimated line.","example":0,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].phase_order","typeLabel":"integer"},"period_start":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the period the estimate was sold for: its phase's start, or for a first phase starting only once the subscription does (signature, checkout, payment, a manual start) the contract's start, else the subscription's, else the signature date. For a subscription update quote, its first updated phase starts at the update's effective date. Null until the quote is signed, and for a phase starting after one that ends manually.","example":"2026-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_start","typeLabel":"string\u003cdate-time> | null"},"period_end":{"oneOf":[{"type":"string","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the period the estimate was sold for: its phase's end (the contract's end for a phase ending with it), else, for an open-ended phase, the horizon the quote value counts: the contract's length for a single phase on a contract that has one, otherwise 12 months or the longest billing interval if longer. That horizon is a convention, not an end date: an open-ended subscription can run past it. Null when `period_start` is.","example":"2026-12-31T23:59:59.999Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].period_end","typeLabel":"string\u003cdate-time> | null"},"estimated_count":{"type":"number","description":"Estimated number of units per billing period.","example":200,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_count","typeLabel":"number"},"estimated_amount":{"oneOf":[{"type":"number","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount of one billing period of the line (its billing interval) priced at the estimate: the first one, excluding taxes, with its discounts applied. Null when the estimate doesn't raise the price, and until the quote is signed.","example":2000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_amount","typeLabel":"number | null"},"estimated_total_amount":{"oneOf":[{"type":"number","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the line bills at the estimate over every billing period between `period_start` and `period_end`, excluding taxes, each period with the discounts applying to it. It can differ from the quote value, which counts a phase without dates over its own horizon. Null when `estimated_amount` or `period_start` is. The frozen record never follows later changes to the subscription: when several update quotes cover the same line and period, the latest signed one is the current estimate, which `GET /v1/subscriptions/{id}/estimates` resolves.","example":24000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX].estimated_total_amount","typeLabel":"number | null"}},"required":["product_id","price_configuration_id","phase_order","period_start","period_end","estimated_count","estimated_amount","estimated_total_amount"],"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates.items.[INDEX]","typeLabel":"object"},"description":"Estimated quantities declared on the quote for its usage-based and connected seat lines of the configuration. They price the quote value and are never billed. Once the quote is signed (a subscription update quote: once applied) they are frozen with their periods and amounts, as the record of what the quote sold.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0.estimates","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.0","typeLabel":"Subscription or update · object"},{"type":"object","title":"One-off invoice","required":["id","customer_id","position","amount","applied_at","type","invoice_id"],"properties":{"id":{"type":"string","description":"Quote configuration ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Child customer ID, or null to use the quote customer.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.customer_id","typeLabel":"string | null"},"position":{"type":"integer","description":"Configuration order within the quote, starting at zero.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.position","typeLabel":"integer"},"amount":{"oneOf":[{"type":"number","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Configuration amount excluding tax, in minor currency units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.amount","typeLabel":"number | null"},"applied_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the post-signature action completed, or null if not applied.","example":"2024-12-20T16:04:11Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.applied_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.applied_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["one_off"],"description":"Configuration type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"invoice_id":{"oneOf":[{"type":"string","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Draft invoice configuration ID, or null if not configured.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1.invoice_id","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX].oneOf.1","typeLabel":"One-off invoice · object"}],"uniqueKey":"data.items.[INDEX].oneOf.4.configurations.items.[INDEX]","typeLabel":"Subscription or update · object | One-off invoice · object"},"description":"Ordered configurations included in the quote.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.configurations","typeLabel":"(Subscription or update · object | One-off invoice · object)[]"},"template_id":{"oneOf":[{"type":"string","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.template_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the quote template.","example":"quot_9hNWq4c84Z146W","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.template_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.template_id","typeLabel":"string | null"},"crm_opportunity_id":{"oneOf":[{"type":"string","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.crm_opportunity_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the related opportunity/deal in the connected CRM.","example":"opp_Z2oSqnBCUoo1bQ","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.crm_opportunity_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.crm_opportunity_id","typeLabel":"string | null"},"custom_properties":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","description":"UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","example":"2024-12-20T16:04:11Z","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"},{"type":"null","uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | string\u003cdate-time> | string[] | null"},"description":"Custom property values set on the quote itself, keyed by slug. Custom property values of a quote's subscription are returned on the subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.custom_properties","typeLabel":"object | null"},"contract_value":{"oneOf":[{"type":"number","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.contract_value.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for `subscription` and `subscription_update` quotes, unless set manually. Not set on `one_off` quotes.","example":18000,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.contract_value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.contract_value","typeLabel":"number | null"},"number":{"type":"string","description":"Quote sequential number.","example":"327","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.number","typeLabel":"string"},"comments":{"oneOf":[{"type":"string","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom comments displayed on the quote.","example":"Please find the contract and subscription details we discussed.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.comments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.comments","typeLabel":"string | null"},"terms":{"oneOf":[{"type":"string","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom quotation terms.","example":"By signing this quote, you accept our conditions of use for the use of our products and services.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.terms.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.terms","typeLabel":"string | null"},"owner_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.owner_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the Hyperline user acting as the quote owner. The user must be a member of your Hyperline account. The owner requests approval when the quote is finalized using an API key or finalized during creation.","example":"joe@acme.com","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.owner_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.owner_email","typeLabel":"string\u003cemail> | null"},"collect_payment_details":{"type":"boolean","description":"Collect customer payment method mandate during signature flow or not.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.collect_payment_details","typeLabel":"boolean"},"collect_custom_property_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.4.collect_custom_property_ids.items.[INDEX]","typeLabel":"string"},"description":"IDs of the customer custom properties required to be filled during the signature flow.","example":[],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.collect_custom_property_ids","typeLabel":"string[]"},"require_tax_id":{"type":"boolean","description":"Require the customer to provide a tax ID during the signature flow.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.require_tax_id","typeLabel":"boolean"},"display_quote_value":{"type":"boolean","description":"Display the total quote value on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_quote_value","typeLabel":"boolean"},"display_quote_value_with_tax":{"type":"boolean","description":"Display the total quote value including tax on the quote. Only applies to `one_off` quotes.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_quote_value_with_tax","typeLabel":"boolean"},"display_taxes":{"type":"boolean","description":"Display tax breakdown on the quote.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_taxes","typeLabel":"boolean"},"display_price_tiers":{"type":"string","enum":["all","matching","none"],"description":"Controls which price tiers are displayed on the quote.\n\n- `all`: Display all pricing tiers.\n- `matching`: Only display the tiers used to compute the price based on quantity.\n- `none`: Hide all pricing tiers.\n","example":"matching","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_price_tiers","typeLabel":"enum\u003cstring>"},"display_phase_value":{"type":"boolean","description":"Display per-phase value breakdown on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_phase_value","typeLabel":"boolean"},"display_discounts_on_total":{"type":"boolean","description":"Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_discounts_on_total","typeLabel":"boolean"},"display_first_invoice_amount":{"type":"boolean","description":"Display the first invoice amount on the quote.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_first_invoice_amount","typeLabel":"boolean"},"display_documents_in_preview":{"type":"boolean","description":"Display attached documents in the quote preview.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_documents_in_preview","typeLabel":"boolean"},"subscription_update_display":{"type":"string","enum":["quote_update_details","subscription_details","both"],"description":"Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.","example":"quote_update_details","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.subscription_update_display","typeLabel":"enum\u003cstring>"},"post_signature_activation_enabled":{"type":"boolean","description":"Whether the subscription is automatically orchestrated after the quote is signed. Only applies to the Hyperline CPQ-only product.","example":true,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.post_signature_activation_enabled","typeLabel":"boolean"},"generate_draft_invoices":{"type":"boolean","description":"When `true`, the invoice issued after signature stays in `draft` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to `false`.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.generate_draft_invoices","typeLabel":"boolean"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.attachments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.attachments.items.[INDEX].name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.attachments.items.[INDEX].mimetype","typeLabel":"string"}},"required":["id","name","mimetype"],"uniqueKey":"data.items.[INDEX].oneOf.4.attachments.items.[INDEX]","typeLabel":"object"},"description":"List of documents attached to the quote.","example":[{"id":"quof_5GYXy8P3QCdaXh","name":"General Conditions of Sale","mimetype":"application/pdf"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.attachments","typeLabel":"object[]"},"signed_file":{"type":"object","description":"Final signed quote (manually uploaded).","required":["id","name","mimetype"],"example":null,"properties":{"id":{"type":"string","description":"Quote file ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_file.id","typeLabel":"string"},"name":{"type":"string","description":"Quote file name.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_file.name","typeLabel":"string"},"mimetype":{"type":"string","description":"Quote file MIME type.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_file.mimetype","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_file","typeLabel":"object"},"url":{"oneOf":[{"type":"string","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.","example":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.url","typeLabel":"string\u003curi> | null"},"created_at":{"type":"string","format":"date-time","description":"Quote creation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Quote update date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-23T10:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.updated_at","typeLabel":"string\u003cdate-time>"},"void_reason":{"type":"string","description":"Quote voiding reason. Only applies to the `voided` quote.","example":"The customer is ultimately not interested.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.void_reason","typeLabel":"string"},"voided_at":{"type":"string","format":"date-time","description":"Quote voiding date. Only applies to the `voided` quote.","example":"2024-04-26T12:00:01.320Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.voided_at","typeLabel":"string\u003cdate-time>"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":null,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.expires_at","typeLabel":"string\u003cdate-time> | null"},"approved_at":{"oneOf":[{"type":"string","format":"date-time","description":"Quote approbation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-24T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.approved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quote approbation date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","example":"2024-04-24T09:10:00.220Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.approved_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.approved_at","typeLabel":"string\u003cdate-time> | null"},"signature":{"oneOf":[{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode"],"example":{"mode":"basic"},"properties":{"mode":{"type":"string","enum":["basic"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"basic","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.0.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.0","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode"],"example":{"mode":"basic"},"properties":{"mode":{"type":"string","enum":["electronic"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"electronic","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.1.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.1","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode"],"example":{"mode":"basic"},"properties":{"mode":{"type":"string","enum":["external"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"external","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.2.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.2","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode","signerName"],"example":{"mode":"basic","signerName":"Acme"},"properties":{"mode":{"type":"string","enum":["basic"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"basic","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.3.mode","typeLabel":"enum\u003cstring>"},"signerName":{"type":"string","description":"Signer name of the quote.","example":"Acme","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.3.signerName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.3","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode","signerName"],"example":{"mode":"basic","signerName":"Acme"},"properties":{"mode":{"type":"string","enum":["electronic"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"electronic","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.4.mode","typeLabel":"enum\u003cstring>"},"signerName":{"type":"string","description":"Signer name of the quote.","example":"Acme","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.4.signerName","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.4","typeLabel":"object"},{"type":"object","description":"Quote signature. Only applies to the `signed` quote.","required":["mode"],"example":{"mode":"basic"},"properties":{"mode":{"type":"string","enum":["external"],"description":"\nSignature mode.\n\n- `basic`: Basic signature. The signer manually put his name. No legal value.\n- `electronic`: Certified electronic signature. Legally compliant.\n- `external`: Signed outside of Hyperline. A signed file has been uploaded.\n","example":"external","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.5.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.5","typeLabel":"object"},{"type":"null","description":"Quote signature. Only applies to the `signed` quote.","example":{"mode":"basic","signerName":"Acme"},"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature.oneOf.6","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signature","typeLabel":"object · object · object · object · object · object · null"},"signed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Quote signature date. Only applies to the `signed` quote.","example":"2024-04-25T12:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quote signature date. Only applies to the `signed` quote.","example":"2024-04-25T12:22:08.100Z","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.signed_at","typeLabel":"string\u003cdate-time> | null"},"subscription_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].subscription_id`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.subscription_id","typeLabel":"string | null"},"display_subscription_on_update":{"type":"boolean","deprecated":true,"description":"Deprecated. Use subscription_update_display. False displays quote update details; true displays both sections.","example":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.4.display_subscription_on_update","typeLabel":"boolean"},"invoice_id":{"oneOf":[{"type":"string","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.4.invoice_id.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"description":"Deprecated field, please use `configurations[].invoice_id`.","uniqueKey":"data.items.[INDEX].oneOf.4.invoice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.4.invoice_id","typeLabel":"string | null"},"child_subscription_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.4.child_subscription_ids.items.[INDEX]","typeLabel":"string"},"deprecated":true,"description":"Deprecated field, please use `GET /v2/subscriptions` with the `original_quote_id` filter.","uniqueKey":"data.items.[INDEX].oneOf.4.child_subscription_ids","typeLabel":"string[]"}},"uniqueKey":"data.items.[INDEX].oneOf.4","typeLabel":"Voided · object"}],"uniqueKey":"data.items.[INDEX]","typeLabel":"Draft · object | Awaiting approval · object | Ready for signature · object | Signed · object | Voided · object"},"description":"List of Quote.","isRequired":true,"uniqueKey":"data","typeLabel":"(Draft · object | Awaiting approval · object | Ready for signature · object | Signed · object | Voided · object)[]"}},"required":["meta","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"meta":{"total":1,"taken":1,"skipped":0},"data":[{"id":"quo_hXQCd5y8P3GYXa","type":"subscription","status":"draft","amount":200000,"customer_id":"cus_QalW2vTAdkR6IY","invoicing_entity_id":"ive_47484fjdhy5","configurations":[{"id":"\u003cstring>","customer_id":"\u003cstring>","position":123,"amount":123,"applied_at":"2024-12-20T16:04:11Z","type":"subscription","subscription_id":"\u003cstring>","contract_terms":{"status":"active","activation_strategy":"start_date","end_strategy":"duration","starts_at":"2024-12-31T23:00:00.000Z","ends_at":"2025-06-30T21:59:59.999Z","duration":{"count":6,"period":"months"},"renew_automatically":true,"renew_for_duration":{"count":1,"period":"years"},"current_period_started_at":"2025-06-30T22:00:00.000Z","current_period_ends_at":"2026-06-30T21:59:59.999Z"},"estimates":[{"product_id":"itm_3kXODIM1sBwBbJ","price_configuration_id":"prc_8f3kXODIM1sBwB","phase_order":0,"period_start":"2026-01-01T00:00:00.000Z","period_end":"2026-12-31T23:59:59.999Z","estimated_count":200,"estimated_amount":2000,"estimated_total_amount":24000}]}],"template_id":"quot_9hNWq4c84Z146W","crm_opportunity_id":"opp_Z2oSqnBCUoo1bQ","custom_properties":{},"contract_value":18000,"number":"327","comments":"Please find the contract and subscription details we discussed.","terms":"By signing this quote, you accept our conditions of use for the use of our products and services.","owner_email":"joe@acme.com","collect_payment_details":true,"collect_custom_property_ids":[],"require_tax_id":false,"display_quote_value":true,"display_quote_value_with_tax":false,"display_taxes":true,"display_price_tiers":"matching","display_phase_value":false,"display_discounts_on_total":false,"display_first_invoice_amount":false,"display_documents_in_preview":false,"subscription_update_display":"quote_update_details","post_signature_activation_enabled":true,"generate_draft_invoices":false,"attachments":[{"id":"quof_5GYXy8P3QCdaXh","name":"General Conditions of Sale","mimetype":"application/pdf"}],"signed_file":null,"url":"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa","created_at":"2024-04-23T09:10:00.220Z","updated_at":"2024-04-23T10:22:08.100Z","expires_at":null,"subscription_id":"\u003cstring>","display_subscription_on_update":false,"invoice_id":"\u003cstring>","child_subscription_ids":["\u003cstring>"]}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f5abb228-be83-4d68-898d-e367be417430":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"09993eee-d706-4786-83dc-094b23d5da0e":{"url":"https://api.hyperline.co"},"47e2e692-210a-4cfb-8dfc-5fc05358a42e":{"url":"https://sandbox.api.hyperline.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"},"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","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi-main.json"},"subdomain":"hyperline","siteName":"Hyperline","title":"List quotes - Hyperline","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-05T16:12:48.615Z","originalFileLocation":"api-reference/endpoints/quotes/list-quotes.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=\"light\"}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=\"Retrieve existing quotes.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_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/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List quotes - Hyperline\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve existing quotes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperline\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://app.hyperline.co/auth/background.svg\">\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=\"List quotes - Hyperline\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve existing quotes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://app.hyperline.co/auth/background.svg\">\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/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/quotes/list-quotes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperline.co/#organization\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperline.co#website\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes#webpage\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes\",\"name\":\"List quotes\",\"description\":\"Retrieve existing quotes.\",\"dateModified\":\"2026-03-05T16:12:48.615Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Quotes\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/get-quote\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List quotes\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes#apireference\",\"headline\":\"List quotes\",\"name\":\"List quotes\",\"description\":\"Retrieve existing quotes.\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/quotes/list-quotes#webpage\"},\"image\":\"https://app.hyperline.co/auth/background.svg\",\"dateModified\":\"2026-03-05T16:12:48.615Z\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperline\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperline\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/quotes/list-quotes.md","siteName":"Hyperline","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs"}]},{"tab":"Developers","icon":"code","groups":[{"group":"Technical documentation","pages":[{"title":"Hyperline for developers","sidebarTitle":"Getting started","mode":"wide","href":"/developers/getting-started"},{"title":"Authentication","href":"/developers/authentication"}]},{"group":"API fundamentals","pages":[{"title":"Pagination and filtering","href":"/developers/pagination"},{"title":"Error handling","href":"/developers/error-handling"},{"title":"Rate limiting","href":"/developers/rate-limiting"},{"title":"Idempotent requests","href":"/developers/idempotent-requests"},{"title":"Currency amounts","href":"/developers/amount"},{"title":"Dates \u0026 timezones","href":"/developers/dates-and-timezones"},{"title":"API upgrades","href":"/developers/upgrades"}]},{"group":"AI / LLMs","pages":[{"title":"Build with LLMs","href":"/developers/ai/overview"},{"title":"Hyperline MCP","sidebarTitle":"MCP server","href":"/developers/ai/mcp"},{"title":"Hyperline CLI","sidebarTitle":"CLI","href":"/developers/ai/cli"}]},{"group":"Integrations","pages":[{"title":"React components","href":"/developers/react-components"},{"title":"Third-party app","href":"/developers/third-party-app"},{"title":"Webhooks","href":"/developers/webhooks"}]},{"group":"AI > Billing","pages":[{"openapi":"get /v1/ai/billing/plans/default","title":"Get default billing plan","href":"/api-reference/endpoints/ai->-billing/get-default-billing-plan"},{"openapi":"get /v1/ai/billing/plans/{id}","title":"Get billing plan","href":"/api-reference/endpoints/ai->-billing/get-billing-plan"},{"openapi":"get /v1/ai/billing/rate-cards/{id}","title":"Get rate card","href":"/api-reference/endpoints/ai->-billing/get-rate-card"},{"openapi":"get /v1/ai/billing/customers/{id}/policies/default","title":"Get default billing policy","href":"/api-reference/endpoints/ai->-billing/get-default-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Get billing policy","href":"/api-reference/endpoints/ai->-billing/get-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/balance","title":"Get billing balance","href":"/api-reference/endpoints/ai->-billing/get-billing-balance"},{"openapi":"get /v1/ai/billing/products/{id}/rate-card","title":"Get product AI rate card","href":"/api-reference/endpoints/ai->-billing/get-product-ai-rate-card"},{"openapi":"get /v1/ai/billing/plans","title":"List billing plans","href":"/api-reference/endpoints/ai->-billing/list-billing-plans"},{"openapi":"get /v1/ai/billing/rate-cards","title":"List rate cards","href":"/api-reference/endpoints/ai->-billing/list-rate-cards"},{"openapi":"get /v1/ai/billing/customers/{id}/policies","title":"List billing policies","href":"/api-reference/endpoints/ai->-billing/list-billing-policies"},{"openapi":"get /v1/ai/billing/customers/{id}/consumption","title":"List consumption","href":"/api-reference/endpoints/ai->-billing/list-consumption"},{"openapi":"post /v1/ai/billing/plans","title":"Create billing plan","href":"/api-reference/endpoints/ai->-billing/create-billing-plan"},{"openapi":"post /v1/ai/billing/rate-cards","title":"Create rate card","href":"/api-reference/endpoints/ai->-billing/create-rate-card"},{"openapi":"post /v1/ai/billing/customers/{id}/apply-default-plan","title":"Apply default billing plan","href":"/api-reference/endpoints/ai->-billing/apply-default-billing-plan"},{"openapi":"delete /v1/ai/billing/plans/default","title":"Clear default billing plan","href":"/api-reference/endpoints/ai->-billing/clear-default-billing-plan"},{"openapi":"delete /v1/ai/billing/products/{id}/rate-card","title":"Clear product AI rate card","href":"/api-reference/endpoints/ai->-billing/clear-product-ai-rate-card"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Configure billing policy","href":"/api-reference/endpoints/ai->-billing/configure-billing-policy"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/default","title":"Configure default billing policy","href":"/api-reference/endpoints/ai->-billing/configure-default-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Remove billing policy","href":"/api-reference/endpoints/ai->-billing/remove-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/default","title":"Remove default billing policy","href":"/api-reference/endpoints/ai->-billing/remove-default-billing-policy"},{"openapi":"put /v1/ai/billing/plans/{id}","title":"Replace billing plan","href":"/api-reference/endpoints/ai->-billing/replace-billing-plan"},{"openapi":"put /v1/ai/billing/rate-cards/{id}","title":"Replace rate card","href":"/api-reference/endpoints/ai->-billing/replace-rate-card"},{"openapi":"post /v1/ai/billing/customers/{id}/windows/reset","title":"Reset allowance windows","href":"/api-reference/endpoints/ai->-billing/reset-allowance-windows"},{"openapi":"put /v1/ai/billing/plans/default","title":"Set default billing plan","href":"/api-reference/endpoints/ai->-billing/set-default-billing-plan"},{"openapi":"put /v1/ai/billing/products/{id}/rate-card","title":"Set product AI rate card","href":"/api-reference/endpoints/ai->-billing/set-product-ai-rate-card"},{"openapi":"delete /v1/ai/billing/plans/{id}","title":"Delete billing plan","href":"/api-reference/endpoints/ai->-billing/delete-billing-plan"},{"openapi":"delete /v1/ai/billing/rate-cards/{id}","title":"Delete rate card","href":"/api-reference/endpoints/ai->-billing/delete-rate-card"}]},{"group":"AI > Costs","pages":[{"openapi":"get /v1/ai/billing/costs","title":"List cost catalog","href":"/api-reference/endpoints/ai->-costs/list-cost-catalog"},{"openapi":"post /v1/ai/billing/costs/items","title":"Create custom cost item","href":"/api-reference/endpoints/ai->-costs/create-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/items/{id}","title":"Remove custom cost item","href":"/api-reference/endpoints/ai->-costs/remove-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/overrides/{id}","title":"Remove provider cost override","href":"/api-reference/endpoints/ai->-costs/remove-provider-cost-override"},{"openapi":"put /v1/ai/billing/costs/items/{id}","title":"Replace custom cost item","href":"/api-reference/endpoints/ai->-costs/replace-custom-cost-item"},{"openapi":"put /v1/ai/billing/costs/overrides","title":"Set provider cost override","href":"/api-reference/endpoints/ai->-costs/set-provider-cost-override"}]},{"group":"AI > Ingest","pages":[{"openapi":"get /v1/ai/billing/snapshot","title":"Get AI billing snapshot","href":"/api-reference/endpoints/ai->-ingest/get-ai-billing-snapshot"},{"openapi":"post /v1/ai/billing/check","title":"Check AI spend allowance","href":"/api-reference/endpoints/ai->-ingest/check-ai-spend-allowance"},{"openapi":"post /v1/ai/billing/consume","title":"Consume AI usage","href":"/api-reference/endpoints/ai->-ingest/consume-ai-usage"},{"openapi":"post /v1/ai/calls","title":"Ingest AI calls","href":"/api-reference/endpoints/ai->-ingest/ingest-ai-calls"}]},{"group":"AI > Monitoring","pages":[{"openapi":"get /v1/agents/monitoring/analyses/{id}","title":"Get monitoring analysis","href":"/api-reference/endpoints/ai->-monitoring/get-monitoring-analysis"},{"openapi":"get /v1/agents/monitoring/analyses","title":"List monitoring analyses","href":"/api-reference/endpoints/ai->-monitoring/list-monitoring-analyses"}]},{"group":"Accounting > Accounts","pages":[{"openapi":"get /v1/accounting/accounts/{id}","title":"Get ledger account","href":"/api-reference/endpoints/accounting->-accounts/get-ledger-account"},{"openapi":"get /v1/accounting/accounts","title":"List ledger accounts","href":"/api-reference/endpoints/accounting->-accounts/list-ledger-accounts"},{"openapi":"get /v1/accounting/primary-ledger/accounts","title":"List primary accounts","href":"/api-reference/endpoints/accounting->-accounts/list-primary-accounts"},{"openapi":"post /v1/accounting/accounts","title":"Create ledger account","href":"/api-reference/endpoints/accounting->-accounts/create-ledger-account"},{"openapi":"put /v1/accounting/accounts/{id}","title":"Update ledger account","href":"/api-reference/endpoints/accounting->-accounts/update-ledger-account"},{"openapi":"delete /v1/accounting/accounts/{id}","title":"Delete ledger account","href":"/api-reference/endpoints/accounting->-accounts/delete-ledger-account"}]},{"group":"Accounting > Journal entries","pages":[{"openapi":"get /v1/accounting/journal-entries/{id}","title":"Get journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/get-journal-entry"},{"openapi":"get /v1/accounting/journal-entries","title":"List journal entries","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entries"},{"openapi":"get /v1/accounting/journal-entry-lines","title":"List journal entry lines","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entry-lines"},{"openapi":"post /v1/accounting/journal-entries","title":"Create journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/create-journal-entry"},{"openapi":"post /v1/accounting/journal-entries/recognition-preview","title":"Preview recognition schedule","href":"/api-reference/endpoints/accounting->-journal-entries/preview-recognition-schedule"}]},{"group":"Accounting > Ledgers","pages":[{"openapi":"get /v1/accounting/ledgers/{id}","title":"Get ledger","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger"},{"openapi":"get /v1/accounting/ledgers/{id}/close","title":"Get ledger close state","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger-close-state"},{"openapi":"get /v1/accounting/ledgers","title":"List ledgers","href":"/api-reference/endpoints/accounting->-ledgers/list-ledgers"},{"openapi":"get /v1/accounting/ledgers/{id}/close-events","title":"List ledger close events","href":"/api-reference/endpoints/accounting->-ledgers/list-ledger-close-events"},{"openapi":"post /v1/accounting/ledgers","title":"Create ledger","href":"/api-reference/endpoints/accounting->-ledgers/create-ledger"},{"openapi":"put /v1/accounting/ledgers/{id}","title":"Update ledger","href":"/api-reference/endpoints/accounting->-ledgers/update-ledger"},{"openapi":"post /v1/accounting/ledgers/{id}/close","title":"Close ledger period","href":"/api-reference/endpoints/accounting->-ledgers/close-ledger-period"},{"openapi":"post /v1/accounting/ledgers/{id}/reopen","title":"Reopen ledger period","href":"/api-reference/endpoints/accounting->-ledgers/reopen-ledger-period"},{"openapi":"delete /v1/accounting/ledgers/{id}","title":"Delete ledger","href":"/api-reference/endpoints/accounting->-ledgers/delete-ledger"}]},{"group":"Accounting > Reports","pages":[{"openapi":"post /v1/accounting/general-ledger/export","title":"Export general ledger","href":"/api-reference/endpoints/accounting->-reports/export-general-ledger"},{"openapi":"post /v1/accounting/income-statement/export","title":"Export income statement","href":"/api-reference/endpoints/accounting->-reports/export-income-statement"}]},{"group":"Accounting > Revenue recognition","pages":[{"openapi":"get /v1/accounting/revrec/waterfall","title":"Get revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall"},{"openapi":"get /v1/accounting/revrec/waterfall/cell","title":"Get revenue recognition waterfall cell","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall-cell"},{"openapi":"get /v1/accounting/revrec/unbilled","title":"Get unbilled revenue","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-unbilled-revenue"},{"openapi":"get /v1/accounting/revrec/schedules/{id}","title":"Get revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-schedule"},{"openapi":"get /v1/accounting/revrec/slices/{id}","title":"Get revenue recognition slice","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-slice"},{"openapi":"get /v1/accounting/revrec/schedules","title":"List revenue recognition schedules","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-schedules"},{"openapi":"get /v1/accounting/revrec/schedules/{schedule_id}/adjustments","title":"List revenue recognition adjustments","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-adjustments"},{"openapi":"post /v1/accounting/revrec/recognized-summary/export","title":"Export recognized revenue summary","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-recognized-revenue-summary"},{"openapi":"post /v1/accounting/revrec/waterfall/export","title":"Export revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-revenue-recognition-waterfall"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape/preview","title":"Preview revenue recognition reshape","href":"/api-reference/endpoints/accounting->-revenue-recognition/preview-revenue-recognition-reshape"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape","title":"Reshape revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/reshape-revenue-recognition-schedule"}]},{"group":"Accounting > Rules","pages":[{"openapi":"get /v1/accounting/rules/tree","title":"Get accounting rule tree","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree"},{"openapi":"post /v1/accounting/rules/defaults","title":"Get rule defaults","href":"/api-reference/endpoints/accounting->-rules/get-rule-defaults"},{"openapi":"get /v1/accounting/rules/{id}","title":"Get accounting rule","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule"},{"openapi":"get /v1/accounting/rules","title":"List accounting rules","href":"/api-reference/endpoints/accounting->-rules/list-accounting-rules"},{"openapi":"post /v1/accounting/rules","title":"Create accounting rule","href":"/api-reference/endpoints/accounting->-rules/create-accounting-rule"},{"openapi":"put /v1/accounting/rules/{id}","title":"Update accounting rule","href":"/api-reference/endpoints/accounting->-rules/update-accounting-rule"},{"openapi":"post /v1/accounting/rules/resolve","title":"Resolve accounting rule","href":"/api-reference/endpoints/accounting->-rules/resolve-accounting-rule"},{"openapi":"delete /v1/accounting/rules/{id}","title":"Delete accounting rule","href":"/api-reference/endpoints/accounting->-rules/delete-accounting-rule"}]},{"group":"Aggregators","pages":[{"openapi":"get /v1/aggregators/{id}","title":"Get aggregator","href":"/api-reference/endpoints/aggregators/get-aggregator"},{"openapi":"get /v1/aggregators","title":"List aggregators","href":"/api-reference/endpoints/aggregators/list-aggregators"},{"openapi":"post /v1/aggregators","title":"Create aggregator","href":"/api-reference/endpoints/aggregators/create-aggregator"},{"openapi":"put /v1/aggregators/{id}","title":"Update aggregator","href":"/api-reference/endpoints/aggregators/update-aggregator"},{"openapi":"delete /v1/aggregators/{id}","title":"Delete aggregator","href":"/api-reference/endpoints/aggregators/delete-aggregator"}]},{"group":"Aggregators > Usage","pages":[{"openapi":"get /v1/aggregators/{id}/usage","title":"Get aggregator usage","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage"},{"openapi":"get /v1/aggregators/{id}/usage/timeseries","title":"Get aggregator usage timeseries","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-timeseries"},{"openapi":"get /v1/aggregators/{id}/usage/group-by-customer","title":"Get aggregator usage grouped by customer","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-grouped-by-customer"},{"openapi":"get /v1/aggregators/{id}/usage/events","title":"Get aggregator usage events","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-events"}]},{"group":"Analytics","pages":[{"openapi":"get /v1/analytics","title":"Get analytics","href":"/api-reference/endpoints/analytics/get-analytics"}]},{"group":"Approval > Requests","pages":[{"openapi":"get /v1/approvals/requests/{id}","title":"Get approval request","href":"/api-reference/endpoints/approval->-requests/get-approval-request"},{"openapi":"post /v1/approvals/requests/{id}/approve","title":"Approve request","href":"/api-reference/endpoints/approval->-requests/approve-request"},{"openapi":"post /v1/approvals/requests/{id}/reject","title":"Reject request","href":"/api-reference/endpoints/approval->-requests/reject-request"}]},{"group":"Approval > Workflows","pages":[{"openapi":"get /v1/approvals/workflows/{id}","title":"Get approval workflow","href":"/api-reference/endpoints/approval->-workflows/get-approval-workflow"},{"openapi":"get /v1/approvals/workflows","title":"List approval workflows","href":"/api-reference/endpoints/approval->-workflows/list-approval-workflows"},{"openapi":"post /v1/approvals/workflows","title":"Create approval workflow","href":"/api-reference/endpoints/approval->-workflows/create-approval-workflow"},{"openapi":"put /v1/approvals/workflows/{id}","title":"Update approval workflow","href":"/api-reference/endpoints/approval->-workflows/update-approval-workflow"},{"openapi":"delete /v1/approvals/workflows/{id}","title":"Delete approval workflow","href":"/api-reference/endpoints/approval->-workflows/delete-approval-workflow"}]},{"group":"Audit logs","pages":[{"openapi":"get /v1/audit-logs","title":"List audit logs","href":"/api-reference/endpoints/audit-logs/list-audit-logs"}]},{"group":"Bank Accounts","pages":[{"openapi":"get /v1/bank-accounts/{id}","title":"Get bank account","href":"/api-reference/endpoints/bank-accounts/get-bank-account"},{"openapi":"get /v1/bank-accounts","title":"List bank accounts","href":"/api-reference/endpoints/bank-accounts/list-bank-accounts"},{"openapi":"get /v1/bank-accounts/{id}/transactions","title":"List bank transactions","href":"/api-reference/endpoints/bank-accounts/list-bank-transactions"}]},{"group":"Billable events","pages":[{"openapi":"get /v1/events","title":"Get events","href":"/api-reference/endpoints/billable-events/get-events"},{"openapi":"post /v1/events","title":"Ingest billable event","href":"/api-reference/endpoints/billable-events/ingest-billable-event"},{"openapi":"post /v1/events/batch","title":"Ingest billable events","href":"/api-reference/endpoints/billable-events/ingest-billable-events"},{"openapi":"delete /v1/events","title":"Delete billable events","href":"/api-reference/endpoints/billable-events/delete-billable-events"}]},{"group":"Catalog","pages":[{"openapi":"get /v1/catalog/versions/draft","title":"Get catalog draft","href":"/api-reference/endpoints/catalog/get-catalog-draft"},{"openapi":"get /v1/catalog/versions/{id}","title":"Get catalog version","href":"/api-reference/endpoints/catalog/get-catalog-version"},{"openapi":"get /v1/catalog/versions","title":"List catalog versions","href":"/api-reference/endpoints/catalog/list-catalog-versions"},{"openapi":"post /v1/catalog/versions/draft","title":"Create catalog draft","href":"/api-reference/endpoints/catalog/create-catalog-draft"},{"openapi":"delete /v1/catalog/versions/draft","title":"Discard catalog draft","href":"/api-reference/endpoints/catalog/discard-catalog-draft"},{"openapi":"get /v1/catalog/export","title":"Export catalog","href":"/api-reference/endpoints/catalog/export-catalog"},{"openapi":"post /v1/catalog/versions/draft/publish","title":"Publish catalog draft","href":"/api-reference/endpoints/catalog/publish-catalog-draft"},{"openapi":"post /v1/catalog/versions/{id}/revert","title":"Revert catalog version","href":"/api-reference/endpoints/catalog/revert-catalog-version"}]},{"group":"Companies","pages":[{"openapi":"get /v1/companies","title":"List companies","href":"/api-reference/endpoints/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create company","href":"/api-reference/endpoints/companies/create-company"}]},{"group":"Contracts > Clauses","pages":[{"openapi":"get /v1/contracts/clauses/{id}","title":"Get contract clause","href":"/api-reference/endpoints/contracts->-clauses/get-contract-clause"},{"openapi":"get /v1/contracts/clauses","title":"List contract clauses","href":"/api-reference/endpoints/contracts->-clauses/list-contract-clauses"},{"openapi":"post /v1/contracts/clauses","title":"Create contract clause","href":"/api-reference/endpoints/contracts->-clauses/create-contract-clause"},{"openapi":"put /v1/contracts/clauses/{id}","title":"Update contract clause","href":"/api-reference/endpoints/contracts->-clauses/update-contract-clause"},{"openapi":"delete /v1/contracts/clauses/{id}","title":"Delete contract clause","href":"/api-reference/endpoints/contracts->-clauses/delete-contract-clause"}]},{"group":"Contracts > Documents","pages":[{"openapi":"get /v1/contracts/documents/{id}","title":"Get contract document","href":"/api-reference/endpoints/contracts->-documents/get-contract-document"},{"openapi":"get /v1/contracts/documents","title":"List contract documents","href":"/api-reference/endpoints/contracts->-documents/list-contract-documents"},{"openapi":"post /v1/contracts/documents","title":"Create contract document","href":"/api-reference/endpoints/contracts->-documents/create-contract-document"},{"openapi":"post /v1/contracts/documents/{id}/contents","title":"Create contract document content","href":"/api-reference/endpoints/contracts->-documents/create-contract-document-content"},{"openapi":"put /v1/contracts/documents/{id}","title":"Update contract document","href":"/api-reference/endpoints/contracts->-documents/update-contract-document"},{"openapi":"put /v1/contracts/documents/{id}/contents/{contentId}","title":"Update contract document content","href":"/api-reference/endpoints/contracts->-documents/update-contract-document-content"},{"openapi":"delete /v1/contracts/documents/{id}","title":"Delete contract document","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document"},{"openapi":"delete /v1/contracts/documents/{id}/contents/{contentId}","title":"Delete contract document content","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document-content"}]},{"group":"Coupons","pages":[{"openapi":"get /v1/coupons/{id}","title":"Get coupon","href":"/api-reference/endpoints/coupons/get-coupon"},{"openapi":"get /v1/coupons","title":"List coupons","href":"/api-reference/endpoints/coupons/list-coupons"},{"openapi":"post /v1/coupons","title":"Create coupon","href":"/api-reference/endpoints/coupons/create-coupon"},{"openapi":"put /v1/coupons/{id}","title":"Update coupon","href":"/api-reference/endpoints/coupons/update-coupon"},{"openapi":"delete /v1/coupons/{id}","title":"Delete coupon","href":"/api-reference/endpoints/coupons/delete-coupon"}]},{"group":"Coupons > Promotion codes","pages":[{"openapi":"get /v1/promotion-codes/{id}","title":"Get promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/get-promotion-code"},{"openapi":"get /v1/promotion-codes","title":"List promotion codes","href":"/api-reference/endpoints/coupons->-promotion-codes/list-promotion-codes"},{"openapi":"post /v1/promotion-codes","title":"Create promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/create-promotion-code"},{"openapi":"patch /v1/promotion-codes/{id}","title":"Update promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/update-promotion-code"},{"openapi":"delete /v1/promotion-codes/{id}","title":"Delete promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/delete-promotion-code"}]},{"group":"Custom properties","pages":[{"openapi":"get /v1/custom-properties","title":"List custom properties","href":"/api-reference/endpoints/custom-properties/list-custom-properties"},{"openapi":"post /v1/custom-properties","title":"Create custom property","href":"/api-reference/endpoints/custom-properties/create-custom-property"},{"openapi":"put /v1/custom-properties/{id}","title":"Update custom property","href":"/api-reference/endpoints/custom-properties/update-custom-property"},{"openapi":"delete /v1/custom-properties/{id}","title":"Delete custom property","href":"/api-reference/endpoints/custom-properties/delete-custom-property"}]},{"group":"Customers","pages":[{"openapi":"get /v2/customers/{id}","title":"Get customer","href":"/api-reference/endpoints/customers/get-customer"},{"openapi":"get /v1/customers/{id}/portal","title":"Get customer portal","href":"/api-reference/endpoints/customers/get-customer-portal"},{"openapi":"get /v1/customers/{id}/taxes/rates","title":"Get customer tax rates","href":"/api-reference/endpoints/customers/get-customer-tax-rates"},{"openapi":"get /v1/customers/{id}/arr-history","title":"Get customer ARR history","href":"/api-reference/endpoints/customers/get-customer-arr-history"},{"openapi":"get /v1/customers/{id}/valuation","title":"Get customer valuation","href":"/api-reference/endpoints/customers/get-customer-valuation"},{"openapi":"get /v2/customers","title":"List customers","href":"/api-reference/endpoints/customers/list-customers"},{"openapi":"post /v1/customers","title":"Create customer","href":"/api-reference/endpoints/customers/create-customer"},{"openapi":"post /v1/customers/batch","title":"Create customers batch","href":"/api-reference/endpoints/customers/create-customers-batch"},{"openapi":"put /v1/customers/{id}","title":"Update customer","href":"/api-reference/endpoints/customers/update-customer"},{"openapi":"put /v1/customers/{id}/archive","title":"Archive customer","href":"/api-reference/endpoints/customers/archive-customer"},{"openapi":"post /v1/customers/providers-bulk-update","title":"Bulk update providers/customers mapping","href":"/api-reference/endpoints/customers/bulk-update-providerscustomers-mapping"},{"openapi":"put /v1/customers/{id}/unarchive","title":"Unarchive customer","href":"/api-reference/endpoints/customers/unarchive-customer"},{"openapi":"delete /v1/customers/{id}","title":"Delete customer","href":"/api-reference/endpoints/customers/delete-customer"}]},{"group":"Customers > Address","pages":[{"openapi":"get /v1/customers/{customerId}/addresses","title":"List addresses","href":"/api-reference/endpoints/customers->-address/list-addresses"},{"openapi":"post /v1/customers/{customerId}/addresses","title":"Create address","href":"/api-reference/endpoints/customers->-address/create-address"},{"openapi":"patch /v1/customers/{customerId}/addresses/{addressId}","title":"Update address","href":"/api-reference/endpoints/customers->-address/update-address"},{"openapi":"delete /v1/customers/{customerId}/addresses/{addressId}","title":"Delete address","href":"/api-reference/endpoints/customers->-address/delete-address"}]},{"group":"Customers > Credits","pages":[{"openapi":"get /v1/customers/{id}/credits/{productId}","title":"Get credit product","href":"/api-reference/endpoints/customers->-credits/get-credit-product"},{"openapi":"get /v1/customers/{id}/credits/{productId}/portal-settings","title":"Get credit portal settings","href":"/api-reference/endpoints/customers->-credits/get-credit-portal-settings"},{"openapi":"get /v1/customers/credits","title":"List all credit products","href":"/api-reference/endpoints/customers->-credits/list-all-credit-products"},{"openapi":"get /v1/customers/{id}/credits","title":"List credit products","href":"/api-reference/endpoints/customers->-credits/list-credit-products"},{"openapi":"get /v1/customers/{id}/credits/{productId}/transactions","title":"List credit transactions","href":"/api-reference/endpoints/customers->-credits/list-credit-transactions"},{"openapi":"post /v1/customers/{id}/credits","title":"Create credit product","href":"/api-reference/endpoints/customers->-credits/create-credit-product"},{"openapi":"post /v1/customers/{id}/credits/{productId}/usage","title":"Create credits usage","href":"/api-reference/endpoints/customers->-credits/create-credits-usage"},{"openapi":"put /v1/customers/{id}/credits/{productId}","title":"Update credit product","href":"/api-reference/endpoints/customers->-credits/update-credit-product"},{"openapi":"patch /v1/customers/{id}/credits/{productId}/transactions/{transactionId}","title":"Update credit topup expiration","href":"/api-reference/endpoints/customers->-credits/update-credit-topup-expiration"},{"openapi":"put /v1/customers/{id}/credits/{productId}/portal-settings","title":"Update credit portal settings","href":"/api-reference/endpoints/customers->-credits/update-credit-portal-settings"},{"openapi":"post /v1/customers/{id}/credits/{productId}/purchase","title":"Purchase credits","href":"/api-reference/endpoints/customers->-credits/purchase-credits"},{"openapi":"post /v1/customers/{id}/credits/{productId}/topup","title":"Topup credits","href":"/api-reference/endpoints/customers->-credits/topup-credits"}]},{"group":"Customers > Features","pages":[{"openapi":"get /v1/customers/{id}/features","title":"Resolve customer features","href":"/api-reference/endpoints/customers->-features/resolve-customer-features"},{"openapi":"put /v1/customers/{id}/features/{code}","title":"Set customer feature","href":"/api-reference/endpoints/customers->-features/set-customer-feature"},{"openapi":"delete /v1/customers/{id}/features/{code}","title":"Delete customer feature","href":"/api-reference/endpoints/customers->-features/delete-customer-feature"}]},{"group":"Customers > Payment methods","pages":[{"openapi":"get /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Get payment method","href":"/api-reference/endpoints/customers->-payment-methods/get-payment-method"},{"openapi":"get /v1/customers/{id}/payment-methods","title":"List payment methods","href":"/api-reference/endpoints/customers->-payment-methods/list-payment-methods"},{"openapi":"post /v1/customers/{id}/payment-methods","title":"Create payment method","href":"/api-reference/endpoints/customers->-payment-methods/create-payment-method"},{"openapi":"delete /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Delete payment method","href":"/api-reference/endpoints/customers->-payment-methods/delete-payment-method"}]},{"group":"Customers > Segments","pages":[{"openapi":"get /v1/customers/segments/{id}","title":"Get segment","href":"/api-reference/endpoints/customers->-segments/get-segment"},{"openapi":"get /v1/customers/segments","title":"List segments","href":"/api-reference/endpoints/customers->-segments/list-segments"},{"openapi":"post /v1/customers/segments","title":"Create segment","href":"/api-reference/endpoints/customers->-segments/create-segment"},{"openapi":"patch /v1/customers/segments/{id}","title":"Update segment","href":"/api-reference/endpoints/customers->-segments/update-segment"},{"openapi":"delete /v1/customers/segments/{id}","title":"Delete segment","href":"/api-reference/endpoints/customers->-segments/delete-segment"}]},{"group":"Customers > Shipping","pages":[{"openapi":"get /v1/customers/{customerId}/shipping","title":"Get shipping destination","href":"/api-reference/endpoints/customers->-shipping/get-shipping-destination"},{"openapi":"put /v1/customers/{customerId}/shipping","title":"Set shipping destination","href":"/api-reference/endpoints/customers->-shipping/set-shipping-destination"}]},{"group":"Customers > Usage","pages":[{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}","title":"Get customer usage for an aggregator","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-for-an-aggregator"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/timeseries","title":"Get customer usage timeseries","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-timeseries"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/events","title":"Get customer usage events","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-events"},{"openapi":"get /v1/customers/{id}/usage","title":"List customer usage","href":"/api-reference/endpoints/customers->-usage/list-customer-usage"}]},{"group":"Exports","pages":[{"openapi":"get /v1/exports/{exportId}","title":"Get export","href":"/api-reference/endpoints/exports/get-export"},{"openapi":"get /v1/exports","title":"List exports","href":"/api-reference/endpoints/exports/list-exports"},{"openapi":"get /v2/exports/{exportId}/download","title":"Download export","href":"/api-reference/endpoints/exports/download-export"},{"openapi":"post /v1/exports","title":"Create export","href":"/api-reference/endpoints/exports/create-export"}]},{"group":"Features","pages":[{"openapi":"get /v1/features/{code}","title":"Get feature","href":"/api-reference/endpoints/features/get-feature"},{"openapi":"get /v1/features","title":"List features","href":"/api-reference/endpoints/features/list-features"},{"openapi":"post /v1/features","title":"Create feature","href":"/api-reference/endpoints/features/create-feature"},{"openapi":"put /v1/features/{code}","title":"Update feature","href":"/api-reference/endpoints/features/update-feature"},{"openapi":"put /v1/features/{code}/archive","title":"Archive feature","href":"/api-reference/endpoints/features/archive-feature"},{"openapi":"put /v1/features/{code}/unarchive","title":"Unarchive feature","href":"/api-reference/endpoints/features/unarchive-feature"},{"openapi":"delete /v1/features/{code}","title":"Delete feature","href":"/api-reference/endpoints/features/delete-feature"}]},{"group":"Files","pages":[{"openapi":"get /v1/files","title":"List files","href":"/api-reference/endpoints/files/list-files"},{"openapi":"get /v1/files/{id}/download","title":"Download file","href":"/api-reference/endpoints/files/download-file"},{"openapi":"post /v1/files","title":"Create file","href":"/api-reference/endpoints/files/create-file"},{"openapi":"delete /v1/files/{id}","title":"Delete file","href":"/api-reference/endpoints/files/delete-file"}]},{"group":"Integrations","pages":[{"openapi":"post /v1/integrations/components/token","title":"Create component token","href":"/api-reference/endpoints/integrations/create-component-token"}]},{"group":"Invoices","pages":[{"openapi":"get /v2/invoices/{id}","title":"Get invoice","href":"/api-reference/endpoints/invoices/get-invoice"},{"openapi":"get /v2/invoices","title":"List invoices","href":"/api-reference/endpoints/invoices/list-invoices"},{"openapi":"get /v2/invoices/{id}/download","title":"Download invoice","href":"/api-reference/endpoints/invoices/download-invoice"},{"openapi":"post /v1/invoices","title":"Create invoice","href":"/api-reference/endpoints/invoices/create-invoice"},{"openapi":"post /v1/invoices/{id}/credit-notes","title":"Create credit note","href":"/api-reference/endpoints/invoices/create-credit-note"},{"openapi":"post /v2/invoices/batch","title":"Create invoices","href":"/api-reference/endpoints/invoices/create-invoices"},{"openapi":"put /v1/invoices/{id}/allocations","title":"Update credit note allocations","href":"/api-reference/endpoints/invoices/update-credit-note-allocations"},{"openapi":"patch /v1/invoices/{id}","title":"Update invoice","href":"/api-reference/endpoints/invoices/update-invoice"},{"openapi":"post /v1/invoices/{id}/charge","title":"Charge invoice","href":"/api-reference/endpoints/invoices/charge-invoice"},{"openapi":"post /v1/invoices/{id}/uncollectible","title":"Mark as uncollectible","href":"/api-reference/endpoints/invoices/mark-as-uncollectible"},{"openapi":"post /v1/invoices/send-email","title":"Send invoice emails","href":"/api-reference/endpoints/invoices/send-invoice-emails"},{"openapi":"post /v1/invoices/{id}/upload","title":"Upload PDF to invoice","href":"/api-reference/endpoints/invoices/upload-pdf-to-invoice"},{"openapi":"post /v1/invoices/{id}/validate","title":"Validate draft invoice","href":"/api-reference/endpoints/invoices/validate-draft-invoice"},{"openapi":"post /v1/invoices/{id}/void","title":"Void invoice","href":"/api-reference/endpoints/invoices/void-invoice"},{"openapi":"delete /v1/invoices/{id}","title":"Delete invoice","href":"/api-reference/endpoints/invoices/delete-invoice"}]},{"group":"Invoices > Events","pages":[{"openapi":"get /v1/invoices/{id}/events","title":"List invoice events","href":"/api-reference/endpoints/invoices->-events/list-invoice-events"}]},{"group":"Invoices > Transactions","pages":[{"openapi":"post /v1/invoices/{id}/transactions","title":"Create transaction","href":"/api-reference/endpoints/invoices->-transactions/create-transaction"},{"openapi":"delete /v1/invoices/{id}/transactions/{transactionId}","title":"Delete transaction","href":"/api-reference/endpoints/invoices->-transactions/delete-transaction"}]},{"group":"Invoicing entities","pages":[{"openapi":"get /v1/invoicing-entities/{id}","title":"Get invoicing entity","href":"/api-reference/endpoints/invoicing-entities/get-invoicing-entity"},{"openapi":"get /v1/invoicing-entities","title":"List invoicing entities","href":"/api-reference/endpoints/invoicing-entities/list-invoicing-entities"},{"openapi":"post /v1/invoicing-entities","title":"Create invoicing entity","href":"/api-reference/endpoints/invoicing-entities/create-invoicing-entity"},{"openapi":"put /v1/invoicing-entities/{id}","title":"Update invoicing entity","href":"/api-reference/endpoints/invoicing-entities/update-invoicing-entity"},{"openapi":"delete /v1/invoicing-entities/{id}","title":"Delete invoicing entity","href":"/api-reference/endpoints/invoicing-entities/delete-invoicing-entity"}]},{"group":"OAuth2","pages":[{"openapi":"get /oauth/userinfo","title":"Get user info","href":"/api-reference/endpoints/oauth2/get-user-info"},{"openapi":"get /oauth/authorize","title":"Authorize","href":"/api-reference/endpoints/oauth2/authorize"},{"openapi":"post /oauth/tokens","title":"Generate tokens","href":"/api-reference/endpoints/oauth2/generate-tokens"},{"openapi":"get /oauth/callback","title":"OAuth callback","href":"/api-reference/endpoints/oauth2/oauth-callback"},{"openapi":"post /oauth/register","title":"Register OAuth client","href":"/api-reference/endpoints/oauth2/register-oauth-client"},{"openapi":"post /oauth/revoke","title":"Revoke token","href":"/api-reference/endpoints/oauth2/revoke-token"}]},{"group":"Organisations","pages":[{"openapi":"get /v1/organisations/{id}","title":"Get organisation","href":"/api-reference/endpoints/organisations/get-organisation"},{"openapi":"get /v1/organisations","title":"List organisations","href":"/api-reference/endpoints/organisations/list-organisations"},{"openapi":"patch /v1/organisations/{id}","title":"Patch organisation","href":"/api-reference/endpoints/organisations/patch-organisation"}]},{"group":"Payments","pages":[{"openapi":"post /v1/payments","title":"Create payment","href":"/api-reference/endpoints/payments/create-payment"}]},{"group":"Price books","pages":[{"openapi":"get /v1/price-books/{id}","title":"Get price book","href":"/api-reference/endpoints/price-books/get-price-book"},{"openapi":"get /v1/price-books","title":"List price books","href":"/api-reference/endpoints/price-books/list-price-books"},{"openapi":"post /v1/price-books","title":"Create price book","href":"/api-reference/endpoints/price-books/create-price-book"},{"openapi":"put /v1/price-books/{id}","title":"Update price book","href":"/api-reference/endpoints/price-books/update-price-book"},{"openapi":"post /v1/price-books/{id}/products","title":"Add products to price book","href":"/api-reference/endpoints/price-books/add-products-to-price-book"},{"openapi":"delete /v1/price-books/{id}/products/{productId}","title":"Remove product from price book","href":"/api-reference/endpoints/price-books/remove-product-from-price-book"},{"openapi":"delete /v1/price-books/{id}","title":"Delete price book","href":"/api-reference/endpoints/price-books/delete-price-book"}]},{"group":"Price configurations","pages":[{"openapi":"get /v1/price-configurations/{id}","title":"Get price configuration","href":"/api-reference/endpoints/price-configurations/get-price-configuration"},{"openapi":"get /v1/price-configurations","title":"List price configurations","href":"/api-reference/endpoints/price-configurations/list-price-configurations"},{"openapi":"post /v1/price-configurations","title":"Create price configuration","href":"/api-reference/endpoints/price-configurations/create-price-configuration"},{"openapi":"put /v1/price-configurations/{id}/prices","title":"Update prices","href":"/api-reference/endpoints/price-configurations/update-prices"},{"openapi":"delete /v1/price-configurations/{id}","title":"Delete price configuration","href":"/api-reference/endpoints/price-configurations/delete-price-configuration"}]},{"group":"Products","pages":[{"openapi":"get /v1/products/{id}","title":"Get product","href":"/api-reference/endpoints/products/get-product"},{"openapi":"get /v1/products","title":"List products","href":"/api-reference/endpoints/products/list-products"},{"openapi":"post /v1/products","title":"Create product","href":"/api-reference/endpoints/products/create-product"},{"openapi":"put /v1/products/{id}","title":"Update product","href":"/api-reference/endpoints/products/update-product"},{"openapi":"put /v1/products/{id}/archive","title":"Archive product","href":"/api-reference/endpoints/products/archive-product"},{"openapi":"put /v1/products/{id}/unarchive","title":"Unarchive product","href":"/api-reference/endpoints/products/unarchive-product"},{"openapi":"delete /v1/products/{id}","title":"Delete product","href":"/api-reference/endpoints/products/delete-product"}]},{"group":"Products > Features","pages":[{"openapi":"get /v1/products/{id}/features","title":"List product features","href":"/api-reference/endpoints/products->-features/list-product-features"},{"openapi":"put /v1/products/{id}/features/{code}","title":"Set product feature","href":"/api-reference/endpoints/products->-features/set-product-feature"},{"openapi":"delete /v1/products/{id}/features/{code}","title":"Delete product feature","href":"/api-reference/endpoints/products->-features/delete-product-feature"}]},{"group":"Quotes","pages":[{"openapi":"get /v1/quotes/{id}","title":"Get quote","href":"/api-reference/endpoints/quotes/get-quote"},{"openapi":"get /v1/quotes/{id}/valuation","title":"Get quote valuation","description":"Compute valuation metrics for an existing quote.","href":"/api-reference/endpoints/quotes/get-quote-valuation"},{"openapi":"get /v1/quotes","title":"List quotes","href":"/api-reference/endpoints/quotes/list-quotes"},{"openapi":"get /v1/quotes/{id}/signers","title":"List quote signers","description":"Retrieve the signature workflow of a quote, step by step, with the signature status of each signer.","href":"/api-reference/endpoints/quotes/list-quote-signers"},{"openapi":"get /v1/quotes/{id}/download","title":"Download quote","href":"/api-reference/endpoints/quotes/download-quote"},{"openapi":"get /v1/quotes/{quoteId}/files/{id}/download","title":"Download quote file","href":"/api-reference/endpoints/quotes/download-quote-file"},{"openapi":"post /v1/quotes","title":"Create quote","href":"/api-reference/endpoints/quotes/create-quote"},{"openapi":"patch /v1/quotes/{id}","title":"Update quote","href":"/api-reference/endpoints/quotes/update-quote"},{"openapi":"post /v1/quotes/{id}/duplicate","title":"Duplicate quote","href":"/api-reference/endpoints/quotes/duplicate-quote"},{"openapi":"post /v1/quotes/{id}/finalize","title":"Finalize quote","href":"/api-reference/endpoints/quotes/finalize-quote"},{"openapi":"post /v1/quotes/{id}/redraft","title":"Redraft quote","href":"/api-reference/endpoints/quotes/redraft-quote"},{"openapi":"post /v1/quotes/{id}/send","title":"Send quote","href":"/api-reference/endpoints/quotes/send-quote"},{"openapi":"put /v1/quotes/{id}/signers","title":"Set quote signers","href":"/api-reference/endpoints/quotes/set-quote-signers"},{"openapi":"post /v1/quotes/{id}/sign","title":"Sign quote","href":"/api-reference/endpoints/quotes/sign-quote"},{"openapi":"post /v1/quotes/{id}/void","title":"Void quote","href":"/api-reference/endpoints/quotes/void-quote"}]},{"group":"Quotes > Approvals","pages":[{"openapi":"get /v1/quotes/{id}/approvals","title":"Get quote approvals","href":"/api-reference/endpoints/quotes->-approvals/get-quote-approvals"},{"openapi":"post /v1/quotes/{id}/approve","title":"Approve quote","href":"/api-reference/endpoints/quotes->-approvals/approve-quote"}]},{"group":"Quotes > Templates","pages":[{"openapi":"get /v1/quotes/templates/{id}","title":"Get quote template","href":"/api-reference/endpoints/quotes->-templates/get-quote-template"},{"openapi":"get /v1/quotes/templates","title":"List quote templates","href":"/api-reference/endpoints/quotes->-templates/list-quote-templates"}]},{"group":"Subscriptions","pages":[{"openapi":"get /v2/subscriptions/{id}","title":"Get subscription","href":"/api-reference/endpoints/subscriptions/get-subscription"},{"openapi":"get /v1/subscriptions/{id}/arr-history","title":"Get subscription ARR history","href":"/api-reference/endpoints/subscriptions/get-subscription-arr-history"},{"openapi":"get /v1/subscriptions/{id}/valuation","title":"Get subscription valuation","href":"/api-reference/endpoints/subscriptions/get-subscription-valuation"},{"openapi":"get /v1/subscriptions/{id}/estimates","title":"List subscription estimates","href":"/api-reference/endpoints/subscriptions/list-subscription-estimates"},{"openapi":"get /v2/subscriptions","title":"List subscriptions","href":"/api-reference/endpoints/subscriptions/list-subscriptions"},{"openapi":"post /v1/subscriptions/{id}/update","title":"Create subscription update","href":"/api-reference/endpoints/subscriptions/create-subscription-update"},{"openapi":"post /v1/subscriptions/{id}/update-many","title":"Create subscription updates","href":"/api-reference/endpoints/subscriptions/create-subscription-updates"},{"openapi":"post /v2/subscriptions","title":"Create subscription","href":"/api-reference/endpoints/subscriptions/create-subscription"},{"openapi":"put /v2/subscriptions/{id}","title":"Update subscription","href":"/api-reference/endpoints/subscriptions/update-subscription"},{"openapi":"post /v1/subscriptions/{id}/activate","title":"Activate subscription","href":"/api-reference/endpoints/subscriptions/activate-subscription"},{"openapi":"post /v1/subscriptions/{id}/cancel","title":"Cancel subscription","href":"/api-reference/endpoints/subscriptions/cancel-subscription"},{"openapi":"post /v1/subscriptions/{id}/pause","title":"Pause subscription","href":"/api-reference/endpoints/subscriptions/pause-subscription"},{"openapi":"get /v1/subscriptions/{id}/preview-timeline","title":"Preview subscription timeline","href":"/api-reference/endpoints/subscriptions/preview-subscription-timeline"},{"openapi":"post /v1/subscriptions/{id}/reactivate","title":"Reactivate subscription","href":"/api-reference/endpoints/subscriptions/reactivate-subscription"},{"openapi":"post /v2/subscriptions/{id}/refresh-seat-products","title":"Refresh seat products","href":"/api-reference/endpoints/subscriptions/refresh-seat-products"},{"openapi":"post /v1/subscriptions/refresh","title":"Refresh subscriptions","href":"/api-reference/endpoints/subscriptions/refresh-subscriptions"},{"openapi":"post /v1/subscriptions/{id}/reinstate","title":"Reinstate subscription","href":"/api-reference/endpoints/subscriptions/reinstate-subscription"},{"openapi":"post /v1/subscriptions/{id}/renew","title":"Renew subscription","href":"/api-reference/endpoints/subscriptions/renew-subscription"},{"openapi":"post /v1/subscriptions/{id}/simulate-updates","title":"Simulate subscription updates","href":"/api-reference/endpoints/subscriptions/simulate-subscription-updates"}]},{"group":"Subscriptions > Phases","pages":[{"openapi":"get /v2/subscriptions/{id}/phases/{phaseId}","title":"Get subscription phase","href":"/api-reference/endpoints/subscriptions->-phases/get-subscription-phase"},{"openapi":"get /v2/subscriptions/{id}/phases","title":"List subscription phases","href":"/api-reference/endpoints/subscriptions->-phases/list-subscription-phases"},{"openapi":"post /v2/subscriptions/{id}/next-phase","title":"Transition subscription to next phase","href":"/api-reference/endpoints/subscriptions->-phases/transition-subscription-to-next-phase"}]},{"group":"Subscriptions > Templates","pages":[{"openapi":"get /v1/subscriptions/templates/{id}","title":"Get subscription template","href":"/api-reference/endpoints/subscriptions->-templates/get-subscription-template"},{"openapi":"get /v1/subscriptions/templates","title":"List subscription templates","href":"/api-reference/endpoints/subscriptions->-templates/list-subscription-templates"},{"openapi":"post /v1/subscriptions/templates","title":"Create subscription template","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template"},{"openapi":"post /v1/subscriptions/templates/{id}/configurations","title":"Create subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template-configuration"},{"openapi":"patch /v1/subscriptions/templates/{id}","title":"Update subscription template","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template"},{"openapi":"put /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Update subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template-configuration"},{"openapi":"delete /v1/subscriptions/templates/{id}","title":"Delete subscription template","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template"},{"openapi":"delete /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Delete subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template-configuration"}]},{"group":"Subscriptions > Transitions","pages":[{"openapi":"get /v2/subscriptions/transitions/{id}","title":"Get subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/get-subscription-transition"},{"openapi":"get /v2/subscriptions/transitions","title":"List subscription transitions","href":"/api-reference/endpoints/subscriptions->-transitions/list-subscription-transitions"},{"openapi":"post /v2/subscriptions/transitions","title":"Create subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/create-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/{id}/cancel","title":"Cancel subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/cancel-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/preview","title":"Preview subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/preview-subscription-transition"}]},{"group":"Taxes","pages":[{"openapi":"get /v1/taxes/rates/{id}","title":"Get tax rate","href":"/api-reference/endpoints/taxes/get-tax-rate"},{"openapi":"get /v1/taxes/rates","title":"List tax rates","href":"/api-reference/endpoints/taxes/list-tax-rates"},{"openapi":"post /v1/taxes/rates","title":"Create tax rate","href":"/api-reference/endpoints/taxes/create-tax-rate"},{"openapi":"patch /v1/taxes/rates/{id}","title":"Update tax rate","href":"/api-reference/endpoints/taxes/update-tax-rate"},{"openapi":"delete /v1/taxes/rates/{id}","title":"Delete tax rate","href":"/api-reference/endpoints/taxes/delete-tax-rate"}]},{"group":"Third-party apps","pages":[{"openapi":"get /v1/apps","title":"List apps","href":"/api-reference/endpoints/third-party-apps/list-apps"},{"openapi":"post /v1/apps","title":"Create app","href":"/api-reference/endpoints/third-party-apps/create-app"},{"openapi":"put /v1/apps/{id}","title":"Update app","href":"/api-reference/endpoints/third-party-apps/update-app"},{"openapi":"delete /v1/apps/{id}","title":"Delete app","href":"/api-reference/endpoints/third-party-apps/delete-app"}]},{"group":"Transactions","pages":[{"openapi":"get /v1/transactions/{id}","title":"Get transaction","href":"/api-reference/endpoints/transactions/get-transaction"},{"openapi":"get /v1/transactions","title":"List transactions","href":"/api-reference/endpoints/transactions/list-transactions"},{"openapi":"post /v1/transactions","title":"Create transaction","href":"/api-reference/endpoints/transactions/create-transaction"},{"openapi":"post /v1/transactions/{id}/refund","title":"Refund transaction","href":"/api-reference/endpoints/transactions/refund-transaction"},{"openapi":"delete /v1/transactions/{id}","title":"Delete transaction","href":"/api-reference/endpoints/transactions/delete-transaction"}]},{"group":"Users","pages":[{"openapi":"get /v1/users/{id}","title":"Get user","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /v1/users","title":"List users","href":"/api-reference/endpoints/users/list-users"}]},{"group":"Users > Roles","pages":[{"openapi":"get /v1/users/roles/{id}","title":"Get user role","href":"/api-reference/endpoints/users->-roles/get-user-role"},{"openapi":"get /v1/users/roles","title":"List user roles","href":"/api-reference/endpoints/users->-roles/list-user-roles"}]},{"group":"Wallets","pages":[{"openapi":"get /v1/wallets/settings","title":"Get wallet settings","href":"/api-reference/endpoints/wallets/get-wallet-settings"},{"openapi":"get /v1/wallets/{id}","title":"Get wallet","href":"/api-reference/endpoints/wallets/get-wallet"},{"openapi":"get /v2/wallets","title":"List wallets","href":"/api-reference/endpoints/wallets/list-wallets"},{"openapi":"get /v1/wallets/{id}/transactions","title":"List wallet transactions","href":"/api-reference/endpoints/wallets/list-wallet-transactions"},{"openapi":"post /v1/wallets","title":"Create wallet","href":"/api-reference/endpoints/wallets/create-wallet"},{"openapi":"patch /v1/wallets/settings","title":"Update wallet settings","href":"/api-reference/endpoints/wallets/update-wallet-settings"},{"openapi":"put /v1/wallets/{id}","title":"Update wallet","href":"/api-reference/endpoints/wallets/update-wallet"},{"openapi":"post /v1/wallets/{id}/load","title":"Load wallet","href":"/api-reference/endpoints/wallets/load-wallet"},{"openapi":"post /v1/wallets/{id}/transactions/{transactionId}/revert","title":"Revert wallet load","href":"/api-reference/endpoints/wallets/revert-wallet-load"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks/endpoints/{id}","title":"Get webhook endpoint","href":"/api-reference/endpoints/webhooks/get-webhook-endpoint"},{"openapi":"get /v1/webhooks/endpoints","title":"List webhook endpoints","href":"/api-reference/endpoints/webhooks/list-webhook-endpoints"},{"openapi":"get /v1/webhooks/messages","title":"List webhook messages","href":"/api-reference/endpoints/webhooks/list-webhook-messages"},{"openapi":"post /v1/webhooks/endpoints","title":"Create webhook endpoint","href":"/api-reference/endpoints/webhooks/create-webhook-endpoint"},{"openapi":"put /v1/webhooks/endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/endpoints/webhooks/update-webhook-endpoint"},{"openapi":"delete /v1/webhooks/endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/endpoints/webhooks/delete-webhook-endpoint"}]}]},{"tab":"Guides","icon":"list-check","pages":[{"title":"Guides","href":"/guides/importing-historical-data"}]},{"tab":"Integrations","icon":"link","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog/2026-10"}]}]},"basePath":"","title":"List quotes - Hyperline","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}