> ## Documentation Index > Fetch the complete documentation index at: https://docs.sequencehq.com/llms.txt > Use this file to discover all available pages before exploring further. # Get the published version of one of your quotes > Get the latest published version of a quote by ID, including its phases. ## OpenAPI ````yaml quote.2024-07-30.product.live GET /quotes/{id}/published openapi: 3.0.0 info: title: '' description: '' version: 0.0.1 servers: - url: https://dev.seqhq.io description: E2E - url: https://dev.seqhq.io description: DEV - url: https://sandbox.sequencehq.com description: SANDBOX - url: https://eu.sequencehq.com description: PRODUCTION security: [] tags: - name: Quotes paths: /quotes/{id}/published: servers: [] parameters: [] get: tags: - Quotes summary: Get the published version of one of your quotes description: Get the latest published version of a quote by ID, including its phases. operationId: getQuotesByIdPublished parameters: - name: id in: path description: Quote ID required: true schema: type: string - name: Authorization in: header description: >- Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`. required: true schema: type: string - name: sequence-version in: header description: Use this header to select an API version required: false schema: type: string enum: - '2024-07-30' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PublishedQuote' 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 presentation: [] status: ACCEPTED dealType: NEW_BUSINESS 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 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: 0 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' contacts: - contactId: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' counterSigners: - id: 0190da0c-980d-7fa2-9b65-4c79784a95b1 name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' isSignaturesEnabled: false customerLegalName: Acme Corp customerAddress: line1: 1 Fake Street line2: Fakesville town: Faketown state: CA postcode: F4KE country: US pdfStatus: NOT_YET_REQUESTED archivedAt: '2022-06-28T16:47:00Z' attachmentAssets: - id: e007e884-5100-4183-8355-4771865cb4dd createdBy: 94703530-1293-479b-bd37-ccad42fd9c8b 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' examples: PublishedQuote: summary: '' 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 presentation: [] status: ACCEPTED dealType: NEW_BUSINESS 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 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: 0 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' contacts: - contactId: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' counterSigners: - id: 0190da0c-980d-7fa2-9b65-4c79784a95b1 name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' isSignaturesEnabled: false customerLegalName: Acme Corp customerAddress: line1: 1 Fake Street line2: Fakesville town: Faketown state: CA postcode: F4KE country: US pdfStatus: NOT_YET_REQUESTED archivedAt: '2022-06-28T16:47:00Z' attachmentAssets: - id: e007e884-5100-4183-8355-4771865cb4dd createdBy: 94703530-1293-479b-bd37-ccad42fd9c8b 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' '400': description: Bad Request content: {} '401': description: Unauthorized content: {} '404': description: Not Found content: {} '500': description: Internal Server Error content: {} components: schemas: PublishedQuote: required: - attachmentAssets - contacts - counterSigners - createdAt - createdBy - currency - customerAddress - customerId - customerLegalName - dealType - expiresAt - id - isExpired - isSignaturesEnabled - merchantBranding - pdfStatus - phases - presentation - publishedAt - quoteNumber - status - title - 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 presentation: [] status: ACCEPTED dealType: NEW_BUSINESS 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 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: 0 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' contacts: - contactId: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' counterSigners: - id: 0190da0c-980d-7fa2-9b65-4c79784a95b1 name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' isSignaturesEnabled: false customerLegalName: Acme Corp customerAddress: line1: 1 Fake Street line2: Fakesville town: Faketown state: CA postcode: F4KE country: US pdfStatus: NOT_YET_REQUESTED archivedAt: '2022-06-28T16:47:00Z' attachmentAssets: - id: e007e884-5100-4183-8355-4771865cb4dd createdBy: 94703530-1293-479b-bd37-ccad42fd9c8b 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' properties: id: type: string description: Unique ID example: 678ca125-8bc3-478f-9a96-6ba73605cf1e createdBy: type: string description: The Sequence user who created this quote example: 4ffd439e-32e5-4046-bb40-3cb81f40e5da customerId: type: string description: ID of Customer to which this quote pertains example: 377bf97b-ca1d-4538-be06-4022afa6bde3 quoteNumber: type: string description: An alpha-numeric value that identifies the quote example: Q00001 title: type: string description: The quote title example: My quote currency: $ref: '#/components/schemas/Currency' description: Quote currency presentation: type: array description: JSON for the visual presentation of the quote example: [] items: {} status: $ref: '#/components/schemas/QuoteStatus' description: The status of the quote dealType: $ref: '#/components/schemas/QuoteDealType' description: Quote deal type preliminaryBillingStartDate: type: string description: Preliminary start date of contract example: '2022-10-01' expiresAt: type: string description: Date when quote expires example: '2022-10-01' publishedAt: type: string description: >- Timestamp when quote was published. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' readyToSignAt: type: string description: >- Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' acceptedAt: type: string description: >- Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' executedAt: type: string description: >- Timestamp when quote was executed. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' createdAt: type: string description: Creation timestamp. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' updatedAt: type: string description: >- Timestamp when quote was last updated. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' createdFrom: $ref: '#/components/schemas/QuoteCreatedFrom' salesforceOpportunityId: type: string description: Salesforce ID of the opportunity that created this quote example: 006Hr00001MfnEIIAZ merchantBranding: $ref: '#/components/schemas/QuoteMerchantDetails' 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: 0 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: $ref: '#/components/schemas/QuotePhase' 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' items: $ref: '#/components/schemas/QuoteContact' 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' items: $ref: '#/components/schemas/QuoteCounterSigner' isSignaturesEnabled: type: boolean description: >- Enable e-signatures to allow customers to sign this quote through Dropbox Sign. example: false customerLegalName: type: string description: Customer legal name example: Acme Corp customerAddress: $ref: '#/components/schemas/Address' pdfStatus: $ref: '#/components/schemas/QuotePdfStatus' description: Status of quote PDF generation for this variant archivedAt: type: string description: Date and time the quote was archived example: '2022-06-28T16:47:00Z' attachmentAssets: type: array description: Assets attached to this quote example: - id: e007e884-5100-4183-8355-4771865cb4dd createdBy: 94703530-1293-479b-bd37-ccad42fd9c8b 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: $ref: '#/components/schemas/AssetResponse' isExpired: type: boolean description: True if the quote expiry date has passed example: false defaultDueDateDays: type: integer description: >- Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote. example: 30 signatureMode: $ref: '#/components/schemas/SignatureMode' 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. preparingSignatureRequestAt: type: string description: Timestamp when quote ready-to-sign operation was triggered. example: '2022-06-28T16:47:00Z' Currency: 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 QuoteStatus: type: string example: DRAFT enum: - DRAFT - PUBLISHED - PREPARING_SIGNATURE_REQUEST - READY_TO_SIGN - ACCEPTED - EXECUTED QuoteDealType: type: string example: NEW_BUSINESS enum: - NEW_BUSINESS - RENEWAL QuoteCreatedFrom: required: - entityId - entityType type: object description: Entity from which this quote was created example: entityType: QUOTE entityId: dc0e2104-7df5-4fc1-8f65-1823f427d111 properties: entityType: $ref: '#/components/schemas/EntityType' entityId: type: string example: dc0e2104-7df5-4fc1-8f65-1823f427d111 QuoteMerchantDetails: 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: logoUrl: type: string example: logo legalCompanyName: type: string example: Acme Corp primaryColour: type: string example: colour url: type: string example: www.example.com address: $ref: '#/components/schemas/Address' email: type: string example: accounting@example.com showUsageInCustomerPortal: type: boolean example: true supportEmail: type: string example: support@example.com supportUrl: type: string example: https://www.example.com/support QuotePhase: 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: 0 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 name: type: string description: Optional name of phase example: Onboarding createdAt: type: string description: Creation timestamp. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' duration: $ref: '#/components/schemas/Duration' 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: $ref: '#/components/schemas/QuotePrice' 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: $ref: '#/components/schemas/QuoteDiscount' 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: $ref: '#/components/schemas/QuoteMinimum' QuoteContact: required: - contactId - email - name type: object example: contactId: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' properties: contactId: type: string description: Unique Contact ID example: 9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc name: type: string description: Full name of the signer example: Jane Doe email: type: string description: Email address of the signer example: jane@example.com signedAt: type: string description: >- The time at which this contact signed the document. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' QuoteCounterSigner: required: - email - id - name type: object example: id: 0190da0c-980d-7fa2-9b65-4c79784a95b1 name: Jane Doe email: jane@example.com signedAt: '2022-06-28T16:47:00Z' properties: id: type: string description: Unique ID example: 0190da0c-980d-7fa2-9b65-4c79784a95b1 name: type: string description: Full name of the signer example: Jane Doe email: type: string description: Email address of the signer example: jane@example.com signedAt: type: string description: >- The time at which this contact signed the document. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' 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 line2: type: string description: Address line 2 example: Suite 100 town: type: string description: Town or city example: San Francisco state: $ref: '#/components/schemas/State' description: State or province (required for USA and Canada) postcode: type: string description: Postal code example: '94105' country: $ref: '#/components/schemas/CountryCode' description: >- Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)) QuotePdfStatus: type: string example: NOT_YET_REQUESTED enum: - NOT_YET_REQUESTED - REQUESTED - IN_PROGRESS - FAILED - GENERATED AssetResponse: required: - createdAt - createdBy - fileName - fileSizeBytes - format - id - type - url type: object example: id: e007e884-5100-4183-8355-4771865cb4dd createdBy: 94703530-1293-479b-bd37-ccad42fd9c8b 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 createdBy: type: string description: The Sequence user who created this asset example: 94703530-1293-479b-bd37-ccad42fd9c8b type: $ref: '#/components/schemas/AssetType' description: Either image or document format: $ref: '#/components/schemas/AssetFormat' description: >- Identifies the intended data format. Allowed formats are: jpg, jpeg, png, and pdf fileName: type: string description: Filename of the uploaded file example: my-image.png fileSizeBytes: type: integer description: Size of the uploaded file in bytes format: int32 example: 12345 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 createdAt: type: string description: Creation timestamp. Formatted as an ISO 8601 timestamp. example: '2022-06-28T16:47:00Z' SignatureMode: type: string example: EMBEDDED enum: - EMBEDDED - NON_EMBEDDED 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 - PRICE - PRODUCT - QUOTE - QUOTE_DISCOUNT - QUOTE_MINIMUM - QUOTE_PHASE - QUOTE_PRICE - QUOTE_TEMPLATE_PRICE - TAX_CATEGORY - TAX_CODE Duration: required: - days - months - weeks - years type: object description: Duration of phase. Null denotes an open-ended phase. example: days: 0 weeks: 0 months: 6 years: 1 properties: days: type: integer format: int32 example: 0 weeks: type: integer format: int32 example: 0 months: type: integer format: int32 example: 6 years: type: integer format: int32 example: 1 QuotePrice: 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 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: Sample product structure: oneOf: - $ref: '#/components/schemas/ONE_TIME' - $ref: '#/components/schemas/FIXED' - $ref: '#/components/schemas/LINEAR' - $ref: '#/components/schemas/SEAT_BASED' - $ref: '#/components/schemas/GRADUATED' - $ref: '#/components/schemas/VOLUME' - $ref: '#/components/schemas/PACKAGE' discriminator: propertyName: pricingType required: - pricingType billingFrequency: $ref: '#/components/schemas/BillingFrequency' description: The recurrence of charging this price. billingType: $ref: '#/components/schemas/BillingType' description: 'How to bill this price: in-arrears or in-advance.' createdAt: type: string description: Creation timestamp. Formatted as an ISO 8601 timestamp. example: '2021-08-25T12:00:00Z' updatedAt: type: string description: >- Timestamp when price was last updated. Formatted as an ISO 8601 timestamp. example: '2021-08-25T12:00:00Z' integrationIds: type: array description: Alternate IDs for this price in third-party integration systems example: - service: Xero id: '123' isPending: false items: $ref: '#/components/schemas/IntegrationId' 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: $ref: '#/components/schemas/PriceParameter' listPriceId: type: string description: >- The list price ID, if this quote price variant was created from a list price example: b4d7e884-e007-4183-8355-4771865c5100 QuoteDiscount: 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 restrictToPrices: type: array description: Price IDs the discount is restricted to example: - 5100e884-e007-4183-8355-4771865cb4d7 items: type: string amount: type: string description: Discount amount example: '50' discountCalculationType: $ref: '#/components/schemas/DiscountCalculationType' description: Indicates whether the discount amount is percentage or nominal message: type: string description: Message to appear on the quote or invoice example: message createdAt: type: string description: Created at example: '2021-08-25T12:00:00Z' updatedAt: type: string description: Updated at example: '2021-08-25T12:00:00Z' seatDiscountType: $ref: '#/components/schemas/SeatDiscountType' description: Determines how the discount is applied to any seat-based prices QuoteMinimum: 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 amount: type: string description: Minimum amount example: '50' restrictToPrices: type: array description: Price IDs the minimum is restricted to example: - 5100e884-e007-4183-8355-4771865cb4d7 items: type: string createdAt: type: string description: Created at example: '2021-08-25T12:00:00Z' updatedAt: type: string description: Updated at example: '2021-08-25T12:00:00Z' State: 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 CountryCode: 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 AssetType: type: string example: IMAGE enum: - IMAGE - DOCUMENT - BINARY AssetFormat: type: string example: PNG enum: - JPEG - JPG - PNG - PDF - CSV - TXT - RTF - MD - XLS - XLSX - XLSM - DOC - DOCX - ZIP - ODT - ODS 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 example: price: '150.00' pricingType: ONE_TIME type: object required: - price - 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 example: price: '20.00' pricingType: FIXED type: object required: - price - 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 example: pricePerUnit: '0.25' usageMetricId: 04c62961-04ba-48e6-b985-758bb7d3e712 isPricePercentage: false pricingType: LINEAR type: object required: - isPricePercentage - pricePerUnit - pricingType - usageMetricId 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: $ref: '#/components/schemas/SeatProrationStrategy' 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: $ref: '#/components/schemas/OveragesFrequency' description: The frequency with which to charge overages tiers: items: $ref: '#/components/schemas/SeatUsageTier' 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: 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 nullable: true pricingType: enum: - SEAT_BASED example: SEAT_BASED type: string 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 type: object required: - contractedMinimumSeats - pricePerSeat - pricingType - prorationStrategy - seatMetricId - tiers GRADUATED: properties: tiers: items: $ref: '#/components/schemas/GraduatedUsageTier' 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: $ref: '#/components/schemas/UsageCalculationMode' description: Indicates the scope of usage calculation pricingType: enum: - GRADUATED example: GRADUATED type: string 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 type: object required: - pricingType - tiers - usageCalculationMode - usageMetricId VOLUME: properties: tiers: items: $ref: '#/components/schemas/VolumeUsageTier' 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 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 type: object required: - pricingType - tiers - usageMetricId 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 example: packageSize: '50' pricePerPackage: '2.00' usageMetricId: 04c62961-04ba-48e6-b985-758bb7d3e712 pricingType: PACKAGE type: object required: - packageSize - pricePerPackage - pricingType - usageMetricId BillingFrequency: type: string example: MONTHLY enum: - ON_DEMAND - ONE_TIME - MONTHLY - QUARTERLY - HALF_YEARLY - YEARLY - PER_EVENT BillingType: type: string example: IN_ARREARS enum: - IN_ARREARS - IN_ADVANCE IntegrationId: required: - id - isPending - service type: object example: service: Xero id: '123' isPending: false properties: service: $ref: '#/components/schemas/IntegrationService' id: type: string example: '123' isPending: type: boolean example: false PriceParameter: 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' DiscountCalculationType: type: string example: PERCENTAGE enum: - PERCENTAGE - NOMINAL SeatDiscountType: type: string example: ALL_SEATS enum: - INCLUDED_SEATS_ONLY - OVERAGE_SEATS_ONLY - ALL_SEATS SeatProrationStrategy: example: USE_MAXIMUM enum: - USE_MAXIMUM - PRORATE_INCREMENTS - PRORATE_ALL_CHANGES type: string nullable: false OveragesFrequency: example: YEARLY enum: - NONE - MONTHLY - QUARTERLY - HALF_YEARLY - YEARLY type: string nullable: true SeatUsageTier: properties: upperBound: 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 nullable: true 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: example: '50.00' description: The nominal fee associated with usage at this tier type: string nullable: true example: upperBound: '100' price: '1.00' fee: '50.00' type: object required: - price GraduatedUsageTier: properties: upperBound: 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 nullable: true 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: example: '50.00' description: The nominal fee associated with usage at this tier type: string nullable: true 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 UsageCalculationMode: example: BILLING_PERIOD enum: - BILLING_PERIOD - CUMULATIVE - PERIODIC type: string nullable: false VolumeUsageTier: properties: upperBound: 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 nullable: true 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: example: '50.00' description: The nominal fee associated with usage at this tier type: string nullable: true 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: example: '10' description: Maximum Price to Charge for each Unit if Price is Percentage Based type: string nullable: true minPrice: example: '5' description: Minimum Price to Charge for each Unit if Price is Percentage Based type: string nullable: true example: upperBound: '100' price: '1.00' fee: '50.00' isPricePercentage: true maxPrice: '10' minPrice: '5' type: object required: - isPricePercentage - price IntegrationService: 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 ````