The billing schedule this quote amends and the date the change takes effect. Set it only on AMENDMENT quotes; leave it out or send null for no amendment.
The signature mode used when the quote is published. Can be EMBEDDED, NON_EMBEDDED. It is null if the quote is a draft or if e-signatures are disabled for the quote.
Timestamp when quote ready-to-sign operation was triggered.
Example:
"2022-06-28T16:47:00Z"
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Sequence","colors":{"primary":"#716FFF","light":"#716FFF","dark":"#716FFF"},"logo":{"light":"https://mintcdn.com/sequence/bptUiZLY1oEfBaTZ/logo/light.svg?fit=max\u0026auto=format\u0026n=bptUiZLY1oEfBaTZ\u0026q=85\u0026s=02adc18f83942b8bdc86ec2b67937e1a","dark":"https://mintcdn.com/sequence/bptUiZLY1oEfBaTZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=bptUiZLY1oEfBaTZ\u0026q=85\u0026s=38182050e1a27d88e9d34b686c985f32"},"favicon":"https://mintcdn.com/sequence/mEkhIlLyJGyDgjJd/favicon.png?fit=max\u0026auto=format\u0026n=mEkhIlLyJGyDgjJd\u0026q=85\u0026s=aebbf4110c663663a51501b506edfcdc","api":{"mdx":{"server":["https://eu.sequencehq.com/api","https://sandbox.sequencehq.com/api"]}},"navbar":{"links":[{"href":"https://dashboard.sequencehq.com","label":"Sign in"}],"primary":{"type":"button","label":"Request Access","href":"https://access.sequencehq.com/"}},"footer":{"socials":{"twitter":"https://twitter.com/SequenceHQ_","github":"https://github.com/sequencehq","linkedin":"https://www.linkedin.com/company/sequence-hq"}},"integrations":{"koala":{"publicApiKey":"pk_c9f1d1603102eb7e1c3a4f6922a45f72991b"},"plausible":{"domain":"sequencehq.com"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Speak to an expert","icon":"message-check","href":"https://access.sequencehq.com/"},{"anchor":"Changelog","icon":"bolt","href":"https://www.sequencehq.com/changelog"},{"anchor":"Blog","icon":"rss","href":"https://www.sequencehq.com/blog"},{"anchor":"Principles","icon":"bookmark","href":"https://www.sequencehq.com/principles"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sequence","hasAudioNarration":false,"actualSubdomain":"sequence","customDomains":["docs.sequencehq.com"],"gitSource":{"type":"github","owner":"sequencehq","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adbbb7aef4aad06f6721f44","collectionId":"d45a5c67-6cab-4069-99e1-a0f35ea4ea76","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adbbb7aef4aad06f6721f44"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbbb7aef4aad06f6721f44","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":388},{"language":"default","tag":"Version 2024-07-30","count":188},{"language":"default","tag":"Latest Live API","count":188},{"language":"default","tag":"Invoices","count":161},{"language":"default","tag":"Guides","count":134},{"language":"default","tag":"Billing","count":65},{"language":"default","tag":"Connectors","count":44},{"language":"default","tag":"Customer","count":38},{"language":"default","tag":"Collections","count":36},{"language":"default","tag":"Usage","count":34}]},"assistantConfig":{},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/2024-07-30/quote/update-one-of-your-quotes","slug":"/reference/2024-07-30/quote/update-one-of-your-quotes","pageMetadata":{"openapi":"quote.2024-07-30.product.live PUT /quotes/{id}","title":"Update one of your quotes","description":"Update a quote including its phases","href":"/reference/2024-07-30/quote/update-one-of-your-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: \"Update a quote including its phases\"\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":"quote.2024-07-30.product.live PUT /quotes/{id}","title":"Update one of your quotes","description":"Update a quote including its phases","href":"/reference/2024-07-30/quote/update-one-of-your-quotes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Quotes"],"summary":"Update one of your quotes","description":"Update a quote including its phases","operationId":"putQuotesById","parameters":["1732d199-6eb5-4810-bce8-0d95a072ab80","35065293-d067-4564-9a72-5b1027b151c3","d72fa9c8-16d5-40a2-bbad-d91253527f90"],"requestBody":"2fd40102-1112-473f-8814-39979a9e8bbb","responses":{"200":"3451a6f1-6f7c-4eec-8e22-b98d1d47c55a","400":"be8e74f0-a201-43c3-8f1c-babd2a1c22d4","401":"490e4d03-d933-4c4f-9faa-09bb87f55356","404":"ee5471f1-43bd-4cb5-a4e8-c8d8b2ae8b9d","500":"adde371e-d649-4f8f-b56f-20e43bd2d03e"},"method":"put","type":"path","servers":[],"security":[],"path":"/quotes/{id}","baseUrlOptions":["https://eu.sequencehq.com/api","https://sandbox.sequencehq.com/api"],"title":"Update one of your quotes","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1732d199-6eb5-4810-bce8-0d95a072ab80":{"name":"id","in":"path","description":"Quote ID","required":true,"schema":{"type":"string","isRequired":true,"description":"Quote ID","uniqueKey":"","typeLabel":"string"}},"35065293-d067-4564-9a72-5b1027b151c3":{"name":"Authorization","in":"header","description":"Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.","required":true,"schema":{"type":"string","isRequired":true,"description":"Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.","uniqueKey":"","typeLabel":"string"}},"d72fa9c8-16d5-40a2-bbad-d91253527f90":{"name":"sequence-version","in":"header","description":"Use this header to select an API version","required":false,"schema":{"type":"string","enum":["2024-07-30"],"isRequired":false,"description":"Use this header to select an API version","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"content":{"application/json":{"schema":{"required":["contactIds","phases"],"type":"object","example":{"customerId":"377bf97b-ca1d-4538-be06-4022afa6bde3","title":"My updated quote","currency":"GBP","dealType":"AMENDMENT","amendment":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01"},"preliminaryBillingStartDate":"2022-10-01","expiryDays":30,"phases":[{"name":"My new phase","prices":[{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"duration":{"days":0,"weeks":0,"months":6,"years":1},"discounts":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"type":"PERCENTAGE","amount":"50","message":"message","seatDiscountType":"ALL_SEATS"}],"minimums":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50"}]}],"contactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"],"ccContactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"counterSignerIds":["0190dae7-7228-7619-aad8-c51f56733b2b"],"integrationIds":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF"}],"salesforceOpportunityId":"a00Hr00001BiFbjIAF","attachmentAssetIds":["0191761e-197f-79b6-b30a-012b54eae71b"],"defaultDueDateDays":30},"properties":{"phases":{"type":"array","description":"Phases for this quote, in sequential order","example":[{"name":"My new phase","prices":[{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"duration":{"days":0,"weeks":0,"months":6,"years":1},"discounts":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"type":"PERCENTAGE","amount":"50","message":"message","seatDiscountType":"ALL_SEATS"}],"minimums":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50"}]}],"items":{"required":["discounts","minimums","prices"],"type":"object","example":{"name":"My new phase","prices":[{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"duration":{"days":0,"weeks":0,"months":6,"years":1},"discounts":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"type":"PERCENTAGE","amount":"50","message":"message","seatDiscountType":"ALL_SEATS"}],"minimums":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50"}]},"properties":{"prices":{"type":"array","description":"Prices within this phase","example":[{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"items":{"required":["billingFrequency","billingType","customMetricParameters","integrationIds","name","productId","structure","temporaryId"],"type":"object","example":{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},"properties":{"temporaryId":{"type":"string","description":"A temporary ID with which to associate the price to other objects within the phase. This must be a UUID.","example":"5100e884-e007-4183-8355-4771865cb4d7","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].temporaryId","typeLabel":"string"},"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].productId","typeLabel":"string"},"name":{"type":"string","description":"The customer-facing name of this price","example":"Sample product","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].name","typeLabel":"string"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.price","typeLabel":"string"},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0","typeLabel":"object"},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.price","typeLabel":"string"},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1","typeLabel":"object"},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricePerUnit","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.usageMetricId","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.isPricePercentage","typeLabel":"boolean"},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2","typeLabel":"object"},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.seatMetricId","typeLabel":"string"},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricePerSeat","typeLabel":"string"},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorationStrategy","typeLabel":"enum\u003cstring>"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.contractedMinimumSeats","typeLabel":"integer"},"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].price","typeLabel":"string"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers","typeLabel":"object[]"},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricingType","typeLabel":"enum\u003cstring>"},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency","typeLabel":"enum\u003cstring> | null"},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.0","typeLabel":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageMetricId","typeLabel":"string"},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageCalculationMode","typeLabel":"enum\u003cstring>"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee","typeLabel":"string | null"},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.0","typeLabel":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice","typeLabel":"string | null"},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.0","typeLabel":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5","typeLabel":"object"},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.packageSize","typeLabel":"string"},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricePerPackage","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6","typeLabel":"object"}],"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure","typeLabel":"object"},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price.","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].billingFrequency","typeLabel":"enum\u003cstring>"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance.","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].billingType","typeLabel":"enum\u003cstring>"},"integrationIds":{"type":"array","description":"Alternate IDs for this price in third-party integration systems","example":[{"service":"Xero","id":"123"}],"items":{"required":["id","service"],"type":"object","example":{"service":"Xero","id":"123"},"properties":{"service":{"type":"string","example":"Xero","enum":["Amazon_Redshift","GoCardless","Google_BigQuery","Google_Sheets","HubSpot","NetSuite","QuickBooks_Online","Salesforce","Slack","Snowflake","Stripe","Xero","Avalara","Anrok","Attio","Numeral","Rillet","Sphere"],"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX].service","typeLabel":"enum\u003cstring>"},"id":{"type":"string","example":"123","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds","typeLabel":"object[]"},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].parameterId","typeLabel":"string"},"value":{"type":"string","description":"Parameter value","example":"10","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters","typeLabel":"object[]"},"listPriceId":{"oneOf":[{"type":"string","description":"The list price ID, if this quote price variant was created from a list price","example":"b4d7e884-e007-4183-8355-4771865c5100","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].listPriceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The list price ID, if this quote price variant was created from a list price","example":"b4d7e884-e007-4183-8355-4771865c5100","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].listPriceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].listPriceId","typeLabel":"string | null"}},"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices","typeLabel":"object[]"},"discounts":{"type":"array","description":"Discounts within this phase","example":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"type":"PERCENTAGE","amount":"50","message":"message","seatDiscountType":"ALL_SEATS"}],"items":{"required":["amount","message","restrictToPrices","type"],"type":"object","example":{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"type":"PERCENTAGE","amount":"50","message":"message","seatDiscountType":"ALL_SEATS"},"properties":{"restrictToPrices":{"type":"array","example":["5100e884-e007-4183-8355-4771865cb4d7"],"items":{"type":"string","uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].restrictToPrices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].restrictToPrices","typeLabel":"string[]"},"type":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","example":"50","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].amount","typeLabel":"string"},"message":{"type":"string","example":"message","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].message","typeLabel":"string"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts","typeLabel":"object[]"},"minimums":{"type":"array","description":"Minimums within this phase","example":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50"}],"items":{"required":["amount","restrictToPrices"],"type":"object","example":{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50"},"properties":{"restrictToPrices":{"type":"array","example":["5100e884-e007-4183-8355-4771865cb4d7"],"items":{"type":"string","uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].restrictToPrices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].restrictToPrices","typeLabel":"string[]"},"amount":{"type":"string","example":"50","isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].amount","typeLabel":"string"}},"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums","typeLabel":"object[]"},"name":{"oneOf":[{"type":"string","description":"Optional name of phase","example":"My new phase","uniqueKey":"phases.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional name of phase","example":"My new phase","uniqueKey":"phases.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].name","typeLabel":"string | null"},"duration":{"oneOf":[{"required":["days","months","weeks","years"],"type":"object","description":"Duration of phase. Null denotes an open-ended phase.","example":{"days":-1,"weeks":0,"months":6,"years":1},"properties":{"days":{"type":"integer","format":"int32","example":-1,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.days","typeLabel":"integer\u003cint32>"},"weeks":{"type":"integer","format":"int32","example":0,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.weeks","typeLabel":"integer\u003cint32>"},"months":{"type":"integer","format":"int32","example":6,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.months","typeLabel":"integer\u003cint32>"},"years":{"type":"integer","format":"int32","example":1,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.years","typeLabel":"integer\u003cint32>"}},"uniqueKey":"phases.items.[INDEX].duration.oneOf.0","typeLabel":"object"},{"required":["days","months","weeks","years"],"type":"null","description":"Duration of phase. Null denotes an open-ended phase.","example":{"days":-1,"weeks":0,"months":6,"years":1},"properties":{"days":{"type":"integer","format":"int32","example":-1},"weeks":{"type":"integer","format":"int32","example":0},"months":{"type":"integer","format":"int32","example":6},"years":{"type":"integer","format":"int32","example":1}},"uniqueKey":"phases.items.[INDEX].duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].duration","typeLabel":"object | null"}},"uniqueKey":"phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases","typeLabel":"object[]"},"contactIds":{"type":"array","description":"IDs of contacts who will receive this quote (and sign this quote if using e-signatures)","example":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"],"items":{"type":"string","uniqueKey":"contactIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"contactIds","typeLabel":"string[]"},"customerId":{"oneOf":[{"type":"string","description":"ID of Customer to which this quote pertains","example":"377bf97b-ca1d-4538-be06-4022afa6bde3","uniqueKey":"customerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of Customer to which this quote pertains","example":"377bf97b-ca1d-4538-be06-4022afa6bde3","uniqueKey":"customerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerId","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The quote title","example":"My updated quote","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The quote title","example":"My updated quote","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","example":"GBP","enum":["AED","ARS","AUD","BRL","BGN","CAD","CHF","CLP","CNY","COP","CZK","DKK","EGP","EUR","GBP","HKD","ILS","INR","ISK","JPY","KRW","MXN","NOK","NZD","PLN","SAR","SEK","SGD","THB","USD","UYU","ZAR"],"description":"Quote currency","uniqueKey":"currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"GBP","enum":["AED","ARS","AUD","BRL","BGN","CAD","CHF","CLP","CNY","COP","CZK","DKK","EGP","EUR","GBP","HKD","ILS","INR","ISK","JPY","KRW","MXN","NOK","NZD","PLN","SAR","SEK","SGD","THB","USD","UYU","ZAR"],"description":"Quote currency","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"enum\u003cstring> | null"},"dealType":{"oneOf":[{"type":"string","example":"AMENDMENT","enum":["NEW_BUSINESS","RENEWAL","AMENDMENT"],"description":"Quote deal type","uniqueKey":"dealType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"AMENDMENT","enum":["NEW_BUSINESS","RENEWAL","AMENDMENT"],"description":"Quote deal type","uniqueKey":"dealType.oneOf.1","typeLabel":"null"}],"uniqueKey":"dealType","typeLabel":"enum\u003cstring> | null"},"amendment":{"oneOf":[{"required":["billingScheduleId","effectiveFrom"],"type":"object","description":"The billing schedule this quote amends and the date the change takes effect. Set it only on AMENDMENT quotes; leave it out or send null for no amendment.","example":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01"},"properties":{"billingScheduleId":{"type":"string","description":"ID of the active billing schedule this quote amends. It must belong to the quote's customer.","example":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","isRequired":true,"uniqueKey":"amendment.oneOf.0.billingScheduleId","typeLabel":"string"},"effectiveFrom":{"type":"string","description":"Date the amendment should take effect on the billing schedule. Once this date has passed, executing is refused unless whenEffectiveDatePassed is TAKE_EFFECT_TODAY; it then applies from appliedFrom.","example":"2022-11-01","isRequired":true,"uniqueKey":"amendment.oneOf.0.effectiveFrom","typeLabel":"string"}},"uniqueKey":"amendment.oneOf.0","typeLabel":"object"},{"required":["billingScheduleId","effectiveFrom"],"type":"null","description":"The billing schedule this quote amends and the date the change takes effect. Set it only on AMENDMENT quotes; leave it out or send null for no amendment.","example":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01"},"properties":{"billingScheduleId":{"type":"string","description":"ID of the active billing schedule this quote amends. It must belong to the quote's customer.","example":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"},"effectiveFrom":{"type":"string","description":"Date the amendment should take effect on the billing schedule. Once this date has passed, executing is refused unless whenEffectiveDatePassed is TAKE_EFFECT_TODAY; it then applies from appliedFrom.","example":"2022-11-01"}},"uniqueKey":"amendment.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment","typeLabel":"object | null"},"preliminaryBillingStartDate":{"oneOf":[{"type":"string","description":"Preliminary start date of contract","example":"2022-10-01","uniqueKey":"preliminaryBillingStartDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preliminary start date of contract","example":"2022-10-01","uniqueKey":"preliminaryBillingStartDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"preliminaryBillingStartDate","typeLabel":"string | null"},"expiryDays":{"oneOf":[{"type":"integer","description":"Number of days after publishing in which quote will expire","format":"int32","example":30,"uniqueKey":"expiryDays.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Number of days after publishing in which quote will expire","format":"int32","example":30,"uniqueKey":"expiryDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiryDays","typeLabel":"integer\u003cint32> | null"},"ccContactIds":{"oneOf":[{"type":"array","description":"IDs of contacts who receive emails about this quote but do not sign it","example":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"items":{"type":"string","uniqueKey":"ccContactIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"ccContactIds.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"IDs of contacts who receive emails about this quote but do not sign it","example":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"items":{"type":"string"},"uniqueKey":"ccContactIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"ccContactIds","typeLabel":"string[] | null"},"counterSignerIds":{"oneOf":[{"type":"array","description":"IDs of internal counter signers who will receive this quote (and sign this quote if using e-signatures)","example":["0190dae7-7228-7619-aad8-c51f56733b2b"],"items":{"type":"string","uniqueKey":"counterSignerIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"counterSignerIds.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"IDs of internal counter signers who will receive this quote (and sign this quote if using e-signatures)","example":["0190dae7-7228-7619-aad8-c51f56733b2b"],"items":{"type":"string"},"uniqueKey":"counterSignerIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterSignerIds","typeLabel":"string[] | null"},"integrationIds":{"oneOf":[{"type":"array","description":"IDs of external entities that are linked to this quote","example":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF"}],"items":{"required":["id","service"],"type":"object","example":{"service":"Xero","id":"123"},"properties":{"service":{"type":"string","example":"Xero","enum":["Amazon_Redshift","GoCardless","Google_BigQuery","Google_Sheets","HubSpot","NetSuite","QuickBooks_Online","Salesforce","Slack","Snowflake","Stripe","Xero","Avalara","Anrok","Attio","Numeral","Rillet","Sphere"],"isRequired":true,"uniqueKey":"integrationIds.oneOf.0.items.[INDEX].service","typeLabel":"enum\u003cstring>"},"id":{"type":"string","example":"123","isRequired":true,"uniqueKey":"integrationIds.oneOf.0.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"integrationIds.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"integrationIds.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"IDs of external entities that are linked to this quote","example":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF"}],"items":{"required":["id","service"],"type":"object","example":{"service":"Xero","id":"123"},"properties":{"service":{"type":"string","example":"Xero","enum":["Amazon_Redshift","GoCardless","Google_BigQuery","Google_Sheets","HubSpot","NetSuite","QuickBooks_Online","Salesforce","Slack","Snowflake","Stripe","Xero","Avalara","Anrok","Attio","Numeral","Rillet","Sphere"]},"id":{"type":"string","example":"123"}}},"uniqueKey":"integrationIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"integrationIds","typeLabel":"object[] | null"},"salesforceOpportunityId":{"oneOf":[{"type":"string","description":"Salesforce ID of the opportunity that created this quote","example":"a00Hr00001BiFbjIAF","uniqueKey":"salesforceOpportunityId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Salesforce ID of the opportunity that created this quote","example":"a00Hr00001BiFbjIAF","uniqueKey":"salesforceOpportunityId.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesforceOpportunityId","typeLabel":"string | null"},"attachmentAssetIds":{"oneOf":[{"type":"array","description":"IDs of assets that are attached to this quote","example":["0191761e-197f-79b6-b30a-012b54eae71b"],"items":{"type":"string","uniqueKey":"attachmentAssetIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"attachmentAssetIds.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"IDs of assets that are attached to this quote","example":["0191761e-197f-79b6-b30a-012b54eae71b"],"items":{"type":"string"},"uniqueKey":"attachmentAssetIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachmentAssetIds","typeLabel":"string[] | null"},"defaultDueDateDays":{"oneOf":[{"type":"integer","description":"Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.","example":30,"uniqueKey":"defaultDueDateDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.","example":30,"uniqueKey":"defaultDueDateDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultDueDateDays","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"PublicUpdateQuoteRequestModel":{"title":"PublicUpdateQuoteRequestModel","value":{"customerId":"377bf97b-ca1d-4538-be06-4022afa6bde3","title":"My updated quote","currency":"GBP","dealType":"AMENDMENT","amendment":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01"},"preliminaryBillingStartDate":"2022-10-01","expiryDays":30,"phases":[{"name":"My new phase","prices":[{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"temporaryId":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","integrationIds":[{"service":"Xero","id":"123"}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"duration":{"days":0,"weeks":0,"months":6,"years":1},"discounts":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"type":"PERCENTAGE","amount":"50","message":"message","seatDiscountType":"ALL_SEATS"}],"minimums":[{"restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50"}]}],"contactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"],"ccContactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"counterSignerIds":["0190dae7-7228-7619-aad8-c51f56733b2b"],"integrationIds":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF"}],"salesforceOpportunityId":"a00Hr00001BiFbjIAF","attachmentAssetIds":["0191761e-197f-79b6-b30a-012b54eae71b"],"defaultDueDateDays":30}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"3451a6f1-6f7c-4eec-8e22-b98d1d47c55a":{"description":"OK","content":{"application/json":{"schema":{"required":["activeErrors","attachmentAssets","ccContactIds","ccContacts","contactIds","contacts","counterSigners","createdAt","createdBy","id","integrationIds","isExpired","isSignaturesEnabled","merchantBranding","pdfStatus","phases","quoteNumber","status","updatedAt"],"type":"object","example":{"id":"678ca125-8bc3-478f-9a96-6ba73605cf1e","createdBy":"4ffd439e-32e5-4046-bb40-3cb81f40e5da","customerId":"377bf97b-ca1d-4538-be06-4022afa6bde3","quoteNumber":"Q00001","title":"My quote","currency":"GBP","status":"EXECUTED","dealType":"AMENDMENT","amendment":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01","executableUntil":"2022-11-01","appliedFrom":"2022-11-01","original":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"amended":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"originalContractValue":"12000","amendedContractValue":"15500","adjustmentTotal":"3500","supersededByQuoteId":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b","outForSignatureQuoteId":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c"},"preliminaryBillingStartDate":"2022-10-01","expiresAt":"2022-10-01","publishedAt":"2022-06-28T16:47:00Z","readyToSignAt":"2022-06-28T16:47:00Z","acceptedAt":"2022-06-28T16:47:00Z","executedAt":"2022-06-28T16:47:00Z","createdAt":"2022-06-28T16:47:00Z","updatedAt":"2022-06-28T16:47:00Z","createdFrom":{"entityType":"QUOTE","entityId":"dc0e2104-7df5-4fc1-8f65-1823f427d111"},"salesforceOpportunityId":"006Hr00001MfnEIIAZ","expiryDays":30,"merchantBranding":{"logoUrl":"logo","legalCompanyName":"Acme Corp","primaryColour":"colour","url":"www.example.com","address":{"line1":"1 Market Street","line2":"Suite 100","town":"San Francisco","state":"CA","postcode":"94105","country":"US"},"email":"accounting@example.com","showUsageInCustomerPortal":true,"supportEmail":"support@example.com","supportUrl":"https://www.example.com/support"},"phases":[{"id":"abe4bf01-9b75-495d-f5fd-ca82b001f3a8","name":"Onboarding","createdAt":"2022-06-28T16:47:00Z","duration":{"days":-1,"weeks":0,"months":6,"years":1},"prices":[{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"discounts":[{"id":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50","discountCalculationType":"PERCENTAGE","message":"message","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","seatDiscountType":"ALL_SEATS"}],"minimums":[{"id":"018f9164-c2d9-7eb2-bb98-11ecb5454055","amount":"50","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z"}]}],"archivedAt":"2022-06-28T16:47:00Z","approvalWorkflowId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","contactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"],"contacts":[{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"ccContactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"ccContacts":[{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd","name":"John Smith","email":"john@example.com","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"counterSigners":[{"id":"0190da0c-980d-7fa2-9b65-4c79784a95b1","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"isSignaturesEnabled":false,"integrationIds":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF","isPending":false}],"customerLegalName":"Acme Corp","customerAddress":{"line1":"1 Fake Street","line2":"Fakesville","town":"Faketown","state":"CA","postcode":"F4KE","country":"US"},"pdfStatus":"NOT_YET_REQUESTED","attachmentAssets":[{"id":"e007e884-5100-4183-8355-4771865cb4dd","createdBy":"94703530-1293-479b-bd37-ccad42fd9c8b","createdByType":"SEQUENCE_USER","type":"IMAGE","format":"PNG","fileName":"my-image.png","fileSizeBytes":12345,"url":"https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png","createdAt":"2022-06-28T16:47:00Z"}],"isExpired":false,"defaultDueDateDays":30,"signatureMode":"EMBEDDED","preparingSignatureRequestAt":"2022-06-28T16:47:00Z","activeErrors":[{"id":"0190b1f2-1234-7000-8000-000000000001","errorCode":"DROPBOX_SIGNATURE_REQUEST_REJECTED","recoveryAction":"CONTACT_SUPPORT","createdAt":"2022-06-28T16:47:00Z","errorContext":{}}]},"properties":{"id":{"type":"string","description":"Unique ID","example":"678ca125-8bc3-478f-9a96-6ba73605cf1e","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"createdBy":{"type":"string","description":"The Sequence user who created this quote","example":"4ffd439e-32e5-4046-bb40-3cb81f40e5da","isRequired":true,"uniqueKey":"createdBy","typeLabel":"string"},"quoteNumber":{"type":"string","description":"An alpha-numeric value that identifies the quote","example":"Q00001","isRequired":true,"uniqueKey":"quoteNumber","typeLabel":"string"},"status":{"type":"string","example":"EXECUTED","enum":["DRAFT","PUBLISHED","PREPARING_SIGNATURE_REQUEST","READY_TO_SIGN","ACCEPTED","EXECUTED"],"description":"The status of the quote","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","description":"Creation timestamp. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Timestamp when quote was last updated. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"merchantBranding":{"required":["address","email","legalCompanyName","showUsageInCustomerPortal"],"type":"object","description":"Merchant information and branding (for quote rendering)","example":{"logoUrl":"logo","legalCompanyName":"Acme Corp","primaryColour":"colour","url":"www.example.com","address":{"line1":"1 Market Street","line2":"Suite 100","town":"San Francisco","state":"CA","postcode":"94105","country":"US"},"email":"accounting@example.com","showUsageInCustomerPortal":true,"supportEmail":"support@example.com","supportUrl":"https://www.example.com/support"},"properties":{"legalCompanyName":{"type":"string","example":"Acme Corp","isRequired":true,"uniqueKey":"merchantBranding.legalCompanyName","typeLabel":"string"},"address":{"required":["country","line1","postcode","town"],"type":"object","example":{"line1":"1 Market Street","line2":"Suite 100","town":"San Francisco","state":"CA","postcode":"94105","country":"US"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"1 Market Street","isRequired":true,"uniqueKey":"merchantBranding.address.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"San Francisco","isRequired":true,"uniqueKey":"merchantBranding.address.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"94105","isRequired":true,"uniqueKey":"merchantBranding.address.postcode","typeLabel":"string"},"country":{"type":"string","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))","isRequired":true,"uniqueKey":"merchantBranding.address.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"Suite 100","uniqueKey":"merchantBranding.address.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"Suite 100","uniqueKey":"merchantBranding.address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.address.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"merchantBranding.address.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"merchantBranding.address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.address.state","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"merchantBranding.address","typeLabel":"object"},"email":{"type":"string","example":"accounting@example.com","isRequired":true,"uniqueKey":"merchantBranding.email","typeLabel":"string"},"showUsageInCustomerPortal":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"merchantBranding.showUsageInCustomerPortal","typeLabel":"boolean"},"logoUrl":{"oneOf":[{"type":"string","example":"logo","uniqueKey":"merchantBranding.logoUrl.oneOf.0","typeLabel":"string"},{"type":"null","example":"logo","uniqueKey":"merchantBranding.logoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.logoUrl","typeLabel":"string | null"},"primaryColour":{"oneOf":[{"type":"string","example":"colour","uniqueKey":"merchantBranding.primaryColour.oneOf.0","typeLabel":"string"},{"type":"null","example":"colour","uniqueKey":"merchantBranding.primaryColour.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.primaryColour","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","example":"www.example.com","uniqueKey":"merchantBranding.url.oneOf.0","typeLabel":"string"},{"type":"null","example":"www.example.com","uniqueKey":"merchantBranding.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.url","typeLabel":"string | null"},"supportEmail":{"oneOf":[{"type":"string","example":"support@example.com","uniqueKey":"merchantBranding.supportEmail.oneOf.0","typeLabel":"string"},{"type":"null","example":"support@example.com","uniqueKey":"merchantBranding.supportEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.supportEmail","typeLabel":"string | null"},"supportUrl":{"oneOf":[{"type":"string","example":"https://www.example.com/support","uniqueKey":"merchantBranding.supportUrl.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://www.example.com/support","uniqueKey":"merchantBranding.supportUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantBranding.supportUrl","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"merchantBranding","typeLabel":"object"},"phases":{"type":"array","description":"Phases for this quote, in sequential order","example":[{"id":"abe4bf01-9b75-495d-f5fd-ca82b001f3a8","name":"Onboarding","createdAt":"2022-06-28T16:47:00Z","duration":{"days":-1,"weeks":0,"months":6,"years":1},"prices":[{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"discounts":[{"id":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50","discountCalculationType":"PERCENTAGE","message":"message","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","seatDiscountType":"ALL_SEATS"}],"minimums":[{"id":"018f9164-c2d9-7eb2-bb98-11ecb5454055","amount":"50","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z"}]}],"items":{"required":["createdAt","discounts","id","minimums","prices"],"type":"object","example":{"id":"abe4bf01-9b75-495d-f5fd-ca82b001f3a8","name":"Onboarding","createdAt":"2022-06-28T16:47:00Z","duration":{"days":-1,"weeks":0,"months":6,"years":1},"prices":[{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"discounts":[{"id":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50","discountCalculationType":"PERCENTAGE","message":"message","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","seatDiscountType":"ALL_SEATS"}],"minimums":[{"id":"018f9164-c2d9-7eb2-bb98-11ecb5454055","amount":"50","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z"}]},"properties":{"id":{"type":"string","description":"Unique ID","example":"abe4bf01-9b75-495d-f5fd-ca82b001f3a8","isRequired":true,"uniqueKey":"phases.items.[INDEX].id","typeLabel":"string"},"createdAt":{"type":"string","description":"Creation timestamp. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].createdAt","typeLabel":"string"},"prices":{"type":"array","description":"Prices within this phase","example":[{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"items":{"required":["billingFrequency","billingType","createdAt","customMetricParameters","id","integrationIds","name","productId","structure","updatedAt"],"type":"object","example":{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},"properties":{"id":{"type":"string","description":"Unique ID","example":"5100e884-e007-4183-8355-4771865cb4d7","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].id","typeLabel":"string"},"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].productId","typeLabel":"string"},"name":{"type":"string","description":"The customer-facing name of this price","example":"Sample product","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].name","typeLabel":"string"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.price","typeLabel":"string"},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0","typeLabel":"object"},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.price","typeLabel":"string"},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1","typeLabel":"object"},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricePerUnit","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.usageMetricId","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.isPricePercentage","typeLabel":"boolean"},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2","typeLabel":"object"},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.seatMetricId","typeLabel":"string"},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricePerSeat","typeLabel":"string"},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorationStrategy","typeLabel":"enum\u003cstring>"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.contractedMinimumSeats","typeLabel":"integer"},"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].price","typeLabel":"string"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers","typeLabel":"object[]"},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricingType","typeLabel":"enum\u003cstring>"},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency","typeLabel":"enum\u003cstring> | null"},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.0","typeLabel":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageMetricId","typeLabel":"string"},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageCalculationMode","typeLabel":"enum\u003cstring>"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee","typeLabel":"string | null"},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.0","typeLabel":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice","typeLabel":"string | null"},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.0","typeLabel":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5","typeLabel":"object"},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.packageSize","typeLabel":"string"},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricePerPackage","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6","typeLabel":"object"}],"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].structure","typeLabel":"object"},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price.","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].billingFrequency","typeLabel":"enum\u003cstring>"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance.","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].billingType","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","description":"Creation timestamp. Formatted as an ISO 8601 timestamp.","example":"2021-08-25T12:00:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.","example":"2021-08-25T12:00:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].updatedAt","typeLabel":"string"},"integrationIds":{"type":"array","description":"Alternate IDs for this price in third-party integration systems","example":[{"service":"Xero","id":"123","isPending":false}],"items":{"required":["id","isPending","service"],"type":"object","example":{"service":"Xero","id":"123","isPending":false},"properties":{"service":{"type":"string","example":"Xero","enum":["Amazon_Redshift","GoCardless","Google_BigQuery","Google_Sheets","HubSpot","NetSuite","QuickBooks_Online","Salesforce","Slack","Snowflake","Stripe","Xero","Avalara","Anrok","Attio","Numeral","Rillet","Sphere"],"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX].service","typeLabel":"enum\u003cstring>"},"id":{"type":"string","example":"123","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX].id","typeLabel":"string"},"isPending":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX].isPending","typeLabel":"boolean"}},"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].integrationIds","typeLabel":"object[]"},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].parameterId","typeLabel":"string"},"value":{"type":"string","description":"Parameter value","example":"10","isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].customMetricParameters","typeLabel":"object[]"},"listPriceId":{"oneOf":[{"type":"string","description":"The list price ID, if this quote price variant was created from a list price","example":"b4d7e884-e007-4183-8355-4771865c5100","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].listPriceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The list price ID, if this quote price variant was created from a list price","example":"b4d7e884-e007-4183-8355-4771865c5100","uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].listPriceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX].listPriceId","typeLabel":"string | null"}},"uniqueKey":"phases.items.[INDEX].prices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].prices","typeLabel":"object[]"},"discounts":{"type":"array","description":"Discounts within this phase","example":[{"id":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50","discountCalculationType":"PERCENTAGE","message":"message","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","seatDiscountType":"ALL_SEATS"}],"items":{"required":["amount","createdAt","discountCalculationType","id","message","restrictToPrices","updatedAt"],"type":"object","example":{"id":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50","discountCalculationType":"PERCENTAGE","message":"message","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","seatDiscountType":"ALL_SEATS"},"properties":{"id":{"type":"string","description":"Discount ID","example":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].id","typeLabel":"string"},"restrictToPrices":{"type":"array","description":"Price IDs the discount is restricted to","example":["5100e884-e007-4183-8355-4771865cb4d7"],"items":{"type":"string","uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].restrictToPrices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].restrictToPrices","typeLabel":"string[]"},"amount":{"type":"string","description":"Discount amount","example":"50","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].amount","typeLabel":"string"},"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].discountCalculationType","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"message","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].message","typeLabel":"string"},"createdAt":{"type":"string","description":"Created at","example":"2021-08-25T12:00:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Updated at","example":"2021-08-25T12:00:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].updatedAt","typeLabel":"string"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices","uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices","uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"phases.items.[INDEX].discounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].discounts","typeLabel":"object[]"},"minimums":{"type":"array","description":"Minimums within this phase","example":[{"id":"018f9164-c2d9-7eb2-bb98-11ecb5454055","amount":"50","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z"}],"items":{"required":["amount","createdAt","id","restrictToPrices","updatedAt"],"type":"object","example":{"id":"018f9164-c2d9-7eb2-bb98-11ecb5454055","amount":"50","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z"},"properties":{"id":{"type":"string","description":"Minimum ID","example":"018f9164-c2d9-7eb2-bb98-11ecb5454055","isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].id","typeLabel":"string"},"amount":{"type":"string","description":"Minimum amount","example":"50","isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].amount","typeLabel":"string"},"restrictToPrices":{"type":"array","description":"Price IDs the minimum is restricted to","example":["5100e884-e007-4183-8355-4771865cb4d7"],"items":{"type":"string","uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].restrictToPrices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].restrictToPrices","typeLabel":"string[]"},"createdAt":{"type":"string","description":"Created at","example":"2021-08-25T12:00:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Updated at","example":"2021-08-25T12:00:00Z","isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"phases.items.[INDEX].minimums.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases.items.[INDEX].minimums","typeLabel":"object[]"},"name":{"oneOf":[{"type":"string","description":"Optional name of phase","example":"Onboarding","uniqueKey":"phases.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional name of phase","example":"Onboarding","uniqueKey":"phases.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].name","typeLabel":"string | null"},"duration":{"oneOf":[{"required":["days","months","weeks","years"],"type":"object","description":"Duration of phase. Null denotes an open-ended phase.","example":{"days":-1,"weeks":0,"months":6,"years":1},"properties":{"days":{"type":"integer","format":"int32","example":-1,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.days","typeLabel":"integer\u003cint32>"},"weeks":{"type":"integer","format":"int32","example":0,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.weeks","typeLabel":"integer\u003cint32>"},"months":{"type":"integer","format":"int32","example":6,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.months","typeLabel":"integer\u003cint32>"},"years":{"type":"integer","format":"int32","example":1,"isRequired":true,"uniqueKey":"phases.items.[INDEX].duration.oneOf.0.years","typeLabel":"integer\u003cint32>"}},"uniqueKey":"phases.items.[INDEX].duration.oneOf.0","typeLabel":"object"},{"required":["days","months","weeks","years"],"type":"null","description":"Duration of phase. Null denotes an open-ended phase.","example":{"days":-1,"weeks":0,"months":6,"years":1},"properties":{"days":{"type":"integer","format":"int32","example":-1},"weeks":{"type":"integer","format":"int32","example":0},"months":{"type":"integer","format":"int32","example":6},"years":{"type":"integer","format":"int32","example":1}},"uniqueKey":"phases.items.[INDEX].duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"phases.items.[INDEX].duration","typeLabel":"object | null"}},"uniqueKey":"phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"phases","typeLabel":"object[]"},"contactIds":{"type":"array","description":"IDs of contacts who will receive this quote (and sign this quote if using e-signatures)","example":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"],"items":{"type":"string","uniqueKey":"contactIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"contactIds","typeLabel":"string[]"},"contacts":{"type":"array","description":"List of contacts requested to sign this quote","example":[{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"items":{"required":["contactId","email","name","notificationHistory"],"type":"object","example":{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]},"properties":{"contactId":{"type":"string","description":"Unique Contact ID","example":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc","isRequired":true,"uniqueKey":"contacts.items.[INDEX].contactId","typeLabel":"string"},"name":{"type":"string","description":"Full name of the signer","example":"Jane Doe","isRequired":true,"uniqueKey":"contacts.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","description":"Email address of the signer","example":"jane@example.com","isRequired":true,"uniqueKey":"contacts.items.[INDEX].email","typeLabel":"string"},"notificationHistory":{"type":"array","description":"Notifications this recipient received about this published quote, newest first","example":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}],"items":{"required":["notifiedAt","trigger"],"type":"object","example":{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"},"properties":{"notifiedAt":{"type":"string","description":"The time this notification was sent. ISO 8601.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"contacts.items.[INDEX].notificationHistory.items.[INDEX].notifiedAt","typeLabel":"string"},"trigger":{"type":"string","example":"PUBLISH","enum":["PUBLISH","READY_TO_SIGN","SEND_REMINDERS","NOTIFY_RECIPIENTS"],"description":"Which operation sent this notification","isRequired":true,"uniqueKey":"contacts.items.[INDEX].notificationHistory.items.[INDEX].trigger","typeLabel":"enum\u003cstring>"}},"uniqueKey":"contacts.items.[INDEX].notificationHistory.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"contacts.items.[INDEX].notificationHistory","typeLabel":"object[]"},"signedAt":{"oneOf":[{"type":"string","description":"The time at which this contact signed the document. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"contacts.items.[INDEX].signedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The time at which this contact signed the document. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"contacts.items.[INDEX].signedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts.items.[INDEX].signedAt","typeLabel":"string | null"}},"uniqueKey":"contacts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"contacts","typeLabel":"object[]"},"ccContactIds":{"type":"array","description":"IDs of contacts who receive emails about this quote but do not sign it","example":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"items":{"type":"string","uniqueKey":"ccContactIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"ccContactIds","typeLabel":"string[]"},"ccContacts":{"type":"array","description":"List of contacts who receive emails about this quote but do not sign it","example":[{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd","name":"John Smith","email":"john@example.com","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"items":{"required":["contactId","email","name","notificationHistory"],"type":"object","example":{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd","name":"John Smith","email":"john@example.com","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]},"properties":{"contactId":{"type":"string","description":"Unique Contact ID","example":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd","isRequired":true,"uniqueKey":"ccContacts.items.[INDEX].contactId","typeLabel":"string"},"name":{"type":"string","description":"Full name of the cc recipient","example":"John Smith","isRequired":true,"uniqueKey":"ccContacts.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","description":"Email address of the cc recipient","example":"john@example.com","isRequired":true,"uniqueKey":"ccContacts.items.[INDEX].email","typeLabel":"string"},"notificationHistory":{"type":"array","description":"Notifications this recipient received about this published quote, newest first","example":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}],"items":{"required":["notifiedAt","trigger"],"type":"object","example":{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"},"properties":{"notifiedAt":{"type":"string","description":"The time this notification was sent. ISO 8601.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"ccContacts.items.[INDEX].notificationHistory.items.[INDEX].notifiedAt","typeLabel":"string"},"trigger":{"type":"string","example":"PUBLISH","enum":["PUBLISH","READY_TO_SIGN","SEND_REMINDERS","NOTIFY_RECIPIENTS"],"description":"Which operation sent this notification","isRequired":true,"uniqueKey":"ccContacts.items.[INDEX].notificationHistory.items.[INDEX].trigger","typeLabel":"enum\u003cstring>"}},"uniqueKey":"ccContacts.items.[INDEX].notificationHistory.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"ccContacts.items.[INDEX].notificationHistory","typeLabel":"object[]"}},"uniqueKey":"ccContacts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"ccContacts","typeLabel":"object[]"},"counterSigners":{"type":"array","description":"List of internal persons who countersign every quote","example":[{"id":"0190da0c-980d-7fa2-9b65-4c79784a95b1","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"items":{"required":["email","id","name","notificationHistory"],"type":"object","example":{"id":"0190da0c-980d-7fa2-9b65-4c79784a95b1","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]},"properties":{"id":{"type":"string","description":"Unique ID","example":"0190da0c-980d-7fa2-9b65-4c79784a95b1","isRequired":true,"uniqueKey":"counterSigners.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Full name of the signer","example":"Jane Doe","isRequired":true,"uniqueKey":"counterSigners.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","description":"Email address of the signer","example":"jane@example.com","isRequired":true,"uniqueKey":"counterSigners.items.[INDEX].email","typeLabel":"string"},"notificationHistory":{"type":"array","description":"Notifications this recipient received about this published quote, newest first","example":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}],"items":{"required":["notifiedAt","trigger"],"type":"object","example":{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"},"properties":{"notifiedAt":{"type":"string","description":"The time this notification was sent. ISO 8601.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"counterSigners.items.[INDEX].notificationHistory.items.[INDEX].notifiedAt","typeLabel":"string"},"trigger":{"type":"string","example":"PUBLISH","enum":["PUBLISH","READY_TO_SIGN","SEND_REMINDERS","NOTIFY_RECIPIENTS"],"description":"Which operation sent this notification","isRequired":true,"uniqueKey":"counterSigners.items.[INDEX].notificationHistory.items.[INDEX].trigger","typeLabel":"enum\u003cstring>"}},"uniqueKey":"counterSigners.items.[INDEX].notificationHistory.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"counterSigners.items.[INDEX].notificationHistory","typeLabel":"object[]"},"signedAt":{"oneOf":[{"type":"string","description":"The time at which this contact signed the document. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"counterSigners.items.[INDEX].signedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The time at which this contact signed the document. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"counterSigners.items.[INDEX].signedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"counterSigners.items.[INDEX].signedAt","typeLabel":"string | null"}},"uniqueKey":"counterSigners.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"counterSigners","typeLabel":"object[]"},"isSignaturesEnabled":{"type":"boolean","description":"Enable e-signatures to allow customers to sign this quote through Dropbox Sign.","example":false,"isRequired":true,"uniqueKey":"isSignaturesEnabled","typeLabel":"boolean"},"integrationIds":{"type":"array","description":"IDs of external entities that are linked to this quote","example":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF","isPending":false}],"items":{"required":["id","isPending","service"],"type":"object","example":{"service":"Xero","id":"123","isPending":false},"properties":{"service":{"type":"string","example":"Xero","enum":["Amazon_Redshift","GoCardless","Google_BigQuery","Google_Sheets","HubSpot","NetSuite","QuickBooks_Online","Salesforce","Slack","Snowflake","Stripe","Xero","Avalara","Anrok","Attio","Numeral","Rillet","Sphere"],"isRequired":true,"uniqueKey":"integrationIds.items.[INDEX].service","typeLabel":"enum\u003cstring>"},"id":{"type":"string","example":"123","isRequired":true,"uniqueKey":"integrationIds.items.[INDEX].id","typeLabel":"string"},"isPending":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"integrationIds.items.[INDEX].isPending","typeLabel":"boolean"}},"uniqueKey":"integrationIds.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"integrationIds","typeLabel":"object[]"},"pdfStatus":{"type":"string","example":"NOT_YET_REQUESTED","enum":["NOT_YET_REQUESTED","REQUESTED","IN_PROGRESS","FAILED","GENERATED"],"description":"Status of quote PDF generation for this variant","isRequired":true,"uniqueKey":"pdfStatus","typeLabel":"enum\u003cstring>"},"attachmentAssets":{"type":"array","description":"Assets attached to this quote","example":[{"id":"e007e884-5100-4183-8355-4771865cb4dd","createdBy":"94703530-1293-479b-bd37-ccad42fd9c8b","createdByType":"SEQUENCE_USER","type":"IMAGE","format":"PNG","fileName":"my-image.png","fileSizeBytes":12345,"url":"https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png","createdAt":"2022-06-28T16:47:00Z"}],"items":{"required":["createdAt","createdBy","createdByType","fileName","fileSizeBytes","format","id","type","url"],"type":"object","example":{"id":"e007e884-5100-4183-8355-4771865cb4dd","createdBy":"94703530-1293-479b-bd37-ccad42fd9c8b","createdByType":"SEQUENCE_USER","type":"IMAGE","format":"PNG","fileName":"my-image.png","fileSizeBytes":12345,"url":"https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png","createdAt":"2022-06-28T16:47:00Z"},"properties":{"id":{"type":"string","description":"Unique ID","example":"e007e884-5100-4183-8355-4771865cb4dd","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].id","typeLabel":"string"},"createdBy":{"type":"string","description":"The ID of the asset creator. A Sequence user id or API key id, as identified by `createdByType`.","example":"94703530-1293-479b-bd37-ccad42fd9c8b","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].createdBy","typeLabel":"string"},"createdByType":{"type":"string","example":"SEQUENCE_USER","enum":["SEQUENCE_USER","API_CLIENT"],"description":"Whether `createdBy` identifies a `SEQUENCE_USER` or an `API_CLIENT`","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].createdByType","typeLabel":"enum\u003cstring>"},"type":{"type":"string","example":"IMAGE","enum":["IMAGE","DOCUMENT","BINARY"],"description":"Either image or document","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"format":{"type":"string","example":"PNG","enum":["JPEG","JPG","PNG","PDF","CSV","TXT","RTF","MD","XLS","XLSX","XLSM","DOC","DOCX","ZIP","ODT","ODS"],"description":"Identifies the intended data format. Allowed formats are: jpg, jpeg, png, and pdf","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].format","typeLabel":"enum\u003cstring>"},"fileName":{"type":"string","description":"Filename of the uploaded file","example":"my-image.png","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].fileName","typeLabel":"string"},"fileSizeBytes":{"type":"integer","description":"Size of the uploaded file in bytes","format":"int32","example":12345,"isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].fileSizeBytes","typeLabel":"integer\u003cint32>"},"url":{"type":"string","description":"URL to download the asset","example":"https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].url","typeLabel":"string"},"createdAt":{"type":"string","description":"Creation timestamp. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"attachmentAssets.items.[INDEX].createdAt","typeLabel":"string"}},"uniqueKey":"attachmentAssets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"attachmentAssets","typeLabel":"object[]"},"isExpired":{"type":"boolean","description":"True if the quote expiry date has passed","example":false,"isRequired":true,"uniqueKey":"isExpired","typeLabel":"boolean"},"activeErrors":{"type":"array","description":"Active (unresolved) errors on the current quote variant. Empty when the quote is healthy.","example":[{"id":"0190b1f2-1234-7000-8000-000000000001","errorCode":"DROPBOX_SIGNATURE_REQUEST_REJECTED","recoveryAction":"CONTACT_SUPPORT","createdAt":"2022-06-28T16:47:00Z","errorContext":{}}],"items":{"required":["createdAt","errorCode","errorContext","id","recoveryAction"],"type":"object","example":{"id":"0190b1f2-1234-7000-8000-000000000001","errorCode":"DROPBOX_SIGNATURE_REQUEST_REJECTED","recoveryAction":"CONTACT_SUPPORT","createdAt":"2022-06-28T16:47:00Z","errorContext":{}},"properties":{"id":{"type":"string","description":"Unique ID of this error record","example":"0190b1f2-1234-7000-8000-000000000001","isRequired":true,"uniqueKey":"activeErrors.items.[INDEX].id","typeLabel":"string"},"errorCode":{"type":"string","example":"DROPBOX_SIGNATURE_REQUEST_REJECTED","enum":["DROPBOX_SIGNATURE_REQUEST_REJECTED","DROPBOX_REQUEST_NOT_ACKNOWLEDGED","PDF_GENERATION_TIMEOUT","PDF_GENERATION_FAILED","TASK_EXHAUSTED_RETRIES","WEBHOOK_PROCESSING_FAILED","AUTO_EXECUTE_FAILED","SIGNER_AUTH_FAILED","QUOTE_STUCK_IN_PREPARING_SIGNATURE_REQUEST_STATUS"],"description":"Classified code describing what failed","isRequired":true,"uniqueKey":"activeErrors.items.[INDEX].errorCode","typeLabel":"enum\u003cstring>"},"recoveryAction":{"type":"string","example":"CONTACT_SUPPORT","enum":["REPUBLISH","REGENERATE_PDF","MANUAL_EXECUTE","RESEND_SIGNING_EMAIL","RETRY_SIGNATURE_REQUEST","CONTACT_SUPPORT"],"description":"The recourse an operator should take to recover from this error","isRequired":true,"uniqueKey":"activeErrors.items.[INDEX].recoveryAction","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","description":"When the error was recorded. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","isRequired":true,"uniqueKey":"activeErrors.items.[INDEX].createdAt","typeLabel":"string"},"errorContext":{"type":"object","description":"Structured context about the failure, shape depends on errorCode","example":{},"additionalProperties":{"oneOf":[{}],"uniqueKey":"activeErrors.items.[INDEX].errorContext.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"activeErrors.items.[INDEX].errorContext","typeLabel":"object"}},"uniqueKey":"activeErrors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"activeErrors","typeLabel":"object[]"},"customerId":{"oneOf":[{"type":"string","description":"ID of Customer to which this quote pertains","example":"377bf97b-ca1d-4538-be06-4022afa6bde3","uniqueKey":"customerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of Customer to which this quote pertains","example":"377bf97b-ca1d-4538-be06-4022afa6bde3","uniqueKey":"customerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerId","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The quote title","example":"My quote","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The quote title","example":"My quote","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","example":"GBP","enum":["AED","ARS","AUD","BRL","BGN","CAD","CHF","CLP","CNY","COP","CZK","DKK","EGP","EUR","GBP","HKD","ILS","INR","ISK","JPY","KRW","MXN","NOK","NZD","PLN","SAR","SEK","SGD","THB","USD","UYU","ZAR"],"description":"Quote currency","uniqueKey":"currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"GBP","enum":["AED","ARS","AUD","BRL","BGN","CAD","CHF","CLP","CNY","COP","CZK","DKK","EGP","EUR","GBP","HKD","ILS","INR","ISK","JPY","KRW","MXN","NOK","NZD","PLN","SAR","SEK","SGD","THB","USD","UYU","ZAR"],"description":"Quote currency","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"enum\u003cstring> | null"},"dealType":{"oneOf":[{"type":"string","example":"AMENDMENT","enum":["NEW_BUSINESS","RENEWAL","AMENDMENT"],"description":"Quote deal type","uniqueKey":"dealType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"AMENDMENT","enum":["NEW_BUSINESS","RENEWAL","AMENDMENT"],"description":"Quote deal type","uniqueKey":"dealType.oneOf.1","typeLabel":"null"}],"uniqueKey":"dealType","typeLabel":"enum\u003cstring> | null"},"amendment":{"oneOf":[{"required":["billingScheduleId","effectiveFrom","executableUntil"],"type":"object","description":"The billing schedule this quote amends and the date the change takes effect. Only present on AMENDMENT quotes.","example":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01","executableUntil":"2022-11-01","appliedFrom":"2022-11-01","original":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"amended":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"originalContractValue":"12000","amendedContractValue":"15500","adjustmentTotal":"3500","supersededByQuoteId":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b","outForSignatureQuoteId":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c"},"properties":{"billingScheduleId":{"type":"string","description":"ID of the billing schedule this quote amends","example":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","isRequired":true,"uniqueKey":"amendment.oneOf.0.billingScheduleId","typeLabel":"string"},"effectiveFrom":{"type":"string","description":"The date the amendment was signed to take effect. Once this date has passed, executing is refused unless whenEffectiveDatePassed is TAKE_EFFECT_TODAY; it then applies from appliedFrom.","example":"2022-11-01","isRequired":true,"uniqueKey":"amendment.oneOf.0.effectiveFrom","typeLabel":"string"},"executableUntil":{"type":"string","description":"Deprecated. Always the same as effectiveFrom.","example":"2022-11-01","isRequired":true,"uniqueKey":"amendment.oneOf.0.executableUntil","typeLabel":"string"},"appliedFrom":{"oneOf":[{"type":"string","description":"Read-only. The date the amendment took effect, once executed. The same as effectiveFrom unless it was executed after that date and applied from that day instead.","example":"2022-11-01","uniqueKey":"amendment.oneOf.0.appliedFrom.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. The date the amendment took effect, once executed. The same as effectiveFrom unless it was executed after that date and applied from that day instead.","example":"2022-11-01","uniqueKey":"amendment.oneOf.0.appliedFrom.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.appliedFrom","typeLabel":"string | null"},"original":{"oneOf":[{"required":["phases"],"type":"object","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].startDate","typeLabel":"string"},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].productId","typeLabel":"string"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].name","typeLabel":"string"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.price","typeLabel":"string"},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0","typeLabel":"object"},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.price","typeLabel":"string"},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1","typeLabel":"object"},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricePerUnit","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.usageMetricId","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.isPricePercentage","typeLabel":"boolean"},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2","typeLabel":"object"},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.seatMetricId","typeLabel":"string"},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricePerSeat","typeLabel":"string"},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorationStrategy","typeLabel":"enum\u003cstring>"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.contractedMinimumSeats","typeLabel":"integer"},"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].price","typeLabel":"string"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers","typeLabel":"object[]"},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricingType","typeLabel":"enum\u003cstring>"},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency","typeLabel":"enum\u003cstring> | null"},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.0","typeLabel":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageMetricId","typeLabel":"string"},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageCalculationMode","typeLabel":"enum\u003cstring>"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee","typeLabel":"string | null"},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.0","typeLabel":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice","typeLabel":"string | null"},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.0","typeLabel":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5","typeLabel":"object"},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.packageSize","typeLabel":"string"},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricePerPackage","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6","typeLabel":"object"}],"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure","typeLabel":"object"},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].billingFrequency","typeLabel":"enum\u003cstring>"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].billingType","typeLabel":"enum\u003cstring>"},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].parameterId","typeLabel":"string"},"value":{"type":"string","description":"Parameter value","example":"10","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters","typeLabel":"object[]"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated.","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.0.frequency","typeLabel":"enum\u003cstring>"},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1,"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.0.interval","typeLabel":"integer\u003cint32>"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.0","typeLabel":"object"},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod","typeLabel":"object | null"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].prices","typeLabel":"object[]"},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].discountCalculationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Discount amount","example":"10","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].amount","typeLabel":"string"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].message","typeLabel":"string"},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].productIds","typeLabel":"string[]"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].discounts","typeLabel":"object[]"},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500","isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX].amount","typeLabel":"string"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX].productIds","typeLabel":"string[]"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].minimums","typeLabel":"object[]"},"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phase name","example":"Year 1","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].name","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].endDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31","uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX].endDate","typeLabel":"string | null"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.original.oneOf.0.phases","typeLabel":"object[]"}},"uniqueKey":"amendment.oneOf.0.original.oneOf.0","typeLabel":"object"},{"required":["phases"],"type":"null","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1"},{"type":"null","description":"Phase name","example":"Year 1"}]},"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"}]},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string"}}},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string"}}},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string"}}},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages"}]},"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null"}]},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string"}}},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string"}}}]},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}}]},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14"},"value":{"type":"string","description":"Parameter value","example":"10"}}}}}}},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal"},"amount":{"type":"string","description":"Discount amount","example":"10"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"}]},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}}}}}},"uniqueKey":"amendment.oneOf.0.original.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.original","typeLabel":"object | null"},"amended":{"oneOf":[{"required":["phases"],"type":"object","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].startDate","typeLabel":"string"},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].productId","typeLabel":"string"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].name","typeLabel":"string"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.price","typeLabel":"string"},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.0","typeLabel":"object"},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.price","typeLabel":"string"},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.1","typeLabel":"object"},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricePerUnit","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.usageMetricId","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.isPricePercentage","typeLabel":"boolean"},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.2","typeLabel":"object"},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.seatMetricId","typeLabel":"string"},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricePerSeat","typeLabel":"string"},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorationStrategy","typeLabel":"enum\u003cstring>"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.contractedMinimumSeats","typeLabel":"integer"},"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].price","typeLabel":"string"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.tiers","typeLabel":"object[]"},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.pricingType","typeLabel":"enum\u003cstring>"},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.overagesBillingFrequency","typeLabel":"enum\u003cstring> | null"},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.0","typeLabel":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3.prorateFlatFees","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.3","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX].fee","typeLabel":"string | null"}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageMetricId","typeLabel":"string"},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.usageCalculationMode","typeLabel":"enum\u003cstring>"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.4","typeLabel":"object"},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].price","typeLabel":"string"},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].isPricePercentage","typeLabel":"boolean"},"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.0","typeLabel":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].upperBound","typeLabel":"string | null"},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.0","typeLabel":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].fee","typeLabel":"string | null"},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.0","typeLabel":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].maxPrice","typeLabel":"string | null"},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.0","typeLabel":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX].minPrice","typeLabel":"string | null"}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers.items.[INDEX]","typeLabel":"object"},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.tiers","typeLabel":"object[]"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.5","typeLabel":"object"},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.packageSize","typeLabel":"string"},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricePerPackage","typeLabel":"string"},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.usageMetricId","typeLabel":"string"},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6.pricingType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure.oneOf.6","typeLabel":"object"}],"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].structure","typeLabel":"object"},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].billingFrequency","typeLabel":"enum\u003cstring>"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].billingType","typeLabel":"enum\u003cstring>"},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].parameterId","typeLabel":"string"},"value":{"type":"string","description":"Parameter value","example":"10","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].customMetricParameters","typeLabel":"object[]"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated.","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.0.frequency","typeLabel":"enum\u003cstring>"},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1,"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.0.interval","typeLabel":"integer\u003cint32>"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.0","typeLabel":"object"},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX].usageCalculationPeriod","typeLabel":"object | null"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].prices","typeLabel":"object[]"},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].discountCalculationType","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Discount amount","example":"10","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].amount","typeLabel":"string"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].message","typeLabel":"string"},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].productIds","typeLabel":"string[]"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX].seatDiscountType","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].discounts","typeLabel":"object[]"},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500","isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX].amount","typeLabel":"string"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX].productIds","typeLabel":"string[]"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].minimums.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].minimums","typeLabel":"object[]"},"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phase name","example":"Year 1","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].name","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].endDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31","uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX].endDate","typeLabel":"string | null"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"amendment.oneOf.0.amended.oneOf.0.phases","typeLabel":"object[]"}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.0","typeLabel":"object"},{"required":["phases"],"type":"null","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1"},{"type":"null","description":"Phase name","example":"Year 1"}]},"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"}]},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string"}}},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string"}}},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string"}}},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages"}]},"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null"}]},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string"}}},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string"}}}]},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}}]},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14"},"value":{"type":"string","description":"Parameter value","example":"10"}}}}}}},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal"},"amount":{"type":"string","description":"Discount amount","example":"10"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"}]},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}}}}}},"uniqueKey":"amendment.oneOf.0.amended.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amended","typeLabel":"object | null"},"originalContractValue":{"oneOf":[{"type":"string","description":"Read-only. The total contract value before this amendment.","example":"12000","uniqueKey":"amendment.oneOf.0.originalContractValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. The total contract value before this amendment.","example":"12000","uniqueKey":"amendment.oneOf.0.originalContractValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.originalContractValue","typeLabel":"string | null"},"amendedContractValue":{"oneOf":[{"type":"string","description":"Read-only. The total contract value of this quote.","example":"15500","uniqueKey":"amendment.oneOf.0.amendedContractValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. The total contract value of this quote.","example":"15500","uniqueKey":"amendment.oneOf.0.amendedContractValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.amendedContractValue","typeLabel":"string | null"},"adjustmentTotal":{"oneOf":[{"type":"string","description":"Read-only. The amended contract value minus the original contract value.","example":"3500","uniqueKey":"amendment.oneOf.0.adjustmentTotal.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. The amended contract value minus the original contract value.","example":"3500","uniqueKey":"amendment.oneOf.0.adjustmentTotal.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.adjustmentTotal","typeLabel":"string | null"},"supersededByQuoteId":{"oneOf":[{"type":"string","description":"Read-only. Another quote for the same billing schedule that was executed after this quote was linked to it. This quote is now out of date.","example":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b","uniqueKey":"amendment.oneOf.0.supersededByQuoteId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. Another quote for the same billing schedule that was executed after this quote was linked to it. This quote is now out of date.","example":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b","uniqueKey":"amendment.oneOf.0.supersededByQuoteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.supersededByQuoteId","typeLabel":"string | null"},"outForSignatureQuoteId":{"oneOf":[{"type":"string","description":"Read-only. Another quote for the same billing schedule that is out for signature, or accepted but not yet executed.","example":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c","uniqueKey":"amendment.oneOf.0.outForSignatureQuoteId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Read-only. Another quote for the same billing schedule that is out for signature, or accepted but not yet executed.","example":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c","uniqueKey":"amendment.oneOf.0.outForSignatureQuoteId.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment.oneOf.0.outForSignatureQuoteId","typeLabel":"string | null"}},"uniqueKey":"amendment.oneOf.0","typeLabel":"object"},{"required":["billingScheduleId","effectiveFrom","executableUntil"],"type":"null","description":"The billing schedule this quote amends and the date the change takes effect. Only present on AMENDMENT quotes.","example":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01","executableUntil":"2022-11-01","appliedFrom":"2022-11-01","original":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"amended":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"originalContractValue":"12000","amendedContractValue":"15500","adjustmentTotal":"3500","supersededByQuoteId":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b","outForSignatureQuoteId":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c"},"properties":{"billingScheduleId":{"type":"string","description":"ID of the billing schedule this quote amends","example":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"},"effectiveFrom":{"type":"string","description":"The date the amendment was signed to take effect. Once this date has passed, executing is refused unless whenEffectiveDatePassed is TAKE_EFFECT_TODAY; it then applies from appliedFrom.","example":"2022-11-01"},"executableUntil":{"type":"string","description":"Deprecated. Always the same as effectiveFrom.","example":"2022-11-01"},"appliedFrom":{"oneOf":[{"type":"string","description":"Read-only. The date the amendment took effect, once executed. The same as effectiveFrom unless it was executed after that date and applied from that day instead.","example":"2022-11-01"},{"type":"null","description":"Read-only. The date the amendment took effect, once executed. The same as effectiveFrom unless it was executed after that date and applied from that day instead.","example":"2022-11-01"}]},"original":{"oneOf":[{"required":["phases"],"type":"object","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1"},{"type":"null","description":"Phase name","example":"Year 1"}]},"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"}]},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string"}}},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string"}}},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string"}}},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages"}]},"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null"}]},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string"}}},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string"}}}]},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}}]},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14"},"value":{"type":"string","description":"Parameter value","example":"10"}}}}}}},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal"},"amount":{"type":"string","description":"Discount amount","example":"10"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"}]},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}}}}}}},{"required":["phases"],"type":"null","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1"},{"type":"null","description":"Phase name","example":"Year 1"}]},"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"}]},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string"}}},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string"}}},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string"}}},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages"}]},"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null"}]},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string"}}},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string"}}}]},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}}]},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14"},"value":{"type":"string","description":"Parameter value","example":"10"}}}}}}},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal"},"amount":{"type":"string","description":"Discount amount","example":"10"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"}]},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}}}}}}}]},"amended":{"oneOf":[{"required":["phases"],"type":"object","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1"},{"type":"null","description":"Phase name","example":"Year 1"}]},"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"}]},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string"}}},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string"}}},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string"}}},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages"}]},"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null"}]},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string"}}},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string"}}}]},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}}]},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14"},"value":{"type":"string","description":"Parameter value","example":"10"}}}}}}},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal"},"amount":{"type":"string","description":"Discount amount","example":"10"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"}]},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}}}}}}},{"required":["phases"],"type":"null","description":"Read-only. A billing schedule's phases. `original` is the schedule before this amendment; `amended` is the schedule once this amendment takes effect, from appliedFrom once it's executed.","example":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"properties":{"phases":{"type":"array","description":"The schedule's phases, in start date order","example":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}],"items":{"required":["discounts","minimums","prices","startDate"],"type":"object","example":{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]},"properties":{"name":{"oneOf":[{"type":"string","description":"Phase name","example":"Year 1"},{"type":"null","description":"Phase name","example":"Year 1"}]},"startDate":{"type":"string","description":"The date the phase starts","example":"2022-01-01"},"endDate":{"oneOf":[{"type":"string","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"},{"type":"null","description":"The date the phase ends, or absent when the phase is open-ended","example":"2022-12-31"}]},"prices":{"type":"array","description":"The prices billed in the phase","example":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"items":{"required":["billingFrequency","billingType","customMetricParameters","name","productId","structure"],"type":"object","example":{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]},"properties":{"productId":{"type":"string","description":"The related product ID","example":"e007e884-5100-4183-8355-4771865cb4dd"},"name":{"type":"string","description":"The customer-facing name of this price","example":"API calls"},"structure":{"oneOf":[{"type":"object","required":["pricingType","price"],"example":{"price":"150.00","pricingType":"ONE_TIME"},"properties":{"price":{"example":"150.00","description":"A fixed amount that is charged once.","type":"string","nullable":false},"pricingType":{"enum":["ONE_TIME"],"example":"ONE_TIME","type":"string"}}},{"type":"object","required":["pricingType","price"],"example":{"price":"20.00","pricingType":"FIXED"},"properties":{"price":{"example":"20.00","description":"A fixed amount that is charged once every billing period.","type":"string","nullable":false},"pricingType":{"enum":["FIXED"],"example":"FIXED","type":"string"}}},{"type":"object","required":["pricingType","isPricePercentage","pricePerUnit","usageMetricId"],"example":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"properties":{"pricePerUnit":{"example":"0.25","description":"The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"Usage metric associated to this pricing structure","type":"string","nullable":false},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"pricingType":{"enum":["LINEAR"],"example":"LINEAR","type":"string"}}},{"type":"object","required":["pricingType","contractedMinimumSeats","pricePerSeat","prorationStrategy","seatMetricId","tiers"],"example":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"properties":{"seatMetricId":{"example":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","description":"Seat metric associated to this pricing structure","type":"string","nullable":false},"pricePerSeat":{"example":"0.25","description":"Price charged per seat per full billing period","type":"string","nullable":false},"prorationStrategy":{"example":"USE_MAXIMUM","enum":["USE_MAXIMUM","PRORATE_INCREMENTS","PRORATE_ALL_CHANGES"],"type":"string","nullable":false,"description":"The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added"},"contractedMinimumSeats":{"example":10,"description":"The number of contractually agreed minimum seats","type":"integer","nullable":false},"overagesBillingFrequency":{"oneOf":[{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"string","description":"The frequency with which to charge overages"},{"example":"YEARLY","enum":["NONE","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"type":"null","description":"The frequency with which to charge overages"}]},"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00"},"type":"object","required":["price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"prorateFlatFees":{"oneOf":[{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"boolean"},{"example":false,"description":"If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency","type":"null"}]},"pricingType":{"enum":["SEAT_BASED"],"example":"SEAT_BASED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageCalculationMode","usageMetricId"],"example":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"200","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":false,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false}},"example":{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this pricing structure","type":"string","nullable":false},"usageCalculationMode":{"example":"BILLING_PERIOD","enum":["BILLING_PERIOD","CUMULATIVE","PERIODIC"],"type":"string","nullable":false,"description":"Indicates the scope of usage calculation"},"pricingType":{"enum":["GRADUATED"],"example":"GRADUATED","type":"string"}}},{"type":"object","required":["pricingType","tiers","usageMetricId"],"example":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"properties":{"tiers":{"items":{"properties":{"upperBound":{"oneOf":[{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"string"},{"example":"100","description":"The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.","type":"null"}]},"price":{"example":"1.00","description":"The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.","type":"string","nullable":false},"fee":{"oneOf":[{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"string"},{"example":"50.00","description":"The nominal fee associated with usage at this tier","type":"null"}]},"isPricePercentage":{"example":true,"description":"Indicate whether the price attribute is to be considered as a percentage or an absolute value.","type":"boolean","nullable":false},"maxPrice":{"oneOf":[{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"10","description":"Maximum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]},"minPrice":{"oneOf":[{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"string"},{"example":"5","description":"Minimum Price to Charge for each Unit if Price is Percentage Based","type":"null"}]}},"example":{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},"type":"object","required":["isPricePercentage","price"]},"example":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"description":"A list of contiguous pricing tiers","type":"array","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["VOLUME"],"example":"VOLUME","type":"string"}}},{"type":"object","required":["pricingType","packageSize","pricePerPackage","usageMetricId"],"example":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"properties":{"packageSize":{"example":"50","description":"The amount of usage allowed for the price in this structure","type":"string","nullable":false},"pricePerPackage":{"example":"2.00","description":"The price charged for each package","type":"string","nullable":false},"usageMetricId":{"example":"04c62961-04ba-48e6-b985-758bb7d3e712","description":"The usage metric associated to this tier","type":"string","nullable":false},"pricingType":{"enum":["PACKAGE"],"example":"PACKAGE","type":"string"}}}]},"billingFrequency":{"type":"string","example":"MONTHLY","enum":["ON_DEMAND","ONE_TIME","MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY","PER_EVENT"],"description":"The recurrence of charging this price"},"billingType":{"type":"string","example":"IN_ARREARS","enum":["IN_ARREARS","IN_ADVANCE"],"description":"How to bill this price: in-arrears or in-advance"},"usageCalculationPeriod":{"oneOf":[{"required":["frequency","interval"],"type":"object","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}},{"required":["frequency","interval"],"type":"null","description":"The period over which usage is aggregated, for graduated prices with a usage calculation mode of 'PERIODIC'","example":{"frequency":"MONTHLY","interval":1},"properties":{"frequency":{"type":"string","example":"MONTHLY","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"description":"Frequency determines the time period over which usage is aggregated."},"interval":{"type":"integer","description":"Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.","format":"int32","example":1}}}]},"customMetricParameters":{"type":"array","description":"Specific parameters to influence usage calculation for this price","example":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"items":{"required":["parameterId","value"],"type":"object","example":{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"},"properties":{"parameterId":{"type":"string","description":"Custom metric parameter ID","example":"2963e49a-c8e0-4673-89f5-7a805c0faf14"},"value":{"type":"string","description":"Parameter value","example":"10"}}}}}}},"discounts":{"type":"array","description":"The discounts applied in the phase","example":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","discountCalculationType","message","productIds"],"type":"object","example":{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"discountCalculationType":{"type":"string","example":"PERCENTAGE","enum":["PERCENTAGE","NOMINAL"],"description":"Indicates whether the discount amount is percentage or nominal"},"amount":{"type":"string","description":"Discount amount","example":"10"},"message":{"type":"string","description":"Message to appear on the quote or invoice","example":"10% off API calls"},"seatDiscountType":{"oneOf":[{"type":"string","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"},{"type":"null","example":"ALL_SEATS","enum":["INCLUDED_SEATS_ONLY","OVERAGE_SEATS_ONLY","ALL_SEATS"],"description":"Determines how the discount is applied to any seat-based prices"}]},"productIds":{"type":"array","description":"Products of the prices the discount is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}},"minimums":{"type":"array","description":"The minimum commitments applied in the phase","example":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"items":{"required":["amount","productIds"],"type":"object","example":{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]},"properties":{"amount":{"type":"string","description":"Minimum commitment amount","example":"500"},"productIds":{"type":"array","description":"Products of the prices the minimum is restricted to. Empty means every price in the phase.","example":["e007e884-5100-4183-8355-4771865cb4dd"],"items":{"type":"string"}}}}}}}}}}]},"originalContractValue":{"oneOf":[{"type":"string","description":"Read-only. The total contract value before this amendment.","example":"12000"},{"type":"null","description":"Read-only. The total contract value before this amendment.","example":"12000"}]},"amendedContractValue":{"oneOf":[{"type":"string","description":"Read-only. The total contract value of this quote.","example":"15500"},{"type":"null","description":"Read-only. The total contract value of this quote.","example":"15500"}]},"adjustmentTotal":{"oneOf":[{"type":"string","description":"Read-only. The amended contract value minus the original contract value.","example":"3500"},{"type":"null","description":"Read-only. The amended contract value minus the original contract value.","example":"3500"}]},"supersededByQuoteId":{"oneOf":[{"type":"string","description":"Read-only. Another quote for the same billing schedule that was executed after this quote was linked to it. This quote is now out of date.","example":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b"},{"type":"null","description":"Read-only. Another quote for the same billing schedule that was executed after this quote was linked to it. This quote is now out of date.","example":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b"}]},"outForSignatureQuoteId":{"oneOf":[{"type":"string","description":"Read-only. Another quote for the same billing schedule that is out for signature, or accepted but not yet executed.","example":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c"},{"type":"null","description":"Read-only. Another quote for the same billing schedule that is out for signature, or accepted but not yet executed.","example":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c"}]}},"uniqueKey":"amendment.oneOf.1","typeLabel":"null"}],"uniqueKey":"amendment","typeLabel":"object | null"},"preliminaryBillingStartDate":{"oneOf":[{"type":"string","description":"Preliminary start date of contract","example":"2022-10-01","uniqueKey":"preliminaryBillingStartDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preliminary start date of contract","example":"2022-10-01","uniqueKey":"preliminaryBillingStartDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"preliminaryBillingStartDate","typeLabel":"string | null"},"expiresAt":{"oneOf":[{"type":"string","description":"Date when quote expires","example":"2022-10-01","uniqueKey":"expiresAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Date when quote expires","example":"2022-10-01","uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiresAt","typeLabel":"string | null"},"publishedAt":{"oneOf":[{"type":"string","description":"Timestamp when quote was published. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"publishedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when quote was published. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"publishedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"publishedAt","typeLabel":"string | null"},"readyToSignAt":{"oneOf":[{"type":"string","description":"Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"readyToSignAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"readyToSignAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"readyToSignAt","typeLabel":"string | null"},"acceptedAt":{"oneOf":[{"type":"string","description":"Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"acceptedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"acceptedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"acceptedAt","typeLabel":"string | null"},"executedAt":{"oneOf":[{"type":"string","description":"Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"executedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.","example":"2022-06-28T16:47:00Z","uniqueKey":"executedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"executedAt","typeLabel":"string | null"},"createdFrom":{"oneOf":[{"required":["entityId","entityType"],"type":"object","description":"Entity from which this quote was created","example":{"entityType":"QUOTE","entityId":"dc0e2104-7df5-4fc1-8f65-1823f427d111"},"properties":{"entityType":{"type":"string","example":"QUOTE","enum":["BILLING_SCHEDULE","BILLING_SCHEDULE_DISCOUNT","BILLING_SCHEDULE_MINIMUM","BILLING_SCHEDULE_PHASE","BILLING_SCHEDULE_PRICE","CONTACT","CREDIT_NOTE","CREDIT_NOTE_APPLICATION","CUSTOMER","FILE","INVOICE","LEDGER_ACCOUNT","LIST_PRICE","PAYMENT","PAYMENT_APPLICATION","PRICE","PRODUCT","QUOTE","QUOTE_DISCOUNT","QUOTE_MINIMUM","QUOTE_PHASE","QUOTE_PRICE","QUOTE_TEMPLATE_PRICE","TAX_CATEGORY","TAX_CODE"],"isRequired":true,"uniqueKey":"createdFrom.oneOf.0.entityType","typeLabel":"enum\u003cstring>"},"entityId":{"type":"string","example":"dc0e2104-7df5-4fc1-8f65-1823f427d111","isRequired":true,"uniqueKey":"createdFrom.oneOf.0.entityId","typeLabel":"string"}},"uniqueKey":"createdFrom.oneOf.0","typeLabel":"object"},{"required":["entityId","entityType"],"type":"null","description":"Entity from which this quote was created","example":{"entityType":"QUOTE","entityId":"dc0e2104-7df5-4fc1-8f65-1823f427d111"},"properties":{"entityType":{"type":"string","example":"QUOTE","enum":["BILLING_SCHEDULE","BILLING_SCHEDULE_DISCOUNT","BILLING_SCHEDULE_MINIMUM","BILLING_SCHEDULE_PHASE","BILLING_SCHEDULE_PRICE","CONTACT","CREDIT_NOTE","CREDIT_NOTE_APPLICATION","CUSTOMER","FILE","INVOICE","LEDGER_ACCOUNT","LIST_PRICE","PAYMENT","PAYMENT_APPLICATION","PRICE","PRODUCT","QUOTE","QUOTE_DISCOUNT","QUOTE_MINIMUM","QUOTE_PHASE","QUOTE_PRICE","QUOTE_TEMPLATE_PRICE","TAX_CATEGORY","TAX_CODE"]},"entityId":{"type":"string","example":"dc0e2104-7df5-4fc1-8f65-1823f427d111"}},"uniqueKey":"createdFrom.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdFrom","typeLabel":"object | null"},"salesforceOpportunityId":{"oneOf":[{"type":"string","description":"Salesforce ID of the opportunity that created this quote","example":"006Hr00001MfnEIIAZ","uniqueKey":"salesforceOpportunityId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Salesforce ID of the opportunity that created this quote","example":"006Hr00001MfnEIIAZ","uniqueKey":"salesforceOpportunityId.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesforceOpportunityId","typeLabel":"string | null"},"expiryDays":{"oneOf":[{"type":"integer","description":"Number of days after publishing in which quote will expire","format":"int32","example":30,"uniqueKey":"expiryDays.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Number of days after publishing in which quote will expire","format":"int32","example":30,"uniqueKey":"expiryDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiryDays","typeLabel":"integer\u003cint32> | null"},"archivedAt":{"oneOf":[{"type":"string","description":"Date and time the quote was archived","example":"2022-06-28T16:47:00Z","uniqueKey":"archivedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Date and time the quote was archived","example":"2022-06-28T16:47:00Z","uniqueKey":"archivedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"archivedAt","typeLabel":"string | null"},"approvalWorkflowId":{"oneOf":[{"type":"string","description":"The ID of the active approval workflow for this quote, if one is in progress","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"approvalWorkflowId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the active approval workflow for this quote, if one is in progress","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"approvalWorkflowId.oneOf.1","typeLabel":"null"}],"uniqueKey":"approvalWorkflowId","typeLabel":"string | null"},"customerLegalName":{"oneOf":[{"type":"string","description":"Customer legal name","example":"Acme Corp","uniqueKey":"customerLegalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Customer legal name","example":"Acme Corp","uniqueKey":"customerLegalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerLegalName","typeLabel":"string | null"},"customerAddress":{"oneOf":[{"required":["country","line1","postcode","town"],"type":"object","example":{"line1":"1 Market Street","line2":"Suite 100","town":"San Francisco","state":"CA","postcode":"94105","country":"US"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"1 Market Street","isRequired":true,"uniqueKey":"customerAddress.oneOf.0.line1","typeLabel":"string"},"town":{"type":"string","description":"Town or city","example":"San Francisco","isRequired":true,"uniqueKey":"customerAddress.oneOf.0.town","typeLabel":"string"},"postcode":{"type":"string","description":"Postal code","example":"94105","isRequired":true,"uniqueKey":"customerAddress.oneOf.0.postcode","typeLabel":"string"},"country":{"type":"string","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))","isRequired":true,"uniqueKey":"customerAddress.oneOf.0.country","typeLabel":"enum\u003cstring>"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"Suite 100","uniqueKey":"customerAddress.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2","example":"Suite 100","uniqueKey":"customerAddress.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerAddress.oneOf.0.line2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"customerAddress.oneOf.0.state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)","uniqueKey":"customerAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerAddress.oneOf.0.state","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"customerAddress.oneOf.0","typeLabel":"object"},{"required":["country","line1","postcode","town"],"type":"null","example":{"line1":"1 Market Street","line2":"Suite 100","town":"San Francisco","state":"CA","postcode":"94105","country":"US"},"properties":{"line1":{"type":"string","description":"Address line 1","example":"1 Market Street"},"line2":{"oneOf":[{"type":"string","description":"Address line 2","example":"Suite 100"},{"type":"null","description":"Address line 2","example":"Suite 100"}]},"town":{"type":"string","description":"Town or city","example":"San Francisco"},"state":{"oneOf":[{"type":"string","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"},{"type":"null","example":"CA","enum":["AL","AK","AZ","AR","CA","CO","CT","DC","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","AB","BC","MB","NB","NL","NS","NT","NU","ON","PE","QC","SK","YT"],"description":"State or province (required for USA and Canada)"}]},"postcode":{"type":"string","description":"Postal code","example":"94105"},"country":{"type":"string","example":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"],"description":"Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))"}},"uniqueKey":"customerAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerAddress","typeLabel":"object | null"},"defaultDueDateDays":{"oneOf":[{"type":"integer","description":"Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.","example":30,"uniqueKey":"defaultDueDateDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.","example":30,"uniqueKey":"defaultDueDateDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultDueDateDays","typeLabel":"integer | null"},"signatureMode":{"oneOf":[{"type":"string","example":"EMBEDDED","enum":["EMBEDDED","NON_EMBEDDED"],"description":"The signature mode used when the quote is published. Can be EMBEDDED, NON_EMBEDDED. It is null if the quote is a draft or if e-signatures are disabled for the quote.","uniqueKey":"signatureMode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"EMBEDDED","enum":["EMBEDDED","NON_EMBEDDED"],"description":"The signature mode used when the quote is published. Can be EMBEDDED, NON_EMBEDDED. It is null if the quote is a draft or if e-signatures are disabled for the quote.","uniqueKey":"signatureMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"signatureMode","typeLabel":"enum\u003cstring> | null"},"preparingSignatureRequestAt":{"oneOf":[{"type":"string","description":"Timestamp when quote ready-to-sign operation was triggered.","example":"2022-06-28T16:47:00Z","uniqueKey":"preparingSignatureRequestAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when quote ready-to-sign operation was triggered.","example":"2022-06-28T16:47:00Z","uniqueKey":"preparingSignatureRequestAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"preparingSignatureRequestAt","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"PublicQuoteApiResponse":{"title":"PublicQuoteApiResponse","value":{"id":"678ca125-8bc3-478f-9a96-6ba73605cf1e","createdBy":"4ffd439e-32e5-4046-bb40-3cb81f40e5da","customerId":"377bf97b-ca1d-4538-be06-4022afa6bde3","quoteNumber":"Q00001","title":"My quote","currency":"GBP","status":"EXECUTED","dealType":"AMENDMENT","amendment":{"billingScheduleId":"0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b","effectiveFrom":"2022-11-01","executableUntil":"2022-11-01","appliedFrom":"2022-11-01","original":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"amended":{"phases":[{"name":"Year 1","startDate":"2022-01-01","endDate":"2022-12-31","prices":[{"productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"API calls","structure":{"tiers":[{"upperBound":"1000","price":"0.25","fee":"50","isPricePercentage":false},{"price":"0.1","fee":"0","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"PERIODIC","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1},"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}]}],"discounts":[{"discountCalculationType":"PERCENTAGE","amount":"10","message":"10% off API calls","seatDiscountType":"ALL_SEATS","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}],"minimums":[{"amount":"500","productIds":["e007e884-5100-4183-8355-4771865cb4dd"]}]}]},"originalContractValue":"12000","amendedContractValue":"15500","adjustmentTotal":"3500","supersededByQuoteId":"0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b","outForSignatureQuoteId":"0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c"},"preliminaryBillingStartDate":"2022-10-01","expiresAt":"2022-10-01","publishedAt":"2022-06-28T16:47:00Z","readyToSignAt":"2022-06-28T16:47:00Z","acceptedAt":"2022-06-28T16:47:00Z","executedAt":"2022-06-28T16:47:00Z","createdAt":"2022-06-28T16:47:00Z","updatedAt":"2022-06-28T16:47:00Z","createdFrom":{"entityType":"QUOTE","entityId":"dc0e2104-7df5-4fc1-8f65-1823f427d111"},"salesforceOpportunityId":"006Hr00001MfnEIIAZ","expiryDays":30,"merchantBranding":{"logoUrl":"logo","legalCompanyName":"Acme Corp","primaryColour":"colour","url":"www.example.com","address":{"line1":"1 Market Street","line2":"Suite 100","town":"San Francisco","state":"CA","postcode":"94105","country":"US"},"email":"accounting@example.com","showUsageInCustomerPortal":true,"supportEmail":"support@example.com","supportUrl":"https://www.example.com/support"},"phases":[{"id":"abe4bf01-9b75-495d-f5fd-ca82b001f3a8","name":"Onboarding","createdAt":"2022-06-28T16:47:00Z","duration":{"days":-1,"weeks":0,"months":6,"years":1},"prices":[{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"150.00","pricingType":"ONE_TIME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"price":"20.00","pricingType":"FIXED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"pricePerUnit":"0.25","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","isPricePercentage":false,"pricingType":"LINEAR"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"seatMetricId":"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730","pricePerSeat":"0.25","prorationStrategy":"USE_MAXIMUM","contractedMinimumSeats":10,"overagesBillingFrequency":"YEARLY","tiers":[{"upperBound":"100","price":"1.00","fee":"50.00"},{"price":"0.75","fee":"25.00"}],"prorateFlatFees":false,"pricingType":"SEAT_BASED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"200","price":"1.00","fee":"50.00","isPricePercentage":false},{"upperBound":"400","price":"0.75","fee":"25.00","isPricePercentage":false},{"price":"0.50","fee":"0.00","isPricePercentage":false}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","usageCalculationMode":"BILLING_PERIOD","pricingType":"GRADUATED"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100","usageCalculationPeriod":{"frequency":"MONTHLY","interval":1}},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"tiers":[{"upperBound":"100","price":"1.00","fee":"50.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"},{"price":"0.75","fee":"25.00","isPricePercentage":true,"maxPrice":"10","minPrice":"5"}],"usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"VOLUME"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"},{"id":"5100e884-e007-4183-8355-4771865cb4d7","productId":"e007e884-5100-4183-8355-4771865cb4dd","name":"Sample product","structure":{"packageSize":"50","pricePerPackage":"2.00","usageMetricId":"04c62961-04ba-48e6-b985-758bb7d3e712","pricingType":"PACKAGE"},"billingFrequency":"MONTHLY","billingType":"IN_ARREARS","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","integrationIds":[{"service":"Xero","id":"123","isPending":false}],"customMetricParameters":[{"parameterId":"2963e49a-c8e0-4673-89f5-7a805c0faf14","value":"10"}],"listPriceId":"b4d7e884-e007-4183-8355-4771865c5100"}],"discounts":[{"id":"018f920a-40d1-7e62-91ca-f3a4b4ac5d9d","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"amount":"50","discountCalculationType":"PERCENTAGE","message":"message","createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z","seatDiscountType":"ALL_SEATS"}],"minimums":[{"id":"018f9164-c2d9-7eb2-bb98-11ecb5454055","amount":"50","restrictToPrices":["5100e884-e007-4183-8355-4771865cb4d7"],"createdAt":"2021-08-25T12:00:00Z","updatedAt":"2021-08-25T12:00:00Z"}]}],"archivedAt":"2022-06-28T16:47:00Z","approvalWorkflowId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","contactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"],"contacts":[{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"ccContactIds":["9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd"],"ccContacts":[{"contactId":"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd","name":"John Smith","email":"john@example.com","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"counterSigners":[{"id":"0190da0c-980d-7fa2-9b65-4c79784a95b1","name":"Jane Doe","email":"jane@example.com","signedAt":"2022-06-28T16:47:00Z","notificationHistory":[{"notifiedAt":"2022-06-28T16:47:00Z","trigger":"PUBLISH"}]}],"isSignaturesEnabled":false,"integrationIds":[{"service":"Salesforce","id":"a00Hr00001BiFbjIAF","isPending":false}],"customerLegalName":"Acme Corp","customerAddress":{"line1":"1 Fake Street","line2":"Fakesville","town":"Faketown","state":"CA","postcode":"F4KE","country":"US"},"pdfStatus":"NOT_YET_REQUESTED","attachmentAssets":[{"id":"e007e884-5100-4183-8355-4771865cb4dd","createdBy":"94703530-1293-479b-bd37-ccad42fd9c8b","createdByType":"SEQUENCE_USER","type":"IMAGE","format":"PNG","fileName":"my-image.png","fileSizeBytes":12345,"url":"https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png","createdAt":"2022-06-28T16:47:00Z"}],"isExpired":false,"defaultDueDateDays":30,"signatureMode":"EMBEDDED","preparingSignatureRequestAt":"2022-06-28T16:47:00Z","activeErrors":[{"id":"0190b1f2-1234-7000-8000-000000000001","errorCode":"DROPBOX_SIGNATURE_REQUEST_REJECTED","recoveryAction":"CONTACT_SUPPORT","createdAt":"2022-06-28T16:47:00Z","errorContext":{}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"be8e74f0-a201-43c3-8f1c-babd2a1c22d4":{"description":"Bad Request","content":{},"exampleType":"generated"},"490e4d03-d933-4c4f-9faa-09bb87f55356":{"description":"Unauthorized","content":{},"exampleType":"generated"},"ee5471f1-43bd-4cb5-a4e8-c8d8b2ae8b9d":{"description":"Not Found","content":{},"exampleType":"generated"},"adde371e-d649-4f8f-b56f-20e43bd2d03e":{"description":"Internal Server Error","content":{},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"open-api-schema/2024-07-30/quote.2024-07-30.product.live.json"},"subdomain":"sequence","siteName":"Sequence","title":"Update one of your quotes - Sequence","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T13:54:24.211Z","originalFileLocation":"reference/2024-07-30/quote/update-one-of-your-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=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a quote including its phases\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sequence\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_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/sequence/4AxtUIMpbcFOrkSv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update one of your quotes - Sequence\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a quote including its phases\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sequence\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sequence.mintlify.app/_mintlify/api/og/v2?division=Quotes\u0026amp;title=Update+one+of+your+quotes\u0026amp;description=Update+a+quote+including+its+phases\u0026amp;theme=9a5e862c56c084d213b04486\u0026amp;signature=e227382fc028557021b5eac9fbd067eaf64dc0cf6a7db0b2f5d35ed83101ad4a\">\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=\"Update one of your quotes - Sequence\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a quote including its phases\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sequence.mintlify.app/_mintlify/api/og/v2?division=Quotes\u0026amp;title=Update+one+of+your+quotes\u0026amp;description=Update+a+quote+including+its+phases\u0026amp;theme=9a5e862c56c084d213b04486\u0026amp;signature=e227382fc028557021b5eac9fbd067eaf64dc0cf6a7db0b2f5d35ed83101ad4a\">\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/sequence/4AxtUIMpbcFOrkSv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sequence\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#716FFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/2024-07-30/quote/update-one-of-your-quotes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sequencehq.com/#organization\",\"name\":\"Sequence\",\"url\":\"https://docs.sequencehq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sequence/bptUiZLY1oEfBaTZ/logo/light.svg?fit=max\u0026auto=format\u0026n=bptUiZLY1oEfBaTZ\u0026q=85\u0026s=02adc18f83942b8bdc86ec2b67937e1a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sequencehq.com#website\",\"name\":\"Sequence\",\"url\":\"https://docs.sequencehq.com\",\"publisher\":{\"@id\":\"https://docs.sequencehq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes#webpage\",\"url\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes\",\"name\":\"Update one of your quotes\",\"description\":\"Update a quote including its phases\",\"dateModified\":\"2026-10-21T13:54:24.211Z\",\"isPartOf\":{\"@id\":\"https://docs.sequencehq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Version 2024-07-30\",\"item\":\"https://docs.sequencehq.com/reference/2024-07-30/account/get-a-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quote\",\"item\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/get-quote-analytics\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Quotes\",\"item\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/get-quote-analytics\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update one of your quotes\",\"item\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes#apireference\",\"headline\":\"Update one of your quotes\",\"name\":\"Update one of your quotes\",\"description\":\"Update a quote including its phases\",\"url\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sequencehq.com/reference/2024-07-30/quote/update-one-of-your-quotes#webpage\"},\"dateModified\":\"2026-10-21T13:54:24.211Z\",\"publisher\":{\"@id\":\"https://docs.sequencehq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sequencehq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sequence\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sequence","nav":{"global":{"anchors":[{"anchor":"Speak to an expert","icon":"message-check","href":"https://access.sequencehq.com/"},{"anchor":"Changelog","icon":"bolt","href":"https://www.sequencehq.com/changelog"},{"anchor":"Blog","icon":"rss","href":"https://www.sequencehq.com/blog"},{"anchor":"Principles","icon":"bookmark","href":"https://www.sequencehq.com/principles"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/getting-started/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Getting Started","href":"/reference/gettingStarted"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Versioning","href":"/reference/versioning"},{"title":"Changes","href":"/reference/changes"},{"group":"Webhooks","pages":[{"title":"Set up webhooks","href":"/reference/webhooks"},{"title":"Webhook events","href":"/reference/webhook-events"}]}]},{"group":"Latest Live API","pages":[{"group":"Account","pages":[{"group":"Users","pages":[{"openapi":"account.latest.product.live GET /users/{id}","title":"Get a user","href":"/reference/latest/account/get-a-user"},{"openapi":"account.latest.product.live DELETE /users/{id}","title":"Delete User","href":"/reference/latest/account/delete-user"},{"openapi":"account.latest.product.live GET /users","title":"List all Users","href":"/reference/latest/account/list-all-users"}]},{"group":"Accounts","pages":[{"openapi":"account.latest.product.live GET /sequence-accounts","title":"List your accounts","href":"/reference/latest/account/list-your-accounts"},{"openapi":"account.latest.product.live GET /sequence-accounts/{id}","title":"Get your account","href":"/reference/latest/account/get-your-account"},{"openapi":"account.latest.product.live PUT /sequence-accounts/{id}","title":"Update Account","href":"/reference/latest/account/update-account"}]}]},{"group":"Activity Stream","pages":[{"group":"Activities","pages":[{"openapi":"activity-stream.latest.product.live GET /activity-logs/{id}","title":"Get an Activity Log by ID","href":"/reference/latest/activity-stream/get-an-activity-log-by-id"},{"openapi":"activity-stream.latest.product.live GET /activity-logs","title":"List all Activity Logs","href":"/reference/latest/activity-stream/list-all-activity-logs"}]}]},{"group":"Billing","pages":[{"group":"Prices","pages":[{"openapi":"billing.latest.product.live GET /prices","title":"List all Prices","href":"/reference/latest/billing/list-all-prices"},{"openapi":"billing.latest.product.live POST /prices","title":"Create a new Price","href":"/reference/latest/billing/create-a-new-price"},{"openapi":"billing.latest.product.live GET /billing-products","title":"List all billing products","href":"/reference/latest/billing/list-all-billing-products"},{"openapi":"billing.latest.product.live GET /prices/{id}","title":"Get a Price by ID","href":"/reference/latest/billing/get-a-price-by-id"},{"openapi":"billing.latest.product.live PUT /prices/{id}","title":"Update a Price","href":"/reference/latest/billing/update-a-price"},{"openapi":"billing.latest.product.live DELETE /prices/{id}","title":"Delete a Price","href":"/reference/latest/billing/delete-a-price"}]},{"group":"Credits","pages":[{"openapi":"billing.latest.product.live GET /credits","title":"List customer credit grants","href":"/reference/latest/billing/list-customer-credit-grants"},{"openapi":"billing.latest.product.live POST /credits","title":"Create a new credit grant","href":"/reference/latest/billing/create-a-new-credit-grant"},{"openapi":"billing.latest.product.live GET /credits/{id}","title":"Get a customer credit grant","href":"/reference/latest/billing/get-a-customer-credit-grant"},{"openapi":"billing.latest.product.live DELETE /credits/{id}","title":"Delete a credit grant","href":"/reference/latest/billing/delete-a-credit-grant"},{"openapi":"billing.latest.product.live GET /credits/{customerId}/grants","title":"List Credit Grants for a customer","href":"/reference/latest/billing/list-credit-grants-for-a-customer"},{"openapi":"billing.latest.product.live GET /credit-grants","title":"List credit grants","href":"/reference/latest/billing/list-credit-grants"},{"openapi":"billing.latest.product.live POST /credit-grants","title":"Create a customer credit grant","href":"/reference/latest/billing/create-a-customer-credit-grant"},{"openapi":"billing.latest.product.live GET /credits/{customerId}/balances","title":"List Credit Balances for a customer","href":"/reference/latest/billing/list-credit-balances-for-a-customer"},{"openapi":"billing.latest.product.live GET /credit-grants/{id}","title":"Get a credit grant","href":"/reference/latest/billing/get-a-credit-grant"}]},{"group":"Billing Schedules","pages":[{"openapi":"billing.latest.product.live GET /billing-schedules/{billingScheduleId}","title":"Get Billing Schedule","href":"/reference/latest/billing/get-billing-schedule"},{"openapi":"billing.latest.product.live PUT /billing-schedules/{billingScheduleId}","title":"Update Billing Schedule","href":"/reference/latest/billing/update-billing-schedule"},{"openapi":"billing.latest.product.live GET /billing-schedules","title":"List all Billing Schedules","href":"/reference/latest/billing/list-all-billing-schedules"},{"openapi":"billing.latest.product.live POST /billing-schedules","title":"Create Billing Schedule","href":"/reference/latest/billing/create-billing-schedule"},{"openapi":"billing.latest.product.live GET /billing-schedule-custom-field-keys","title":"List Billing Schedule Custom Field Keys","href":"/reference/latest/billing/list-billing-schedule-custom-field-keys"},{"openapi":"billing.latest.product.live POST /billing-schedules/{billingScheduleId}/duplicate","title":"Duplicate a billing schedule","href":"/reference/latest/billing/duplicate-a-billing-schedule"},{"openapi":"billing.latest.product.live POST /billing-schedules/{billingScheduleId}/archive","title":"Archive Billing Schedule","href":"/reference/latest/billing/archive-billing-schedule"},{"openapi":"billing.latest.product.live PUT /billing-schedules/{billingScheduleId}/activate","title":"Activate Billing Schedule","href":"/reference/latest/billing/activate-billing-schedule"},{"openapi":"billing.latest.product.live POST /billing-schedules/validate-taxes","title":"Validate taxes on a billing schedule","href":"/reference/latest/billing/validate-taxes-on-a-billing-schedule"}]},{"group":"Discounts","pages":[{"openapi":"billing.latest.product.live GET /discounts/{id}","title":"Get a discount by ID","href":"/reference/latest/billing/get-a-discount-by-id"},{"openapi":"billing.latest.product.live PUT /discounts/{id}","title":"Update a discount","href":"/reference/latest/billing/update-a-discount"},{"openapi":"billing.latest.product.live DELETE /discounts/{id}","title":"Delete a discount","href":"/reference/latest/billing/delete-a-discount"},{"openapi":"billing.latest.product.live GET /discounts","title":"List all discounts","href":"/reference/latest/billing/list-all-discounts"}]}]},{"group":"Collections","pages":[{"group":"Invoices","pages":[{"openapi":"collections.latest.product.live GET /payments/settings/invoices/{id}","title":"Get invoice payment settings","href":"/reference/latest/collections/get-invoice-payment-settings"},{"openapi":"collections.latest.product.live PUT /payments/settings/invoices/{id}","title":"Update invoice payment settings","href":"/reference/latest/collections/update-invoice-payment-settings"},{"openapi":"collections.latest.product.live DELETE /payments/settings/invoices/{id}","title":"Delete invoice payment settings","href":"/reference/latest/collections/delete-invoice-payment-settings"},{"openapi":"collections.latest.product.live GET /payments/settings/invoices/for-invoice/{id}","title":"Get invoice payment settings by invoice ID","href":"/reference/latest/collections/get-invoice-payment-settings-by-invoice-id"},{"openapi":"collections.latest.product.live POST /payments/settings/invoices","title":"Create invoice payment settings","href":"/reference/latest/collections/create-invoice-payment-settings"}]},{"group":"Stripe Collection Settings","pages":[{"openapi":"collections.latest.product.live GET /stripe/collections/settings","title":"Stripe collection settings for Sequence account","href":"/reference/latest/collections/stripe-collection-settings-for-sequence-account"},{"openapi":"collections.latest.product.live PUT /stripe/collections/settings/{id}","title":"Update Stripe collection settings for Sequence account","href":"/reference/latest/collections/update-stripe-collection-settings-for-sequence-account"}]},{"group":"Customers","pages":[{"openapi":"collections.latest.product.live POST /payments/settings/customers","title":"Create customer payment settings","href":"/reference/latest/collections/create-customer-payment-settings"},{"openapi":"collections.latest.product.live GET /payments/settings/customers/{id}","title":"Get customer payment settings","href":"/reference/latest/collections/get-customer-payment-settings"},{"openapi":"collections.latest.product.live PUT /payments/settings/customers/{id}","title":"Update customer payment settings","href":"/reference/latest/collections/update-customer-payment-settings"},{"openapi":"collections.latest.product.live DELETE /payments/settings/customers/{id}","title":"Delete customer payment settings","href":"/reference/latest/collections/delete-customer-payment-settings"}]},{"group":"Billing Schedules","pages":[{"openapi":"collections.latest.product.live GET /payments/settings/billing-schedules/{id}","title":"Get billing schedule payment settings","href":"/reference/latest/collections/get-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live PUT /payments/settings/billing-schedules/{id}","title":"Update billing schedule payment settings","href":"/reference/latest/collections/update-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live DELETE /payments/settings/billing-schedules/{id}","title":"Delete billing schedule payment settings","href":"/reference/latest/collections/delete-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live POST /payments/settings/billing-schedules","title":"Create billing schedule payment settings","href":"/reference/latest/collections/create-billing-schedule-payment-settings"},{"openapi":"collections.latest.product.live GET /payments/settings/billing-schedules/for-billing-schedule/{id}","title":"Get billing schedule payment settings by billing schedule ID","href":"/reference/latest/collections/get-billing-schedule-payment-settings-by-billing-schedule-id"}]},{"group":"Account Settings","pages":[{"openapi":"collections.latest.product.live PUT /payments/settings/{id}","title":"Update payment settings for Sequence account","href":"/reference/latest/collections/update-payment-settings-for-sequence-account"},{"openapi":"collections.latest.product.live GET /payments/settings","title":"Payment settings for Sequence account","href":"/reference/latest/collections/payment-settings-for-sequence-account"}]}]},{"group":"Customer","pages":[{"group":"Contacts","pages":[{"openapi":"customer.latest.product.live PUT /customers/{customer}/contacts/{id}","title":"Update a contact","href":"/reference/latest/customer/update-a-contact"},{"openapi":"customer.latest.product.live GET /customers/{customer}/contacts","title":"List all contacts for a customer","href":"/reference/latest/customer/list-all-contacts-for-a-customer"},{"openapi":"customer.latest.product.live POST /customers/{customer}/contacts","title":"Create a new contact","href":"/reference/latest/customer/create-a-new-contact"},{"openapi":"customer.latest.product.live POST /customers/{customer}/contacts/{id}/archive","title":"Archive a contact","href":"/reference/latest/customer/archive-a-contact"}]},{"group":"Customers","pages":[{"openapi":"customer.latest.product.live GET /customers/{id}","title":"Get customer","href":"/reference/latest/customer/get-customer"},{"openapi":"customer.latest.product.live PUT /customers/{id}","title":"Update customer","href":"/reference/latest/customer/update-customer"},{"openapi":"customer.latest.product.live POST /customers/{id}/archive","title":"Archive customer","href":"/reference/latest/customer/archive-customer"},{"openapi":"customer.latest.product.live GET /customers","title":"List customers","href":"/reference/latest/customer/list-customers"},{"openapi":"customer.latest.product.live POST /customers","title":"Create customer","href":"/reference/latest/customer/create-customer"},{"openapi":"customer.latest.product.live GET /customer-custom-property-keys","title":"List customer custom property keys","href":"/reference/latest/customer/list-customer-custom-property-keys"}]},{"group":"Organizations","pages":[{"openapi":"customer.latest.product.live PUT /customer-organizations/{id}/members","title":"Replace members of a customer organization","href":"/reference/latest/customer/replace-members-of-a-customer-organization"},{"openapi":"customer.latest.product.live POST /customer-organizations/{id}/members","title":"Add a customer to a customer organization","href":"/reference/latest/customer/add-a-customer-to-a-customer-organization"},{"openapi":"customer.latest.product.live POST /customer-organizations","title":"Create a customer organization","href":"/reference/latest/customer/create-a-customer-organization"}]},{"group":"Customer Aliases","pages":[{"openapi":"customer.latest.product.live GET /customers/by-alias/{alias}","title":"Get customer by alias","href":"/reference/latest/customer/get-customer-by-alias"},{"openapi":"customer.latest.product.live PUT /customer-aliases/{id}","title":"Update a Customer Alias","href":"/reference/latest/customer/update-a-customer-alias"},{"openapi":"customer.latest.product.live DELETE /customer-aliases/{id}","title":"Delete a Customer Alias","href":"/reference/latest/customer/delete-a-customer-alias"},{"openapi":"customer.latest.product.live GET /customer-aliases","title":"List all Customer Aliases","href":"/reference/latest/customer/list-all-customer-aliases"},{"openapi":"customer.latest.product.live POST /customer-aliases","title":"Create a new Customer Alias","href":"/reference/latest/customer/create-a-new-customer-alias"},{"openapi":"customer.latest.product.live GET /customers/{id}/aliases","title":"Get Customer Aliases","href":"/reference/latest/customer/get-customer-aliases"}]}]},{"group":"Invoices","pages":[{"group":"Invoice Line Items","pages":[{"openapi":"invoices.latest.product.live PUT /invoices/{invoice}/line-items/{id}","title":"Update a line item","href":"/reference/latest/invoices/update-a-line-item"},{"openapi":"invoices.latest.product.live DELETE /invoices/{invoice}/line-items/{id}","title":"Deletes a Line Item","href":"/reference/latest/invoices/deletes-a-line-item"},{"openapi":"invoices.latest.product.live PUT /invoices/{invoice}/line-item-groups/{id}","title":"Update a Line Item Group","href":"/reference/latest/invoices/update-a-line-item-group"},{"openapi":"invoices.latest.product.live DELETE /invoices/{invoice}/line-item-groups/{id}","title":"Delete a Line Item Group","href":"/reference/latest/invoices/delete-a-line-item-group"},{"openapi":"invoices.latest.product.live GET /invoices/{invoice}/line-item-groups","title":"List all Line Item Groups","href":"/reference/latest/invoices/list-all-line-item-groups"},{"openapi":"invoices.latest.product.live POST /invoices/{invoice}/line-item-groups","title":"Create a new Line Item Group","href":"/reference/latest/invoices/create-a-new-line-item-group"},{"openapi":"invoices.latest.product.live GET /invoices/{invoice}/line-items","title":"List all Line Items","href":"/reference/latest/invoices/list-all-line-items"},{"openapi":"invoices.latest.product.live POST /invoices/{invoice}/line-items","title":"Create a new Line Item","href":"/reference/latest/invoices/create-a-new-line-item"}]},{"group":"Credit Note Line Items","pages":[{"openapi":"invoices.latest.product.live GET /credit-notes/{creditnote}/line-items","title":"List all Credit Note Line Items","href":"/reference/latest/invoices/list-all-credit-note-line-items"},{"openapi":"invoices.latest.product.live POST /credit-notes/{creditnote}/line-items","title":"Create a new Credit Note Line Item","href":"/reference/latest/invoices/create-a-new-credit-note-line-item"},{"openapi":"invoices.latest.product.live PUT /credit-notes/{creditnote}/line-item-groups/{id}","title":"Update a Credit Note Line Item Group","href":"/reference/latest/invoices/update-a-credit-note-line-item-group"},{"openapi":"invoices.latest.product.live DELETE /credit-notes/{creditnote}/line-item-groups/{id}","title":"Delete a Credit Note Line Item Group","href":"/reference/latest/invoices/delete-a-credit-note-line-item-group"},{"openapi":"invoices.latest.product.live GET /credit-notes/{creditnote}/line-item-groups","title":"List all Credit Note Line Item Groups","href":"/reference/latest/invoices/list-all-credit-note-line-item-groups"},{"openapi":"invoices.latest.product.live POST /credit-notes/{creditnote}/line-item-groups","title":"Create a new Credit Note Line Item Group","href":"/reference/latest/invoices/create-a-new-credit-note-line-item-group"},{"openapi":"invoices.latest.product.live PUT /credit-notes/{creditnote}/line-items/{id}","title":"Update a Credit Note Line Item","href":"/reference/latest/invoices/update-a-credit-note-line-item"},{"openapi":"invoices.latest.product.live DELETE /credit-notes/{creditnote}/line-items/{id}","title":"Delete a Credit Note Line Item","href":"/reference/latest/invoices/delete-a-credit-note-line-item"}]},{"group":"Invoices","pages":[{"openapi":"invoices.latest.product.live PATCH /invoices/{id}/sent","title":"Patch a sent invoice","href":"/reference/latest/invoices/patch-a-sent-invoice"},{"openapi":"invoices.latest.product.live GET /invoices/{id}/currency-conversions","title":"List Currency Conversions for an Invoice","href":"/reference/latest/invoices/list-currency-conversions-for-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/mark-as-sent","title":"Finalize and mark invoice as sent without triggering actions except revenue recognition","href":"/reference/latest/invoices/finalize-and-mark-invoice-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.latest.product.live POST /invoices/fix-billing-runs","title":"Fix invoices billing runs","href":"/reference/latest/invoices/fix-invoices-billing-runs"},{"openapi":"invoices.latest.product.live GET /invoices/{id}","title":"Get an Invoice by ID","href":"/reference/latest/invoices/get-an-invoice-by-id"},{"openapi":"invoices.latest.product.live PUT /invoices/{id}","title":"Update an invoice","href":"/reference/latest/invoices/update-an-invoice"},{"openapi":"invoices.latest.product.live DELETE /invoices/{id}","title":"Delete an Invoice","href":"/reference/latest/invoices/delete-an-invoice"},{"openapi":"invoices.latest.product.live PATCH /invoices/{id}","title":"Patch an invoice","href":"/reference/latest/invoices/patch-an-invoice"},{"openapi":"invoices.latest.product.live GET /invoices","title":"List all Invoices","href":"/reference/latest/invoices/list-all-invoices"},{"openapi":"invoices.latest.product.live POST /invoices","title":"Create an invoice","href":"/reference/latest/invoices/create-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/void","title":"Void an Invoice","href":"/reference/latest/invoices/void-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/draft","title":"Convert upcoming invoice to draft","href":"/reference/latest/invoices/convert-upcoming-invoice-to-draft"},{"openapi":"invoices.latest.product.live GET /invoices/list-summary","title":"List Invoice summaries","href":"/reference/latest/invoices/list-invoice-summaries"},{"openapi":"invoices.latest.product.live GET /invoices/summary","title":"Get an invoice summary","href":"/reference/latest/invoices/get-an-invoice-summary"},{"openapi":"invoices.latest.product.live PUT /invoices/{id}/payment-status","title":"Update payment status for an invoice","href":"/reference/latest/invoices/update-payment-status-for-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/finalize-and-send","title":"Finalize and send invoice","href":"/reference/latest/invoices/finalize-and-send-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/send","title":"Send invoice","href":"/reference/latest/invoices/send-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/merge","title":"Merge invoices","href":"/reference/latest/invoices/merge-invoices"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/send-payment-reminder","title":"Send a payment reminder for an invoice","href":"/reference/latest/invoices/send-a-payment-reminder-for-an-invoice"},{"openapi":"invoices.latest.product.live POST /invoices/reconcile-with-integration","title":"Reconcile invoices with external integration","href":"/reference/latest/invoices/reconcile-invoices-with-external-integration"},{"openapi":"invoices.latest.product.live GET /invoices/{id}/download","title":"Download invoice PDF","href":"/reference/latest/invoices/download-invoice-pdf"},{"openapi":"invoices.latest.product.live POST /invoices/{id}/finalize","title":"Finalize invoice","href":"/reference/latest/invoices/finalize-invoice"}]},{"group":"Credit Notes","pages":[{"openapi":"invoices.latest.product.live POST /credit-note-applications","title":"Apply a Credit Note to an Invoice","href":"/reference/latest/invoices/apply-a-credit-note-to-an-invoice"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/void","title":"Void a Credit Note","href":"/reference/latest/invoices/void-a-credit-note"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/finalize","title":"Finalize credit note","href":"/reference/latest/invoices/finalize-credit-note"},{"openapi":"invoices.latest.product.live GET /credit-notes","title":"List all Credit Notes","href":"/reference/latest/invoices/list-all-credit-notes"},{"openapi":"invoices.latest.product.live POST /credit-notes","title":"Create a new Credit Note","href":"/reference/latest/invoices/create-a-new-credit-note"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/send","title":"Send credit note","href":"/reference/latest/invoices/send-credit-note"},{"openapi":"invoices.latest.product.live GET /credit-notes/{id}","title":"Get a Credit Note by ID","href":"/reference/latest/invoices/get-a-credit-note-by-id"},{"openapi":"invoices.latest.product.live PUT /credit-notes/{id}","title":"Update a Credit Note","href":"/reference/latest/invoices/update-a-credit-note"},{"openapi":"invoices.latest.product.live DELETE /credit-notes/{id}","title":"Delete a Credit Note","href":"/reference/latest/invoices/delete-a-credit-note"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/mark-as-sent","title":"Mark credit note as sent without triggering actions except revenue recognition","href":"/reference/latest/invoices/mark-credit-note-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.latest.product.live GET /credit-notes/{id}/download","title":"Download credit note PDF","href":"/reference/latest/invoices/download-credit-note-pdf"},{"openapi":"invoices.latest.product.live POST /credit-notes/{id}/finalize-and-send","title":"Finalize and send credit note","href":"/reference/latest/invoices/finalize-and-send-credit-note"}]},{"group":"Invoice Settings","pages":[{"openapi":"invoices.latest.product.live PUT /invoices/render-settings/{id}","title":"Update an Invoice Render Settings","href":"/reference/latest/invoices/update-an-invoice-render-settings"},{"openapi":"invoices.latest.product.live GET /invoices/render-settings","title":"Get or create Invoice Render Settings","href":"/reference/latest/invoices/get-or-create-invoice-render-settings"}]}]},{"group":"Notifications","pages":[{"group":"Notification Policies","pages":[{"openapi":"notifications.latest.product.live DELETE /notifications/policies/{id}/notification-types/{type}","title":"Remove a notification type from a policy","href":"/reference/latest/notifications/remove-a-notification-type-from-a-policy"},{"openapi":"notifications.latest.product.live POST /notifications/policies/{id}/recipients","title":"Add recipients to a policy","href":"/reference/latest/notifications/add-recipients-to-a-policy"},{"openapi":"notifications.latest.product.live DELETE /notifications/policies/{id}/recipients/{recipient}","title":"Remove a recipient from a policy","href":"/reference/latest/notifications/remove-a-recipient-from-a-policy"},{"openapi":"notifications.latest.product.live GET /notifications/policies/{id}","title":"Get notification policy","href":"/reference/latest/notifications/get-notification-policy"},{"openapi":"notifications.latest.product.live DELETE /notifications/policies/{id}","title":"Delete notification policy","href":"/reference/latest/notifications/delete-notification-policy"},{"openapi":"notifications.latest.product.live GET /notifications/policies","title":"List All Notification Policies","href":"/reference/latest/notifications/list-all-notification-policies"},{"openapi":"notifications.latest.product.live POST /notifications/policies","title":"Create Notification policy","href":"/reference/latest/notifications/create-notification-policy"},{"openapi":"notifications.latest.product.live POST /notifications/policies/{id}/notification-types","title":"Add notification types to a policy","href":"/reference/latest/notifications/add-notification-types-to-a-policy"}]}]},{"group":"Orchestra","pages":[{"group":"Assets","pages":[{"openapi":"orchestra.latest.product.live POST /assets","title":"Upload an asset","href":"/reference/latest/orchestra/upload-an-asset"},{"openapi":"orchestra.latest.product.live GET /assets/{id}","title":"Get an asset","href":"/reference/latest/orchestra/get-an-asset"}]}]},{"group":"Product","pages":[{"group":"Products","pages":[{"openapi":"product.latest.product.live GET /products/{id}","title":"Get a Product by ID","href":"/reference/latest/product/get-a-product-by-id"},{"openapi":"product.latest.product.live PUT /products/{id}","title":"Update a Product","href":"/reference/latest/product/update-a-product"},{"openapi":"product.latest.product.live POST /products/{id}/archive","title":"Archive a product","href":"/reference/latest/product/archive-a-product"},{"openapi":"product.latest.product.live GET /products","title":"List all Products","href":"/reference/latest/product/list-all-products"},{"openapi":"product.latest.product.live POST /products","title":"Create a new Product","href":"/reference/latest/product/create-a-new-product"}]},{"group":"List Prices","pages":[{"openapi":"product.latest.product.live POST /list-prices/{id}/archive","title":"Archive a list price","href":"/reference/latest/product/archive-a-list-price"},{"openapi":"product.latest.product.live GET /list-prices","title":"List all list prices","href":"/reference/latest/product/list-all-list-prices"},{"openapi":"product.latest.product.live POST /list-prices","title":"Create a list price","href":"/reference/latest/product/create-a-list-price"},{"openapi":"product.latest.product.live GET /list-prices/{id}","title":"Get a list price","href":"/reference/latest/product/get-a-list-price"},{"openapi":"product.latest.product.live PUT /list-prices/{id}","title":"Update a list price","href":"/reference/latest/product/update-a-list-price"}]}]},{"group":"Quote","pages":[{"group":"Quotes","pages":[{"openapi":"quote.latest.product.live GET /quotes/{id}/analytics","title":"Get quote analytics","href":"/reference/latest/quote/get-quote-analytics"},{"openapi":"quote.latest.product.live GET /quotes/{id}/published","title":"Get a published quote","href":"/reference/latest/quote/get-a-published-quote"},{"openapi":"quote.latest.product.live POST /quotes/{quoteId}/notify-recipients","title":"Notify selected quote recipients by email","href":"/reference/latest/quote/notify-selected-quote-recipients-by-email"},{"openapi":"quote.latest.product.live POST /quotes/{id}/accept","title":"Accept a published Quote","href":"/reference/latest/quote/accept-a-published-quote"},{"openapi":"quote.latest.product.live POST /quotes/{quoteId}/send-reminders","title":"Send reminder emails to all that have not signed.","href":"/reference/latest/quote/send-reminder-emails-to-all-that-have-not-signed."},{"openapi":"quote.latest.product.live GET /quotes/{id}/download","title":"Download quote PDF","href":"/reference/latest/quote/download-quote-pdf"},{"openapi":"quote.latest.product.live POST /quotes/{id}/publish","title":"Publish a quote","href":"/reference/latest/quote/publish-a-quote"},{"openapi":"quote.latest.product.live GET /quotes/{id}","title":"Get one of your quotes","href":"/reference/latest/quote/get-one-of-your-quotes"},{"openapi":"quote.latest.product.live PUT /quotes/{id}","title":"Update one of your quotes","href":"/reference/latest/quote/update-one-of-your-quotes"},{"openapi":"quote.latest.product.live GET /quotes","title":"List quotes","href":"/reference/latest/quote/list-quotes"},{"openapi":"quote.latest.product.live POST /quotes/{id}/archive","title":"Archive a quote","href":"/reference/latest/quote/archive-a-quote"},{"openapi":"quote.latest.product.live POST /quotes/from-template/{id}","title":"Create a quote from a template","href":"/reference/latest/quote/create-a-quote-from-a-template"}]},{"group":"Quote Templates","pages":[{"openapi":"quote.latest.product.live GET /quote-templates","title":"List quote templates","href":"/reference/latest/quote/list-quote-templates"}]}]},{"group":"Taxes","pages":[{"group":"Tax Registrations","pages":[{"openapi":"taxes.latest.product.live GET /tax-registrations","title":"List all Tax Registrations","href":"/reference/latest/taxes/list-all-tax-registrations"},{"openapi":"taxes.latest.product.live POST /tax-registrations","title":"Create a new Tax Registration","href":"/reference/latest/taxes/create-a-new-tax-registration"},{"openapi":"taxes.latest.product.live GET /tax-registrations/{id}","title":"Get a Tax Registration by ID","href":"/reference/latest/taxes/get-a-tax-registration-by-id"},{"openapi":"taxes.latest.product.live PUT /tax-registrations/{id}","title":"Update a Tax Registration","href":"/reference/latest/taxes/update-a-tax-registration"},{"openapi":"taxes.latest.product.live DELETE /tax-registrations/{id}","title":"Delete a Tax Registration","href":"/reference/latest/taxes/delete-a-tax-registration"},{"openapi":"taxes.latest.product.live GET /tax-registrations/for-merchant/{id}","title":"Get all tax registrations for a merchant by merchant ID","href":"/reference/latest/taxes/get-all-tax-registrations-for-a-merchant-by-merchant-id"},{"openapi":"taxes.latest.product.live GET /tax-registrations/for-customer/{id}","title":"Get all tax registrations for a customer by customer ID","href":"/reference/latest/taxes/get-all-tax-registrations-for-a-customer-by-customer-id"}]},{"group":"Tax Rates","pages":[{"openapi":"taxes.latest.product.live POST /tax-rates/{id}/archive","title":"Archive a tax rate","href":"/reference/latest/taxes/archive-a-tax-rate"},{"openapi":"taxes.latest.product.live GET /tax-rates/{id}","title":"Get a Tax Rate by ID","href":"/reference/latest/taxes/get-a-tax-rate-by-id"},{"openapi":"taxes.latest.product.live PUT /tax-rates/{id}","title":"Update a TaxRate","href":"/reference/latest/taxes/update-a-taxrate"},{"openapi":"taxes.latest.product.live DELETE /tax-rates/{id}","title":"Delete a Tax Rate","href":"/reference/latest/taxes/delete-a-tax-rate"},{"openapi":"taxes.latest.product.live GET /tax-rates","title":"List all Tax Rates","href":"/reference/latest/taxes/list-all-tax-rates"},{"openapi":"taxes.latest.product.live POST /tax-rates","title":"Create a new TaxRate","href":"/reference/latest/taxes/create-a-new-taxrate"}]}]},{"group":"Usage","pages":[{"group":"Usage Events","pages":[{"openapi":"usage.latest.product.live GET /usage-events","title":"List all Usage Events","href":"/reference/latest/usage/list-all-usage-events"},{"openapi":"usage.latest.product.live POST /usage-events","title":"Create a new Usage Event","href":"/reference/latest/usage/create-a-new-usage-event"}]},{"group":"Seat Metrics","pages":[{"openapi":"usage.latest.product.live GET /seat-metrics","title":"List all seat metrics","href":"/reference/latest/usage/list-all-seat-metrics"},{"openapi":"usage.latest.product.live POST /seat-metrics","title":"Create a seat metric","href":"/reference/latest/usage/create-a-seat-metric"},{"openapi":"usage.latest.product.live GET /seat-metrics/{id}","title":"Get a seat metric","href":"/reference/latest/usage/get-a-seat-metric"},{"openapi":"usage.latest.product.live PUT /seat-metrics/{id}","title":"Update a seat metric","href":"/reference/latest/usage/update-a-seat-metric"},{"openapi":"usage.latest.product.live DELETE /seat-metrics/{id}","title":"Delete a seat metric","href":"/reference/latest/usage/delete-a-seat-metric"},{"openapi":"usage.latest.product.live GET /seat-balances","title":"List Seat balances by Customer","href":"/reference/latest/usage/list-seat-balances-by-customer"}]},{"group":"Seat Events","pages":[{"openapi":"usage.latest.product.live GET /seat-events","title":"List all seat events","href":"/reference/latest/usage/list-all-seat-events"},{"openapi":"usage.latest.product.live POST /seat-events","title":"Create a seat event","href":"/reference/latest/usage/create-a-seat-event"},{"openapi":"usage.latest.product.live GET /seat-events/{id}","title":"Get a seat event by ID","href":"/reference/latest/usage/get-a-seat-event-by-id"}]},{"group":"Usage Metrics","pages":[{"openapi":"usage.latest.product.live POST /usage-metrics","title":"Create a new Usage Metric","href":"/reference/latest/usage/create-a-new-usage-metric"},{"openapi":"usage.latest.product.live GET /usage-metrics","title":"List all Usage Metrics","href":"/reference/latest/usage/list-all-usage-metrics"},{"openapi":"usage.latest.product.live GET /usage-metrics/{id}","title":"Get a Usage Metric by ID","href":"/reference/latest/usage/get-a-usage-metric-by-id"},{"openapi":"usage.latest.product.live PUT /usage-metrics/{id}","title":"Update a Usage Metric","href":"/reference/latest/usage/update-a-usage-metric"},{"openapi":"usage.latest.product.live DELETE /usage-metrics/{id}","title":"Delete a Usage Metric","href":"/reference/latest/usage/delete-a-usage-metric"},{"openapi":"usage.latest.product.live GET /usage-metrics/{usageMetricId}/calculate","title":"Calculate usage metric for customer and timeframe","href":"/reference/latest/usage/calculate-usage-metric-for-customer-and-timeframe"}]}]}]},{"group":"Version 2024-07-30","pages":[{"group":"Account","pages":[{"group":"Users","pages":[{"openapi":"account.2024-07-30.product.live GET /users/{id}","title":"Get a user","href":"/reference/2024-07-30/account/get-a-user"},{"openapi":"account.2024-07-30.product.live DELETE /users/{id}","title":"Delete User","href":"/reference/2024-07-30/account/delete-user"},{"openapi":"account.2024-07-30.product.live GET /users","title":"List all Users","href":"/reference/2024-07-30/account/list-all-users"}]},{"group":"Accounts","pages":[{"openapi":"account.2024-07-30.product.live GET /sequence-accounts","title":"List your accounts","href":"/reference/2024-07-30/account/list-your-accounts"},{"openapi":"account.2024-07-30.product.live GET /sequence-accounts/{id}","title":"Get your account","href":"/reference/2024-07-30/account/get-your-account"},{"openapi":"account.2024-07-30.product.live PUT /sequence-accounts/{id}","title":"Update Account","href":"/reference/2024-07-30/account/update-account"}]}]},{"group":"Activity Stream","pages":[{"group":"Activities","pages":[{"openapi":"activity-stream.2024-07-30.product.live GET /activity-logs/{id}","title":"Get an Activity Log by ID","href":"/reference/2024-07-30/activity-stream/get-an-activity-log-by-id"},{"openapi":"activity-stream.2024-07-30.product.live GET /activity-logs","title":"List all Activity Logs","href":"/reference/2024-07-30/activity-stream/list-all-activity-logs"}]}]},{"group":"Billing","pages":[{"group":"Prices","pages":[{"openapi":"billing.2024-07-30.product.live GET /prices","title":"List all Prices","href":"/reference/2024-07-30/billing/list-all-prices"},{"openapi":"billing.2024-07-30.product.live POST /prices","title":"Create a new Price","href":"/reference/2024-07-30/billing/create-a-new-price"},{"openapi":"billing.2024-07-30.product.live GET /billing-products","title":"List all billing products","href":"/reference/2024-07-30/billing/list-all-billing-products"},{"openapi":"billing.2024-07-30.product.live GET /prices/{id}","title":"Get a Price by ID","href":"/reference/2024-07-30/billing/get-a-price-by-id"},{"openapi":"billing.2024-07-30.product.live PUT /prices/{id}","title":"Update a Price","href":"/reference/2024-07-30/billing/update-a-price"},{"openapi":"billing.2024-07-30.product.live DELETE /prices/{id}","title":"Delete a Price","href":"/reference/2024-07-30/billing/delete-a-price"}]},{"group":"Credits","pages":[{"openapi":"billing.2024-07-30.product.live GET /credits","title":"List customer credit grants","href":"/reference/2024-07-30/billing/list-customer-credit-grants"},{"openapi":"billing.2024-07-30.product.live POST /credits","title":"Create a new credit grant","href":"/reference/2024-07-30/billing/create-a-new-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits/{id}","title":"Get a customer credit grant","href":"/reference/2024-07-30/billing/get-a-customer-credit-grant"},{"openapi":"billing.2024-07-30.product.live DELETE /credits/{id}","title":"Delete a credit grant","href":"/reference/2024-07-30/billing/delete-a-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits/{customerId}/grants","title":"List Credit Grants for a customer","href":"/reference/2024-07-30/billing/list-credit-grants-for-a-customer"},{"openapi":"billing.2024-07-30.product.live GET /credit-grants","title":"List credit grants","href":"/reference/2024-07-30/billing/list-credit-grants"},{"openapi":"billing.2024-07-30.product.live POST /credit-grants","title":"Create a customer credit grant","href":"/reference/2024-07-30/billing/create-a-customer-credit-grant"},{"openapi":"billing.2024-07-30.product.live GET /credits/{customerId}/balances","title":"List Credit Balances for a customer","href":"/reference/2024-07-30/billing/list-credit-balances-for-a-customer"},{"openapi":"billing.2024-07-30.product.live GET /credit-grants/{id}","title":"Get a credit grant","href":"/reference/2024-07-30/billing/get-a-credit-grant"}]},{"group":"Billing Schedules","pages":[{"openapi":"billing.2024-07-30.product.live GET /billing-schedules/{billingScheduleId}","title":"Get Billing Schedule","href":"/reference/2024-07-30/billing/get-billing-schedule"},{"openapi":"billing.2024-07-30.product.live PUT /billing-schedules/{billingScheduleId}","title":"Update Billing Schedule","href":"/reference/2024-07-30/billing/update-billing-schedule"},{"openapi":"billing.2024-07-30.product.live GET /billing-schedules","title":"List all Billing Schedules","href":"/reference/2024-07-30/billing/list-all-billing-schedules"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules","title":"Create Billing Schedule","href":"/reference/2024-07-30/billing/create-billing-schedule"},{"openapi":"billing.2024-07-30.product.live GET /billing-schedule-custom-field-keys","title":"List Billing Schedule Custom Field Keys","href":"/reference/2024-07-30/billing/list-billing-schedule-custom-field-keys"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules/{billingScheduleId}/duplicate","title":"Duplicate a billing schedule","href":"/reference/2024-07-30/billing/duplicate-a-billing-schedule"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules/{billingScheduleId}/archive","title":"Archive Billing Schedule","href":"/reference/2024-07-30/billing/archive-billing-schedule"},{"openapi":"billing.2024-07-30.product.live PUT /billing-schedules/{billingScheduleId}/activate","title":"Activate Billing Schedule","href":"/reference/2024-07-30/billing/activate-billing-schedule"},{"openapi":"billing.2024-07-30.product.live POST /billing-schedules/validate-taxes","title":"Validate taxes on a billing schedule","href":"/reference/2024-07-30/billing/validate-taxes-on-a-billing-schedule"}]},{"group":"Discounts","pages":[{"openapi":"billing.2024-07-30.product.live GET /discounts/{id}","title":"Get a discount by ID","href":"/reference/2024-07-30/billing/get-a-discount-by-id"},{"openapi":"billing.2024-07-30.product.live PUT /discounts/{id}","title":"Update a discount","href":"/reference/2024-07-30/billing/update-a-discount"},{"openapi":"billing.2024-07-30.product.live DELETE /discounts/{id}","title":"Delete a discount","href":"/reference/2024-07-30/billing/delete-a-discount"},{"openapi":"billing.2024-07-30.product.live GET /discounts","title":"List all discounts","href":"/reference/2024-07-30/billing/list-all-discounts"}]}]},{"group":"Collections","pages":[{"group":"Invoices","pages":[{"openapi":"collections.2024-07-30.product.live GET /payments/settings/invoices/{id}","title":"Get invoice payment settings","href":"/reference/2024-07-30/collections/get-invoice-payment-settings"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/invoices/{id}","title":"Update invoice payment settings","href":"/reference/2024-07-30/collections/update-invoice-payment-settings"},{"openapi":"collections.2024-07-30.product.live DELETE /payments/settings/invoices/{id}","title":"Delete invoice payment settings","href":"/reference/2024-07-30/collections/delete-invoice-payment-settings"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/invoices/for-invoice/{id}","title":"Get invoice payment settings by invoice ID","href":"/reference/2024-07-30/collections/get-invoice-payment-settings-by-invoice-id"},{"openapi":"collections.2024-07-30.product.live POST /payments/settings/invoices","title":"Create invoice payment settings","href":"/reference/2024-07-30/collections/create-invoice-payment-settings"}]},{"group":"Stripe Collection Settings","pages":[{"openapi":"collections.2024-07-30.product.live GET /stripe/collections/settings","title":"Stripe collection settings for Sequence account","href":"/reference/2024-07-30/collections/stripe-collection-settings-for-sequence-account"},{"openapi":"collections.2024-07-30.product.live PUT /stripe/collections/settings/{id}","title":"Update Stripe collection settings for Sequence account","href":"/reference/2024-07-30/collections/update-stripe-collection-settings-for-sequence-account"}]},{"group":"Customers","pages":[{"openapi":"collections.2024-07-30.product.live POST /payments/settings/customers","title":"Create customer payment settings","href":"/reference/2024-07-30/collections/create-customer-payment-settings"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/customers/{id}","title":"Get customer payment settings","href":"/reference/2024-07-30/collections/get-customer-payment-settings"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/customers/{id}","title":"Update customer payment settings","href":"/reference/2024-07-30/collections/update-customer-payment-settings"},{"openapi":"collections.2024-07-30.product.live DELETE /payments/settings/customers/{id}","title":"Delete customer payment settings","href":"/reference/2024-07-30/collections/delete-customer-payment-settings"}]},{"group":"Billing Schedules","pages":[{"openapi":"collections.2024-07-30.product.live GET /payments/settings/billing-schedules/{id}","title":"Get billing schedule payment settings","href":"/reference/2024-07-30/collections/get-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/billing-schedules/{id}","title":"Update billing schedule payment settings","href":"/reference/2024-07-30/collections/update-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live DELETE /payments/settings/billing-schedules/{id}","title":"Delete billing schedule payment settings","href":"/reference/2024-07-30/collections/delete-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live POST /payments/settings/billing-schedules","title":"Create billing schedule payment settings","href":"/reference/2024-07-30/collections/create-billing-schedule-payment-settings"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings/billing-schedules/for-billing-schedule/{id}","title":"Get billing schedule payment settings by billing schedule ID","href":"/reference/2024-07-30/collections/get-billing-schedule-payment-settings-by-billing-schedule-id"}]},{"group":"Account Settings","pages":[{"openapi":"collections.2024-07-30.product.live PUT /payments/settings/{id}","title":"Update payment settings for Sequence account","href":"/reference/2024-07-30/collections/update-payment-settings-for-sequence-account"},{"openapi":"collections.2024-07-30.product.live GET /payments/settings","title":"Payment settings for Sequence account","href":"/reference/2024-07-30/collections/payment-settings-for-sequence-account"}]}]},{"group":"Customer","pages":[{"group":"Contacts","pages":[{"openapi":"customer.2024-07-30.product.live PUT /customers/{customer}/contacts/{id}","title":"Update a contact","href":"/reference/2024-07-30/customer/update-a-contact"},{"openapi":"customer.2024-07-30.product.live GET /customers/{customer}/contacts","title":"List all contacts for a customer","href":"/reference/2024-07-30/customer/list-all-contacts-for-a-customer"},{"openapi":"customer.2024-07-30.product.live POST /customers/{customer}/contacts","title":"Create a new contact","href":"/reference/2024-07-30/customer/create-a-new-contact"},{"openapi":"customer.2024-07-30.product.live POST /customers/{customer}/contacts/{id}/archive","title":"Archive a contact","href":"/reference/2024-07-30/customer/archive-a-contact"}]},{"group":"Customers","pages":[{"openapi":"customer.2024-07-30.product.live GET /customers/{id}","title":"Get customer","href":"/reference/2024-07-30/customer/get-customer"},{"openapi":"customer.2024-07-30.product.live PUT /customers/{id}","title":"Update customer","href":"/reference/2024-07-30/customer/update-customer"},{"openapi":"customer.2024-07-30.product.live POST /customers/{id}/archive","title":"Archive customer","href":"/reference/2024-07-30/customer/archive-customer"},{"openapi":"customer.2024-07-30.product.live GET /customers","title":"List customers","href":"/reference/2024-07-30/customer/list-customers"},{"openapi":"customer.2024-07-30.product.live POST /customers","title":"Create customer","href":"/reference/2024-07-30/customer/create-customer"},{"openapi":"customer.2024-07-30.product.live GET /customer-custom-property-keys","title":"List customer custom property keys","href":"/reference/2024-07-30/customer/list-customer-custom-property-keys"}]},{"group":"Organizations","pages":[{"openapi":"customer.2024-07-30.product.live PUT /customer-organizations/{id}/members","title":"Replace members of a customer organization","href":"/reference/2024-07-30/customer/replace-members-of-a-customer-organization"},{"openapi":"customer.2024-07-30.product.live POST /customer-organizations/{id}/members","title":"Add a customer to a customer organization","href":"/reference/2024-07-30/customer/add-a-customer-to-a-customer-organization"},{"openapi":"customer.2024-07-30.product.live POST /customer-organizations","title":"Create a customer organization","href":"/reference/2024-07-30/customer/create-a-customer-organization"}]},{"group":"Customer Aliases","pages":[{"openapi":"customer.2024-07-30.product.live GET /customers/by-alias/{alias}","title":"Get customer by alias","href":"/reference/2024-07-30/customer/get-customer-by-alias"},{"openapi":"customer.2024-07-30.product.live PUT /customer-aliases/{id}","title":"Update a Customer Alias","href":"/reference/2024-07-30/customer/update-a-customer-alias"},{"openapi":"customer.2024-07-30.product.live DELETE /customer-aliases/{id}","title":"Delete a Customer Alias","href":"/reference/2024-07-30/customer/delete-a-customer-alias"},{"openapi":"customer.2024-07-30.product.live GET /customer-aliases","title":"List all Customer Aliases","href":"/reference/2024-07-30/customer/list-all-customer-aliases"},{"openapi":"customer.2024-07-30.product.live POST /customer-aliases","title":"Create a new Customer Alias","href":"/reference/2024-07-30/customer/create-a-new-customer-alias"},{"openapi":"customer.2024-07-30.product.live GET /customers/{id}/aliases","title":"Get Customer Aliases","href":"/reference/2024-07-30/customer/get-customer-aliases"}]}]},{"group":"Invoices","pages":[{"group":"Invoice Line Items","pages":[{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{invoice}/line-items/{id}","title":"Update a line item","href":"/reference/2024-07-30/invoices/update-a-line-item"},{"openapi":"invoices.2024-07-30.product.live DELETE /invoices/{invoice}/line-items/{id}","title":"Deletes a Line Item","href":"/reference/2024-07-30/invoices/deletes-a-line-item"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{invoice}/line-item-groups/{id}","title":"Update a Line Item Group","href":"/reference/2024-07-30/invoices/update-a-line-item-group"},{"openapi":"invoices.2024-07-30.product.live DELETE /invoices/{invoice}/line-item-groups/{id}","title":"Delete a Line Item Group","href":"/reference/2024-07-30/invoices/delete-a-line-item-group"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{invoice}/line-item-groups","title":"List all Line Item Groups","href":"/reference/2024-07-30/invoices/list-all-line-item-groups"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{invoice}/line-item-groups","title":"Create a new Line Item Group","href":"/reference/2024-07-30/invoices/create-a-new-line-item-group"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{invoice}/line-items","title":"List all Line Items","href":"/reference/2024-07-30/invoices/list-all-line-items"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{invoice}/line-items","title":"Create a new Line Item","href":"/reference/2024-07-30/invoices/create-a-new-line-item"}]},{"group":"Credit Note Line Items","pages":[{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{creditnote}/line-items","title":"List all Credit Note Line Items","href":"/reference/2024-07-30/invoices/list-all-credit-note-line-items"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{creditnote}/line-items","title":"Create a new Credit Note Line Item","href":"/reference/2024-07-30/invoices/create-a-new-credit-note-line-item"},{"openapi":"invoices.2024-07-30.product.live PUT /credit-notes/{creditnote}/line-item-groups/{id}","title":"Update a Credit Note Line Item Group","href":"/reference/2024-07-30/invoices/update-a-credit-note-line-item-group"},{"openapi":"invoices.2024-07-30.product.live DELETE /credit-notes/{creditnote}/line-item-groups/{id}","title":"Delete a Credit Note Line Item Group","href":"/reference/2024-07-30/invoices/delete-a-credit-note-line-item-group"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{creditnote}/line-item-groups","title":"List all Credit Note Line Item Groups","href":"/reference/2024-07-30/invoices/list-all-credit-note-line-item-groups"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{creditnote}/line-item-groups","title":"Create a new Credit Note Line Item Group","href":"/reference/2024-07-30/invoices/create-a-new-credit-note-line-item-group"},{"openapi":"invoices.2024-07-30.product.live PUT /credit-notes/{creditnote}/line-items/{id}","title":"Update a Credit Note Line Item","href":"/reference/2024-07-30/invoices/update-a-credit-note-line-item"},{"openapi":"invoices.2024-07-30.product.live DELETE /credit-notes/{creditnote}/line-items/{id}","title":"Delete a Credit Note Line Item","href":"/reference/2024-07-30/invoices/delete-a-credit-note-line-item"}]},{"group":"Invoices","pages":[{"openapi":"invoices.2024-07-30.product.live PATCH /invoices/{id}/sent","title":"Patch a sent invoice","href":"/reference/2024-07-30/invoices/patch-a-sent-invoice"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{id}/currency-conversions","title":"List Currency Conversions for an Invoice","href":"/reference/2024-07-30/invoices/list-currency-conversions-for-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/mark-as-sent","title":"Finalize and mark invoice as sent without triggering actions except revenue recognition","href":"/reference/2024-07-30/invoices/finalize-and-mark-invoice-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/fix-billing-runs","title":"Fix invoices billing runs","href":"/reference/2024-07-30/invoices/fix-invoices-billing-runs"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{id}","title":"Get an Invoice by ID","href":"/reference/2024-07-30/invoices/get-an-invoice-by-id"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{id}","title":"Update an invoice","href":"/reference/2024-07-30/invoices/update-an-invoice"},{"openapi":"invoices.2024-07-30.product.live DELETE /invoices/{id}","title":"Delete an Invoice","href":"/reference/2024-07-30/invoices/delete-an-invoice"},{"openapi":"invoices.2024-07-30.product.live PATCH /invoices/{id}","title":"Patch an invoice","href":"/reference/2024-07-30/invoices/patch-an-invoice"},{"openapi":"invoices.2024-07-30.product.live GET /invoices","title":"List all Invoices","href":"/reference/2024-07-30/invoices/list-all-invoices"},{"openapi":"invoices.2024-07-30.product.live POST /invoices","title":"Create an invoice","href":"/reference/2024-07-30/invoices/create-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/void","title":"Void an Invoice","href":"/reference/2024-07-30/invoices/void-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/draft","title":"Convert upcoming invoice to draft","href":"/reference/2024-07-30/invoices/convert-upcoming-invoice-to-draft"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/list-summary","title":"List Invoice summaries","href":"/reference/2024-07-30/invoices/list-invoice-summaries"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/summary","title":"Get an invoice summary","href":"/reference/2024-07-30/invoices/get-an-invoice-summary"},{"openapi":"invoices.2024-07-30.product.live PUT /invoices/{id}/payment-status","title":"Update payment status for an invoice","href":"/reference/2024-07-30/invoices/update-payment-status-for-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/finalize-and-send","title":"Finalize and send invoice","href":"/reference/2024-07-30/invoices/finalize-and-send-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/send","title":"Send invoice","href":"/reference/2024-07-30/invoices/send-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/merge","title":"Merge invoices","href":"/reference/2024-07-30/invoices/merge-invoices"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/send-payment-reminder","title":"Send a payment reminder for an invoice","href":"/reference/2024-07-30/invoices/send-a-payment-reminder-for-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/reconcile-with-integration","title":"Reconcile invoices with external integration","href":"/reference/2024-07-30/invoices/reconcile-invoices-with-external-integration"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/{id}/download","title":"Download invoice PDF","href":"/reference/2024-07-30/invoices/download-invoice-pdf"},{"openapi":"invoices.2024-07-30.product.live POST /invoices/{id}/finalize","title":"Finalize invoice","href":"/reference/2024-07-30/invoices/finalize-invoice"}]},{"group":"Credit Notes","pages":[{"openapi":"invoices.2024-07-30.product.live POST /credit-note-applications","title":"Apply a Credit Note to an Invoice","href":"/reference/2024-07-30/invoices/apply-a-credit-note-to-an-invoice"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/void","title":"Void a Credit Note","href":"/reference/2024-07-30/invoices/void-a-credit-note"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/finalize","title":"Finalize credit note","href":"/reference/2024-07-30/invoices/finalize-credit-note"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes","title":"List all Credit Notes","href":"/reference/2024-07-30/invoices/list-all-credit-notes"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes","title":"Create a new Credit Note","href":"/reference/2024-07-30/invoices/create-a-new-credit-note"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/send","title":"Send credit note","href":"/reference/2024-07-30/invoices/send-credit-note"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{id}","title":"Get a Credit Note by ID","href":"/reference/2024-07-30/invoices/get-a-credit-note-by-id"},{"openapi":"invoices.2024-07-30.product.live PUT /credit-notes/{id}","title":"Update a Credit Note","href":"/reference/2024-07-30/invoices/update-a-credit-note"},{"openapi":"invoices.2024-07-30.product.live DELETE /credit-notes/{id}","title":"Delete a Credit Note","href":"/reference/2024-07-30/invoices/delete-a-credit-note"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/mark-as-sent","title":"Mark credit note as sent without triggering actions except revenue recognition","href":"/reference/2024-07-30/invoices/mark-credit-note-as-sent-without-triggering-actions-except-revenue-recognition"},{"openapi":"invoices.2024-07-30.product.live GET /credit-notes/{id}/download","title":"Download credit note PDF","href":"/reference/2024-07-30/invoices/download-credit-note-pdf"},{"openapi":"invoices.2024-07-30.product.live POST /credit-notes/{id}/finalize-and-send","title":"Finalize and send credit note","href":"/reference/2024-07-30/invoices/finalize-and-send-credit-note"}]},{"group":"Invoice Settings","pages":[{"openapi":"invoices.2024-07-30.product.live PUT /invoices/render-settings/{id}","title":"Update an Invoice Render Settings","href":"/reference/2024-07-30/invoices/update-an-invoice-render-settings"},{"openapi":"invoices.2024-07-30.product.live GET /invoices/render-settings","title":"Get or create Invoice Render Settings","href":"/reference/2024-07-30/invoices/get-or-create-invoice-render-settings"}]}]},{"group":"Notifications","pages":[{"group":"Notification Policies","pages":[{"openapi":"notifications.2024-07-30.product.live DELETE /notifications/policies/{id}/notification-types/{type}","title":"Remove a notification type from a policy","href":"/reference/2024-07-30/notifications/remove-a-notification-type-from-a-policy"},{"openapi":"notifications.2024-07-30.product.live POST /notifications/policies/{id}/recipients","title":"Add recipients to a policy","href":"/reference/2024-07-30/notifications/add-recipients-to-a-policy"},{"openapi":"notifications.2024-07-30.product.live DELETE /notifications/policies/{id}/recipients/{recipient}","title":"Remove a recipient from a policy","href":"/reference/2024-07-30/notifications/remove-a-recipient-from-a-policy"},{"openapi":"notifications.2024-07-30.product.live GET /notifications/policies/{id}","title":"Get notification policy","href":"/reference/2024-07-30/notifications/get-notification-policy"},{"openapi":"notifications.2024-07-30.product.live DELETE /notifications/policies/{id}","title":"Delete notification policy","href":"/reference/2024-07-30/notifications/delete-notification-policy"},{"openapi":"notifications.2024-07-30.product.live GET /notifications/policies","title":"List All Notification Policies","href":"/reference/2024-07-30/notifications/list-all-notification-policies"},{"openapi":"notifications.2024-07-30.product.live POST /notifications/policies","title":"Create Notification policy","href":"/reference/2024-07-30/notifications/create-notification-policy"},{"openapi":"notifications.2024-07-30.product.live POST /notifications/policies/{id}/notification-types","title":"Add notification types to a policy","href":"/reference/2024-07-30/notifications/add-notification-types-to-a-policy"}]}]},{"group":"Orchestra","pages":[{"group":"Assets","pages":[{"openapi":"orchestra.2024-07-30.product.live POST /assets","title":"Upload an asset","href":"/reference/2024-07-30/orchestra/upload-an-asset"},{"openapi":"orchestra.2024-07-30.product.live GET /assets/{id}","title":"Get an asset","href":"/reference/2024-07-30/orchestra/get-an-asset"}]}]},{"group":"Product","pages":[{"group":"Products","pages":[{"openapi":"product.2024-07-30.product.live GET /products/{id}","title":"Get a Product by ID","href":"/reference/2024-07-30/product/get-a-product-by-id"},{"openapi":"product.2024-07-30.product.live PUT /products/{id}","title":"Update a Product","href":"/reference/2024-07-30/product/update-a-product"},{"openapi":"product.2024-07-30.product.live POST /products/{id}/archive","title":"Archive a product","href":"/reference/2024-07-30/product/archive-a-product"},{"openapi":"product.2024-07-30.product.live GET /products","title":"List all Products","href":"/reference/2024-07-30/product/list-all-products"},{"openapi":"product.2024-07-30.product.live POST /products","title":"Create a new Product","href":"/reference/2024-07-30/product/create-a-new-product"}]},{"group":"List Prices","pages":[{"openapi":"product.2024-07-30.product.live POST /list-prices/{id}/archive","title":"Archive a list price","href":"/reference/2024-07-30/product/archive-a-list-price"},{"openapi":"product.2024-07-30.product.live GET /list-prices","title":"List all list prices","href":"/reference/2024-07-30/product/list-all-list-prices"},{"openapi":"product.2024-07-30.product.live POST /list-prices","title":"Create a list price","href":"/reference/2024-07-30/product/create-a-list-price"},{"openapi":"product.2024-07-30.product.live GET /list-prices/{id}","title":"Get a list price","href":"/reference/2024-07-30/product/get-a-list-price"},{"openapi":"product.2024-07-30.product.live PUT /list-prices/{id}","title":"Update a list price","href":"/reference/2024-07-30/product/update-a-list-price"}]}]},{"group":"Quote","pages":[{"group":"Quotes","pages":[{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}/analytics","title":"Get quote analytics","href":"/reference/2024-07-30/quote/get-quote-analytics"},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}/published","title":"Get a published quote","href":"/reference/2024-07-30/quote/get-a-published-quote"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{quoteId}/notify-recipients","title":"Notify selected quote recipients by email","href":"/reference/2024-07-30/quote/notify-selected-quote-recipients-by-email"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{id}/accept","title":"Accept a published Quote","href":"/reference/2024-07-30/quote/accept-a-published-quote"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{quoteId}/send-reminders","title":"Send reminder emails to all that have not signed.","href":"/reference/2024-07-30/quote/send-reminder-emails-to-all-that-have-not-signed."},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}/download","title":"Download quote PDF","href":"/reference/2024-07-30/quote/download-quote-pdf"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{id}/publish","title":"Publish a quote","href":"/reference/2024-07-30/quote/publish-a-quote"},{"openapi":"quote.2024-07-30.product.live GET /quotes/{id}","title":"Get one of your quotes","description":"Get a quote by ID including its phases","href":"/reference/2024-07-30/quote/get-one-of-your-quotes"},{"openapi":"quote.2024-07-30.product.live PUT /quotes/{id}","title":"Update one of your quotes","href":"/reference/2024-07-30/quote/update-one-of-your-quotes"},{"openapi":"quote.2024-07-30.product.live GET /quotes","title":"List quotes","description":"List all of your quotes","href":"/reference/2024-07-30/quote/list-quotes"},{"openapi":"quote.2024-07-30.product.live POST /quotes/{id}/archive","title":"Archive a quote","href":"/reference/2024-07-30/quote/archive-a-quote"},{"openapi":"quote.2024-07-30.product.live POST /quotes/from-template/{id}","title":"Create a quote from a template","href":"/reference/2024-07-30/quote/create-a-quote-from-a-template"}]},{"group":"Quote Templates","pages":[{"openapi":"quote.2024-07-30.product.live GET /quote-templates","title":"List quote templates","href":"/reference/2024-07-30/quote/list-quote-templates"}]}]},{"group":"Taxes","pages":[{"group":"Tax Registrations","pages":[{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations","title":"List all Tax Registrations","href":"/reference/2024-07-30/taxes/list-all-tax-registrations"},{"openapi":"taxes.2024-07-30.product.live POST /tax-registrations","title":"Create a new Tax Registration","href":"/reference/2024-07-30/taxes/create-a-new-tax-registration"},{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations/{id}","title":"Get a Tax Registration by ID","href":"/reference/2024-07-30/taxes/get-a-tax-registration-by-id"},{"openapi":"taxes.2024-07-30.product.live PUT /tax-registrations/{id}","title":"Update a Tax Registration","href":"/reference/2024-07-30/taxes/update-a-tax-registration"},{"openapi":"taxes.2024-07-30.product.live DELETE /tax-registrations/{id}","title":"Delete a Tax Registration","href":"/reference/2024-07-30/taxes/delete-a-tax-registration"},{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations/for-merchant/{id}","title":"Get all tax registrations for a merchant by merchant ID","href":"/reference/2024-07-30/taxes/get-all-tax-registrations-for-a-merchant-by-merchant-id"},{"openapi":"taxes.2024-07-30.product.live GET /tax-registrations/for-customer/{id}","title":"Get all tax registrations for a customer by customer ID","href":"/reference/2024-07-30/taxes/get-all-tax-registrations-for-a-customer-by-customer-id"}]},{"group":"Tax Rates","pages":[{"openapi":"taxes.2024-07-30.product.live POST /tax-rates/{id}/archive","title":"Archive a tax rate","href":"/reference/2024-07-30/taxes/archive-a-tax-rate"},{"openapi":"taxes.2024-07-30.product.live GET /tax-rates/{id}","title":"Get a Tax Rate by ID","href":"/reference/2024-07-30/taxes/get-a-tax-rate-by-id"},{"openapi":"taxes.2024-07-30.product.live PUT /tax-rates/{id}","title":"Update a TaxRate","href":"/reference/2024-07-30/taxes/update-a-taxrate"},{"openapi":"taxes.2024-07-30.product.live DELETE /tax-rates/{id}","title":"Delete a Tax Rate","href":"/reference/2024-07-30/taxes/delete-a-tax-rate"},{"openapi":"taxes.2024-07-30.product.live GET /tax-rates","title":"List all Tax Rates","href":"/reference/2024-07-30/taxes/list-all-tax-rates"},{"openapi":"taxes.2024-07-30.product.live POST /tax-rates","title":"Create a new TaxRate","href":"/reference/2024-07-30/taxes/create-a-new-taxrate"}]}]},{"group":"Usage","pages":[{"group":"Usage Events","pages":[{"openapi":"usage.2024-07-30.product.live GET /usage-events","title":"List all Usage Events","href":"/reference/2024-07-30/usage/list-all-usage-events"},{"openapi":"usage.2024-07-30.product.live POST /usage-events","title":"Create a new Usage Event","href":"/reference/2024-07-30/usage/create-a-new-usage-event"}]},{"group":"Seat Metrics","pages":[{"openapi":"usage.2024-07-30.product.live GET /seat-metrics","title":"List all seat metrics","href":"/reference/2024-07-30/usage/list-all-seat-metrics"},{"openapi":"usage.2024-07-30.product.live POST /seat-metrics","title":"Create a seat metric","href":"/reference/2024-07-30/usage/create-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live GET /seat-metrics/{id}","title":"Get a seat metric","href":"/reference/2024-07-30/usage/get-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live PUT /seat-metrics/{id}","title":"Update a seat metric","href":"/reference/2024-07-30/usage/update-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live DELETE /seat-metrics/{id}","title":"Delete a seat metric","href":"/reference/2024-07-30/usage/delete-a-seat-metric"},{"openapi":"usage.2024-07-30.product.live GET /seat-balances","title":"List Seat balances by Customer","href":"/reference/2024-07-30/usage/list-seat-balances-by-customer"}]},{"group":"Seat Events","pages":[{"openapi":"usage.2024-07-30.product.live GET /seat-events","title":"List all seat events","href":"/reference/2024-07-30/usage/list-all-seat-events"},{"openapi":"usage.2024-07-30.product.live POST /seat-events","title":"Create a seat event","href":"/reference/2024-07-30/usage/create-a-seat-event"},{"openapi":"usage.2024-07-30.product.live GET /seat-events/{id}","title":"Get a seat event by ID","href":"/reference/2024-07-30/usage/get-a-seat-event-by-id"}]},{"group":"Usage Metrics","pages":[{"openapi":"usage.2024-07-30.product.live POST /usage-metrics","title":"Create a new Usage Metric","href":"/reference/2024-07-30/usage/create-a-new-usage-metric"},{"openapi":"usage.2024-07-30.product.live GET /usage-metrics","title":"List all Usage Metrics","href":"/reference/2024-07-30/usage/list-all-usage-metrics"},{"openapi":"usage.2024-07-30.product.live GET /usage-metrics/{id}","title":"Get a Usage Metric by ID","href":"/reference/2024-07-30/usage/get-a-usage-metric-by-id"},{"openapi":"usage.2024-07-30.product.live PUT /usage-metrics/{id}","title":"Update a Usage Metric","href":"/reference/2024-07-30/usage/update-a-usage-metric"},{"openapi":"usage.2024-07-30.product.live DELETE /usage-metrics/{id}","title":"Delete a Usage Metric","href":"/reference/2024-07-30/usage/delete-a-usage-metric"},{"openapi":"usage.2024-07-30.product.live GET /usage-metrics/{usageMetricId}/calculate","title":"Calculate usage metric for customer and timeframe","href":"/reference/2024-07-30/usage/calculate-usage-metric-for-customer-and-timeframe"}]}]}]}]},{"tab":"Connectors","pages":[{"title":"Connectors","href":"/connectors/overview"}]},{"tab":"Security","pages":[{"title":"Security","href":"/compliance/overview"}]},{"tab":"Compare","pages":[{"title":"Compare","href":"/migration/maxio"}]}]},"title":"Update one of your quotes - Sequence","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}