{ "openapi" : "3.0.0", "info" : { "title" : "", "description" : "", "version" : "" }, "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" } ], "tags" : [ { "name" : "Quotes" }, { "name" : "Quote Templates" } ], "paths" : { "/quotes" : { "get" : { "tags" : [ "Quotes" ], "summary" : "List quotes", "description" : "List all of your quotes", "operationId" : "getQuotes", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "customerId", "in" : "query", "description" : "Filter by customer id.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "includeArchived", "in" : "query", "description" : "Include archived quotes in results", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "status", "in" : "query", "description" : "Filter by quote status.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "createdBy", "in" : "query", "description" : "Filter by quote owner. Accepts a comma-separated list of user ids.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "title", "in" : "query", "description" : "Filter by quote title (case-insensitive partial match).", "required" : false, "schema" : { "type" : "string" } }, { "name" : "hasActiveApprovalWorkflow", "in" : "query", "description" : "Filter by whether the quote has an active approval workflow. True returns only quotes with active approvals, false returns only quotes without.", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "sortBy", "in" : "query", "description" : "Sort quotes by a field. Currently supports `acceptedAt` (signature date). Omit for the default newest-first order.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sortOrder", "in" : "query", "description" : "Sort direction, `ASC` or `DESC`. Defaults to `DESC`.", "required" : false, "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListQuoteEndpointListQuotePaginatedResponseModel", "example" : { "items" : [ { "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" : "DRAFT", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "acceptedAt" : "2022-06-28T16:47:00Z", "executedAt" : "2022-06-28T16:47:00Z", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "billingScheduleId" : "08a76ddb-230e-4700-a5e2-70f6edaf7d50", "expiryDays" : 30, "archivedAt" : "2022-06-28T16:47:00Z", "isExpired" : true } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } }, "examples" : { "ListQuoteEndpointListQuotePaginatedResponseModel" : { "summary" : "", "value" : { "items" : [ { "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" : "DRAFT", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "acceptedAt" : "2022-06-28T16:47:00Z", "executedAt" : "2022-06-28T16:47:00Z", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "billingScheduleId" : "08a76ddb-230e-4700-a5e2-70f6edaf7d50", "expiryDays" : 30, "archivedAt" : "2022-06-28T16:47:00Z", "isExpired" : true } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}" : { "get" : { "tags" : [ "Quotes" ], "summary" : "Get one of your quotes", "description" : "Get a quote by ID including its phases", "operationId" : "getQuotesById", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicQuoteApiResponse", "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" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } }, "examples" : { "PublicQuoteApiResponse" : { "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", "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "Quotes" ], "summary" : "Update one of your quotes", "description" : "Update a quote including its phases", "operationId" : "putQuotesById", "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" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicUpdateQuoteRequestModel", "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 } }, "examples" : { "PublicUpdateQuoteRequestModel" : { "summary" : "", "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 } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicQuoteApiResponse", "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" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } }, "examples" : { "PublicQuoteApiResponse" : { "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", "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}/published" : { "get" : { "tags" : [ "Quotes" ], "summary" : "Get a published quote", "description" : "Get the latest published version of a quote by ID", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicPublishedQuote", "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" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "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" } ] } ], "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" } ] } ], "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, "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", "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" } }, "examples" : { "PublicPublishedQuote" : { "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", "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "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" } ] } ], "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" } ] } ], "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, "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", "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" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/from-template/{id}" : { "post" : { "tags" : [ "Quotes" ], "summary" : "Create a quote from a template", "description" : "Create a new quote from a quote template", "operationId" : "postQuotesFromTemplateById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Quote Template 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" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateQuoteFromTemplateRequestModel", "example" : { "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "preliminaryBillingStartDate" : "2022-10-01", "defaultDueDateDays" : 30, "integrationIds" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF" } ], "salesforceOpportunityId" : "a00Hr00001BiFbjIAF", "ownerId" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "phases" : [ { "name" : "My 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" ], "counterSignerIds" : [ "0190dae7-7228-7619-aad8-c51f56733b2b" ], "attachmentAssetIds" : [ "0191761e-197f-79b6-b30a-012b54eae71b" ] } }, "examples" : { "CreateQuoteFromTemplateRequestModel" : { "summary" : "", "value" : { "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "preliminaryBillingStartDate" : "2022-10-01", "defaultDueDateDays" : 30, "integrationIds" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF" } ], "salesforceOpportunityId" : "a00Hr00001BiFbjIAF", "ownerId" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "phases" : [ { "name" : "My 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" ], "counterSignerIds" : [ "0190dae7-7228-7619-aad8-c51f56733b2b" ], "attachmentAssetIds" : [ "0191761e-197f-79b6-b30a-012b54eae71b" ] } } } } }, "required" : false }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicQuoteApiResponse", "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" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } }, "examples" : { "PublicQuoteApiResponse" : { "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", "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{quoteId}/send-reminders" : { "post" : { "tags" : [ "Quotes" ], "summary" : "Send reminder emails", "description" : "Send reminder emails to all unsigned participants. The latest version must be published.", "operationId" : "postQuotesByQuoteIdSendReminders", "parameters" : [ { "name" : "quoteId", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}/publish" : { "post" : { "tags" : [ "Quotes" ], "summary" : "Publish a quote", "description" : "Publishes the quote directly, or triggers the account's active quote approval workflow instead if one is configured.", "operationId" : "postQuotesByIdPublish", "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" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublishQuoteRequestBody", "example" : { "sendRecipientsEmail" : true, "emailMessage" : "Here's your quote", "makeReadyToSign" : true, "messageForApprover" : "Please can you take a look at this quote" } }, "examples" : { "PublishQuoteRequestBody" : { "summary" : "", "value" : { "sendRecipientsEmail" : true, "emailMessage" : "Here's your quote", "makeReadyToSign" : true, "messageForApprover" : "Please can you take a look at this quote" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublishQuoteResponseBody", "example" : { "outcome" : "PUBLISHED" } }, "examples" : { "PublishQuoteResponseBody" : { "summary" : "", "value" : { "outcome" : "PUBLISHED" } } } } } }, "409" : { "description" : "Conflict", "content" : { } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}/accept" : { "post" : { "tags" : [ "Quotes" ], "summary" : "Accept a published Quote", "description" : "Mark a quote as signed. This endpoint is disabled when e-signatures are active. The quote dashboard must be used instead.", "operationId" : "postQuotesByIdAccept", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicPublishedQuote", "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" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "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" } ] } ], "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" } ] } ], "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, "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", "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" } }, "examples" : { "PublicPublishedQuote" : { "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", "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "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" } ] } ], "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" } ] } ], "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, "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", "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" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quote-templates" : { "get" : { "tags" : [ "Quote Templates" ], "summary" : "List quote templates", "description" : "List quote templates for Sequence account", "operationId" : "getQuoteTemplates", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "createdBy", "in" : "query", "description" : "Filter by template owner", "required" : false, "schema" : { "type" : "string" } }, { "name" : "currency", "in" : "query", "description" : "Filter by quote template currency", "required" : false, "schema" : { "type" : "string" } }, { "name" : "dealType", "in" : "query", "description" : "Filter by quote template deal type", "required" : false, "schema" : { "type" : "string" } }, { "name" : "includeArchived", "in" : "query", "description" : "Include archived quote templates in results", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicQuoteTemplatesResponse", "example" : { "items" : [ { "id" : "678ca125-8bc3-478f-9a96-6ba73605cf1e", "createdBy" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "defaultDueDateDays" : 30, "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2022-06-28T16:47:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } }, "examples" : { "PublicQuoteTemplatesResponse" : { "summary" : "", "value" : { "items" : [ { "id" : "678ca125-8bc3-478f-9a96-6ba73605cf1e", "createdBy" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "defaultDueDateDays" : 30, "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2022-06-28T16:47:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}/analytics" : { "get" : { "tags" : [ "Quotes" ], "summary" : "Get quote analytics", "description" : "Retrieve view tracking analytics for a quote", "operationId" : "getQuotesByIdAnalytics", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetQuoteViewTrackingResponse", "example" : { "totalViews" : 42, "uniqueViewers" : [ { "visitorIdentifier" : "0190dae7-7228-7619-aad8-c51f56733b2b", "lastViewedAt" : "2024-01-07T10:30:00Z", "loginType" : "SEQUENCE_USER", "email" : "johndoe@example.com" } ], "viewsByDay" : [ { "date" : "2024-01-07", "totalViews" : 15 } ] } }, "examples" : { "GetQuoteViewTrackingResponse" : { "summary" : "", "value" : { "totalViews" : 42, "uniqueViewers" : [ { "visitorIdentifier" : "0190dae7-7228-7619-aad8-c51f56733b2b", "lastViewedAt" : "2024-01-07T10:30:00Z", "loginType" : "SEQUENCE_USER", "email" : "johndoe@example.com" } ], "viewsByDay" : [ { "date" : "2024-01-07", "totalViews" : 15 } ] } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}/archive" : { "post" : { "tags" : [ "Quotes" ], "summary" : "Archive a quote", "description" : "Mark a quote as archived", "operationId" : "postQuotesByIdArchive", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QuoteApiResponse", "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" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } }, "examples" : { "QuoteApiResponse" : { "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" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" : { } } ] } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] }, "/quotes/{id}/download" : { "get" : { "tags" : [ "Quotes" ], "summary" : "Download quote PDF", "description" : "Download the PDF for the latest published variant of a quote", "operationId" : "getQuotesByIdDownload", "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" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { } } } }, "servers" : [ ], "parameters" : [ ] } }, "components" : { "schemas" : { "ListQuoteEndpointListQuotePaginatedResponseModel" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "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" : "DRAFT", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "acceptedAt" : "2022-06-28T16:47:00Z", "executedAt" : "2022-06-28T16:47:00Z", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "billingScheduleId" : "08a76ddb-230e-4700-a5e2-70f6edaf7d50", "expiryDays" : 30, "archivedAt" : "2022-06-28T16:47:00Z", "isExpired" : true } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "properties" : { "items" : { "type" : "array", "description" : "Quotes", "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" : "DRAFT", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "acceptedAt" : "2022-06-28T16:47:00Z", "executedAt" : "2022-06-28T16:47:00Z", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "billingScheduleId" : "08a76ddb-230e-4700-a5e2-70f6edaf7d50", "expiryDays" : 30, "archivedAt" : "2022-06-28T16:47:00Z", "isExpired" : true } ], "items" : { "$ref" : "#/components/schemas/ListQuoteEndpointListQuoteResponseModel" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationMeta" } } }, "ListQuoteEndpointListQuoteResponseModel" : { "required" : [ "createdAt", "createdBy", "id", "isExpired", "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" : "DRAFT", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "acceptedAt" : "2022-06-28T16:47:00Z", "executedAt" : "2022-06-28T16:47:00Z", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "billingScheduleId" : "08a76ddb-230e-4700-a5e2-70f6edaf7d50", "expiryDays" : 30, "archivedAt" : "2022-06-28T16:47:00Z", "isExpired" : true }, "properties" : { "id" : { "type" : "string", "description" : "Quote ID", "example" : "678ca125-8bc3-478f-9a96-6ba73605cf1e" }, "createdBy" : { "type" : "string", "description" : "The Sequence User to which this Quote belongs", "example" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da" }, "customerId" : { "type" : "string", "description" : "Customer ID", "nullable" : true, "example" : "377bf97b-ca1d-4538-be06-4022afa6bde3" }, "quoteNumber" : { "type" : "string", "description" : "An alpha-numeric value that identifies the quote. Leave blank for an auto-generated incrementing quote number.", "example" : "Q00001" }, "title" : { "type" : "string", "description" : "The quote title", "nullable" : true, "example" : "My quote" }, "currency" : { "description" : "Quote currency", "nullable" : true, "$ref" : "#/components/schemas/Currency" }, "status" : { "description" : "The status of the quote", "$ref" : "#/components/schemas/QuoteStatus" }, "dealType" : { "description" : "Quote deal type", "nullable" : true, "$ref" : "#/components/schemas/QuoteDealType" }, "amendment" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteAmendmentSummaryResponseModel" }, "preliminaryBillingStartDate" : { "type" : "string", "description" : "Preliminary start date of contract", "nullable" : true, "example" : "2022-10-01" }, "expiresAt" : { "type" : "string", "description" : "Date when quote expires", "nullable" : true, "example" : "2022-10-01" }, "publishedAt" : { "type" : "string", "description" : "Date when quote was published", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "acceptedAt" : { "type" : "string", "description" : "Date when quote was accepted", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "executedAt" : { "type" : "string", "description" : "Date when quote was executed", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "createdAt" : { "type" : "string", "description" : "Created at", "example" : "2022-06-28T16:47:00Z" }, "updatedAt" : { "type" : "string", "description" : "Updated at", "example" : "2022-06-28T16:47:00Z" }, "billingScheduleId" : { "type" : "string", "description" : "Billing schedule ID associated with this quote, if executed", "nullable" : true, "example" : "08a76ddb-230e-4700-a5e2-70f6edaf7d50" }, "expiryDays" : { "type" : "integer", "description" : "Number of days after publishing in which quote will expire", "format" : "int32", "nullable" : true, "example" : 30 }, "archivedAt" : { "type" : "string", "description" : "Date and time the quote was archived", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "isExpired" : { "type" : "boolean", "description" : "True if the quote expiry date has passed", "example" : true } } }, "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" : "AMENDMENT", "enum" : [ "NEW_BUSINESS", "RENEWAL", "AMENDMENT" ] }, "QuoteAmendmentSummaryResponseModel" : { "required" : [ "billingScheduleId", "effectiveFrom" ], "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-12-31", "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" : "Date from which the amendment's changes take effect on the billing schedule", "example" : "2022-11-01" }, "executableUntil" : { "type" : "string", "description" : "The last day this amendment can be executed: the end of the original schedule's phase that `effectiveFrom` falls in. Left out when that phase has no end, or when the schedule is milestone-based.", "nullable" : true, "example" : "2022-12-31" }, "supersededByQuoteId" : { "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.", "nullable" : true, "example" : "0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b" }, "outForSignatureQuoteId" : { "type" : "string", "description" : "Read-only. Another quote for the same billing schedule that is out for signature, or accepted but not yet executed.", "nullable" : true, "example" : "0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c" } } }, "PaginationMeta" : { "type" : "object", "description" : "Results pagination", "example" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 }, "properties" : { "after" : { "type" : "string", "description" : "Cursor for the page after this (if it exists)", "nullable" : true, "example" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3" }, "before" : { "type" : "string", "description" : "Cursor for the page before this (if it exists)", "nullable" : true, "example" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz" }, "totalResultSize" : { "type" : "integer", "description" : "Total number of entries across all pages", "format" : "int64", "nullable" : true, "example" : 10 } } }, "PublicUpdateQuoteRequestModel" : { "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" : { "customerId" : { "type" : "string", "description" : "ID of Customer to which this quote pertains", "nullable" : true, "example" : "377bf97b-ca1d-4538-be06-4022afa6bde3" }, "title" : { "type" : "string", "description" : "The quote title", "nullable" : true, "example" : "My updated quote" }, "currency" : { "description" : "Quote currency", "nullable" : true, "$ref" : "#/components/schemas/Currency" }, "dealType" : { "description" : "Quote deal type", "nullable" : true, "$ref" : "#/components/schemas/QuoteDealType" }, "amendment" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteAmendmentRequestModel" }, "preliminaryBillingStartDate" : { "type" : "string", "description" : "Preliminary start date of contract", "nullable" : true, "example" : "2022-10-01" }, "expiryDays" : { "type" : "integer", "description" : "Number of days after publishing in which quote will expire", "format" : "int32", "nullable" : true, "example" : 30 }, "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" : { "$ref" : "#/components/schemas/CreateQuotePhaseRequest" } }, "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" } }, "ccContactIds" : { "type" : "array", "description" : "IDs of contacts who receive emails about this quote but do not sign it", "nullable" : true, "example" : [ "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cd" ], "items" : { "type" : "string" } }, "counterSignerIds" : { "type" : "array", "description" : "IDs of internal counter signers who will receive this quote (and sign this quote if using e-signatures)", "nullable" : true, "example" : [ "0190dae7-7228-7619-aad8-c51f56733b2b" ], "items" : { "type" : "string" } }, "integrationIds" : { "type" : "array", "description" : "IDs of external entities that are linked to this quote", "nullable" : true, "example" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "salesforceOpportunityId" : { "type" : "string", "description" : "Salesforce ID of the opportunity that created this quote", "nullable" : true, "example" : "a00Hr00001BiFbjIAF" }, "attachmentAssetIds" : { "type" : "array", "description" : "IDs of assets that are attached to this quote", "nullable" : true, "example" : [ "0191761e-197f-79b6-b30a-012b54eae71b" ], "items" : { "type" : "string" } }, "defaultDueDateDays" : { "type" : "integer", "description" : "Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.", "nullable" : true, "example" : 30 } } }, "QuoteAmendmentRequestModel" : { "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" }, "effectiveFrom" : { "type" : "string", "description" : "Date from which the amendment's changes take effect on the billing schedule", "example" : "2022-11-01" } } }, "CreateQuotePhaseRequest" : { "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" : { "name" : { "type" : "string", "description" : "Optional name of phase", "nullable" : true, "example" : "My new phase" }, "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" : { "$ref" : "#/components/schemas/CreateQuotePriceRequest" } }, "duration" : { "nullable" : true, "$ref" : "#/components/schemas/Duration" }, "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" : { "$ref" : "#/components/schemas/CreateQuoteDiscountRequest" } }, "minimums" : { "type" : "array", "description" : "Minimums within this phase", "example" : [ { "restrictToPrices" : [ "5100e884-e007-4183-8355-4771865cb4d7" ], "amount" : "50" } ], "items" : { "$ref" : "#/components/schemas/CreateQuoteMinimumRequest" } } } }, "CreateQuotePriceRequest" : { "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" }, "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" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "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", "nullable" : true, "example" : "b4d7e884-e007-4183-8355-4771865c5100" } } }, "OneTimePricingStructure" : { "required" : [ "price", "pricingType" ], "type" : "object", "description" : "The pricing structure", "example" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "properties" : { "price" : { "type" : "string", "description" : "A fixed amount that is charged once.", "example" : "150.00" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/PricingType" } } }, "PricingType" : { "example" : "ONE_TIME", "enum" : [ "ONE_TIME", "FIXED", "LINEAR", "PACKAGE", "GRADUATED", "VOLUME", "SEAT_BASED" ], "type" : "string", "nullable" : false }, "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" ] }, "GenerateIntegrationIdRequest" : { "required" : [ "id", "service" ], "type" : "object", "example" : { "service" : "Xero", "id" : "123" }, "properties" : { "service" : { "$ref" : "#/components/schemas/IntegrationService" }, "id" : { "type" : "string", "example" : "123" } } }, "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" ] }, "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" } } }, "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 } } }, "CreateQuoteDiscountRequest" : { "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" } }, "type" : { "$ref" : "#/components/schemas/DiscountCalculationType" }, "amount" : { "type" : "string", "example" : "50" }, "message" : { "type" : "string", "example" : "message" }, "seatDiscountType" : { "nullable" : true, "$ref" : "#/components/schemas/SeatDiscountType" } } }, "DiscountCalculationType" : { "type" : "string", "example" : "PERCENTAGE", "enum" : [ "PERCENTAGE", "NOMINAL" ] }, "SeatDiscountType" : { "type" : "string", "example" : "ALL_SEATS", "enum" : [ "INCLUDED_SEATS_ONLY", "OVERAGE_SEATS_ONLY", "ALL_SEATS" ] }, "CreateQuoteMinimumRequest" : { "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" } }, "amount" : { "type" : "string", "example" : "50" } } }, "PublicQuoteApiResponse" : { "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" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" }, "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", "nullable" : true, "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", "nullable" : true, "example" : "My quote" }, "currency" : { "description" : "Quote currency", "nullable" : true, "$ref" : "#/components/schemas/Currency" }, "status" : { "description" : "The status of the quote", "$ref" : "#/components/schemas/QuoteStatus" }, "dealType" : { "description" : "Quote deal type", "nullable" : true, "$ref" : "#/components/schemas/QuoteDealType" }, "amendment" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteAmendmentResponseModel" }, "preliminaryBillingStartDate" : { "type" : "string", "description" : "Preliminary start date of contract", "nullable" : true, "example" : "2022-10-01" }, "expiresAt" : { "type" : "string", "description" : "Date when quote expires", "nullable" : true, "example" : "2022-10-01" }, "publishedAt" : { "type" : "string", "description" : "Timestamp when quote was published. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "readyToSignAt" : { "type" : "string", "description" : "Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "acceptedAt" : { "type" : "string", "description" : "Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "executedAt" : { "type" : "string", "description" : "Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.", "nullable" : true, "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" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteCreatedFrom" }, "salesforceOpportunityId" : { "type" : "string", "description" : "Salesforce ID of the opportunity that created this quote", "nullable" : true, "example" : "006Hr00001MfnEIIAZ" }, "expiryDays" : { "type" : "integer", "description" : "Number of days after publishing in which quote will expire", "format" : "int32", "nullable" : true, "example" : 30 }, "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" : -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" : { "$ref" : "#/components/schemas/QuotePhase" } }, "archivedAt" : { "type" : "string", "description" : "Date and time the quote was archived", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "approvalWorkflowId" : { "type" : "string", "description" : "The ID of the active approval workflow for this quote, if one is in progress", "nullable" : true, "example" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "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" } }, "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" : { "$ref" : "#/components/schemas/QuoteContact" } }, "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" } }, "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" : { "$ref" : "#/components/schemas/QuoteCcContact" } }, "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" : { "$ref" : "#/components/schemas/QuoteCounterSigner" } }, "isSignaturesEnabled" : { "type" : "boolean", "description" : "Enable e-signatures to allow customers to sign this quote through Dropbox Sign.", "example" : false }, "integrationIds" : { "type" : "array", "description" : "IDs of external entities that are linked to this quote", "example" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customerLegalName" : { "type" : "string", "description" : "Customer legal name", "nullable" : true, "example" : "Acme Corp" }, "customerAddress" : { "nullable" : true, "$ref" : "#/components/schemas/Address" }, "pdfStatus" : { "description" : "Status of quote PDF generation for this variant", "$ref" : "#/components/schemas/QuotePdfStatus" }, "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" : { "$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.", "nullable" : true, "example" : 30 }, "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.", "nullable" : true, "$ref" : "#/components/schemas/SignatureMode" }, "preparingSignatureRequestAt" : { "type" : "string", "description" : "Timestamp when quote ready-to-sign operation was triggered.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "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" : { "$ref" : "#/components/schemas/QuoteErrorResponse" } } } }, "QuoteAmendmentResponseModel" : { "required" : [ "billingScheduleId", "effectiveFrom" ], "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-12-31", "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" : "Date from which the amendment's changes take effect on the billing schedule", "example" : "2022-11-01" }, "executableUntil" : { "type" : "string", "description" : "Read-only. The last day this amendment can be executed: the end of the original schedule's phase that `effectiveFrom` falls in. Left out when that phase has no end, or when the schedule is milestone-based.", "nullable" : true, "example" : "2022-12-31" }, "original" : { "nullable" : true, "$ref" : "#/components/schemas/AmendmentScheduleResponseModel" }, "amended" : { "nullable" : true, "$ref" : "#/components/schemas/AmendmentScheduleResponseModel" }, "originalContractValue" : { "type" : "string", "description" : "Read-only. The total contract value before this amendment.", "nullable" : true, "example" : "12000" }, "amendedContractValue" : { "type" : "string", "description" : "Read-only. The total contract value of this quote.", "nullable" : true, "example" : "15500" }, "adjustmentTotal" : { "type" : "string", "description" : "Read-only. The amended contract value minus the original contract value.", "nullable" : true, "example" : "3500" }, "supersededByQuoteId" : { "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.", "nullable" : true, "example" : "0192a3b4-6d7e-7f80-9a1b-2c3d4e5f6a7b" }, "outForSignatureQuoteId" : { "type" : "string", "description" : "Read-only. Another quote for the same billing schedule that is out for signature, or accepted but not yet executed.", "nullable" : true, "example" : "0192a3b4-7e8f-7a91-8b2c-3d4e5f6a7b8c" } } }, "AmendmentScheduleResponseModel" : { "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.", "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" : { "$ref" : "#/components/schemas/AmendmentPhaseResponseModel" } } } }, "AmendmentPhaseResponseModel" : { "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" : { "type" : "string", "description" : "Phase name", "nullable" : true, "example" : "Year 1" }, "startDate" : { "type" : "string", "description" : "The date the phase starts", "example" : "2022-01-01" }, "endDate" : { "type" : "string", "description" : "The date the phase ends, or absent when the phase is open-ended", "nullable" : true, "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" : { "$ref" : "#/components/schemas/AmendmentPriceResponseModel" } }, "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" : { "$ref" : "#/components/schemas/AmendmentDiscountResponseModel" } }, "minimums" : { "type" : "array", "description" : "The minimum commitments applied in the phase", "example" : [ { "amount" : "500", "productIds" : [ "e007e884-5100-4183-8355-4771865cb4dd" ] } ], "items" : { "$ref" : "#/components/schemas/AmendmentMinimumResponseModel" } } } }, "AmendmentPriceResponseModel" : { "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" : [ { "$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" : { "description" : "The recurrence of charging this price", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance", "$ref" : "#/components/schemas/BillingType" }, "usageCalculationPeriod" : { "nullable" : true, "$ref" : "#/components/schemas/UsageCalculationPeriod" }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "GraduatedPricingStructure" : { "required" : [ "pricingType", "tiers", "usageCalculationMode", "usageMetricId" ], "type" : "object", "description" : "The pricing structure", "example" : { "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" }, "properties" : { "tiers" : { "type" : "array", "description" : "A list of contiguous pricing tiers", "example" : [ { "upperBound" : "1000", "price" : "0.25", "fee" : "50", "isPricePercentage" : false }, { "price" : "0.1", "fee" : "0", "isPricePercentage" : false } ], "items" : { "$ref" : "#/components/schemas/GraduatedUsageTier" } }, "usageMetricId" : { "type" : "string", "description" : "The usage metric associated to this pricing structure", "example" : "04c62961-04ba-48e6-b985-758bb7d3e712" }, "usageCalculationMode" : { "description" : "Indicates the scope of usage calculation", "$ref" : "#/components/schemas/UsageCalculationMode" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/PricingType" } } }, "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 }, "UsageCalculationPeriod" : { "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" : { "description" : "Frequency determines the time period over which usage is aggregated.", "$ref" : "#/components/schemas/UsageCalculationFrequency" }, "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 } } }, "UsageCalculationFrequency" : { "type" : "string", "example" : "MONTHLY", "enum" : [ "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ] }, "AmendmentDiscountResponseModel" : { "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" : { "description" : "Indicates whether the discount amount is percentage or nominal", "$ref" : "#/components/schemas/DiscountCalculationType" }, "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" : { "description" : "Determines how the discount is applied to any seat-based prices", "nullable" : true, "$ref" : "#/components/schemas/SeatDiscountType" }, "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" } } } }, "AmendmentMinimumResponseModel" : { "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" } } } }, "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" } } }, "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" ] }, "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", "nullable" : true, "example" : "logo" }, "legalCompanyName" : { "type" : "string", "example" : "Acme Corp" }, "primaryColour" : { "type" : "string", "nullable" : true, "example" : "colour" }, "url" : { "type" : "string", "nullable" : true, "example" : "www.example.com" }, "address" : { "$ref" : "#/components/schemas/Address" }, "email" : { "type" : "string", "example" : "accounting@example.com" }, "showUsageInCustomerPortal" : { "type" : "boolean", "example" : true }, "supportEmail" : { "type" : "string", "nullable" : true, "example" : "support@example.com" }, "supportUrl" : { "type" : "string", "nullable" : true, "example" : "https://www.example.com/support" } } }, "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", "nullable" : true, "example" : "Suite 100" }, "town" : { "type" : "string", "description" : "Town or city", "example" : "San Francisco" }, "state" : { "description" : "State or province (required for USA and Canada)", "nullable" : true, "$ref" : "#/components/schemas/State" }, "postcode" : { "type" : "string", "description" : "Postal code", "example" : "94105" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" } } }, "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" ] }, "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" : -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" }, "name" : { "type" : "string", "description" : "Optional name of phase", "nullable" : true, "example" : "Onboarding" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2022-06-28T16:47:00Z" }, "duration" : { "nullable" : true, "$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" } } } }, "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" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "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", "nullable" : true, "example" : "b4d7e884-e007-4183-8355-4771865c5100" } } }, "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 } } }, "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" : { "description" : "Indicates whether the discount amount is percentage or nominal", "$ref" : "#/components/schemas/DiscountCalculationType" }, "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" : { "description" : "Determines how the discount is applied to any seat-based prices", "nullable" : true, "$ref" : "#/components/schemas/SeatDiscountType" } } }, "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" } } }, "QuoteContact" : { "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" }, "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.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "notificationHistory" : { "type" : "array", "description" : "Notifications this recipient received about this published quote, newest first", "example" : [ { "notifiedAt" : "2022-06-28T16:47:00Z", "trigger" : "PUBLISH" } ], "items" : { "$ref" : "#/components/schemas/QuoteRecipientNotificationHistoryItem" } } } }, "QuoteRecipientNotificationHistoryItem" : { "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" }, "trigger" : { "description" : "Which operation sent this notification", "$ref" : "#/components/schemas/QuoteNotificationTrigger" } } }, "QuoteNotificationTrigger" : { "type" : "string", "example" : "PUBLISH", "enum" : [ "PUBLISH", "READY_TO_SIGN", "SEND_REMINDERS" ] }, "QuoteCcContact" : { "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" }, "name" : { "type" : "string", "description" : "Full name of the cc recipient", "example" : "John Smith" }, "email" : { "type" : "string", "description" : "Email address of the cc recipient", "example" : "john@example.com" }, "notificationHistory" : { "type" : "array", "description" : "Notifications this recipient received about this published quote, newest first", "example" : [ { "notifiedAt" : "2022-06-28T16:47:00Z", "trigger" : "PUBLISH" } ], "items" : { "$ref" : "#/components/schemas/QuoteRecipientNotificationHistoryItem" } } } }, "QuoteCounterSigner" : { "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" }, "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.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "notificationHistory" : { "type" : "array", "description" : "Notifications this recipient received about this published quote, newest first", "example" : [ { "notifiedAt" : "2022-06-28T16:47:00Z", "trigger" : "PUBLISH" } ], "items" : { "$ref" : "#/components/schemas/QuoteRecipientNotificationHistoryItem" } } } }, "QuotePdfStatus" : { "type" : "string", "example" : "NOT_YET_REQUESTED", "enum" : [ "NOT_YET_REQUESTED", "REQUESTED", "IN_PROGRESS", "FAILED", "GENERATED" ] }, "AssetResponse" : { "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" }, "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" }, "createdByType" : { "description" : "Whether `createdBy` identifies a `SEQUENCE_USER` or an `API_CLIENT`", "$ref" : "#/components/schemas/AssetCreatorType" }, "type" : { "description" : "Either image or document", "$ref" : "#/components/schemas/AssetType" }, "format" : { "description" : "Identifies the intended data format. Allowed formats are: jpg, jpeg, png, and pdf", "$ref" : "#/components/schemas/AssetFormat" }, "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" } } }, "AssetCreatorType" : { "type" : "string", "example" : "SEQUENCE_USER", "enum" : [ "SEQUENCE_USER", "API_CLIENT" ] }, "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" ] }, "SignatureMode" : { "type" : "string", "example" : "EMBEDDED", "enum" : [ "EMBEDDED", "NON_EMBEDDED" ] }, "QuoteErrorResponse" : { "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" }, "errorCode" : { "description" : "Classified code describing what failed", "$ref" : "#/components/schemas/QuoteErrorCode" }, "recoveryAction" : { "description" : "The recourse an operator should take to recover from this error", "$ref" : "#/components/schemas/QuoteErrorRecoveryAction" }, "createdAt" : { "type" : "string", "description" : "When the error was recorded. Formatted as an ISO 8601 timestamp.", "example" : "2022-06-28T16:47:00Z" }, "errorContext" : { "type" : "object", "description" : "Structured context about the failure, shape depends on errorCode", "example" : { }, "additionalProperties" : { } } } }, "QuoteErrorCode" : { "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" ] }, "QuoteErrorRecoveryAction" : { "type" : "string", "example" : "CONTACT_SUPPORT", "enum" : [ "REPUBLISH", "REGENERATE_PDF", "MANUAL_EXECUTE", "RESEND_SIGNING_EMAIL", "RETRY_SIGNATURE_REQUEST", "CONTACT_SUPPORT" ] }, "PublicPublishedQuote" : { "required" : [ "attachmentAssets", "ccContacts", "contacts", "counterSigners", "createdAt", "createdBy", "currency", "customerAddress", "customerId", "customerLegalName", "dealType", "expiresAt", "id", "isExpired", "isSignaturesEnabled", "merchantBranding", "pdfStatus", "phases", "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", "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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", "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" } ] } ], "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" } ] } ], "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, "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", "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" }, "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" : { "description" : "Quote currency", "$ref" : "#/components/schemas/Currency" }, "status" : { "description" : "The status of the quote", "$ref" : "#/components/schemas/QuoteStatus" }, "dealType" : { "description" : "Quote deal type", "$ref" : "#/components/schemas/QuoteDealType" }, "amendment" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteAmendmentResponseModel" }, "preliminaryBillingStartDate" : { "type" : "string", "description" : "Preliminary start date of contract", "nullable" : true, "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.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "acceptedAt" : { "type" : "string", "description" : "Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "executedAt" : { "type" : "string", "description" : "Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.", "nullable" : true, "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" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteCreatedFrom" }, "salesforceOpportunityId" : { "type" : "string", "description" : "Salesforce ID of the opportunity that created this quote", "nullable" : true, "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" : -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" : { "$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", "notificationHistory" : [ { "notifiedAt" : "2022-06-28T16:47:00Z", "trigger" : "PUBLISH" } ] } ], "items" : { "$ref" : "#/components/schemas/QuoteContact" } }, "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" : { "$ref" : "#/components/schemas/QuoteCcContact" } }, "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" : { "$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" : { "description" : "Status of quote PDF generation for this variant", "$ref" : "#/components/schemas/QuotePdfStatus" }, "archivedAt" : { "type" : "string", "description" : "Date and time the quote was archived", "nullable" : true, "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", "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" : { "$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.", "nullable" : true, "example" : 30 }, "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.", "nullable" : true, "$ref" : "#/components/schemas/SignatureMode" }, "preparingSignatureRequestAt" : { "type" : "string", "description" : "Timestamp when quote ready-to-sign operation was triggered.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" } } }, "CreateQuoteFromTemplateRequestModel" : { "type" : "object", "example" : { "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "preliminaryBillingStartDate" : "2022-10-01", "defaultDueDateDays" : 30, "integrationIds" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF" } ], "salesforceOpportunityId" : "a00Hr00001BiFbjIAF", "ownerId" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "phases" : [ { "name" : "My 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" ], "counterSignerIds" : [ "0190dae7-7228-7619-aad8-c51f56733b2b" ], "attachmentAssetIds" : [ "0191761e-197f-79b6-b30a-012b54eae71b" ] }, "properties" : { "title" : { "type" : "string", "description" : "The quote title. Overrides the template's title when provided.", "nullable" : true, "example" : "My quote" }, "currency" : { "description" : "Quote currency. Overrides the template's currency when provided.", "nullable" : true, "$ref" : "#/components/schemas/Currency" }, "dealType" : { "description" : "Quote deal type. Overrides the template's deal type when provided.", "nullable" : true, "$ref" : "#/components/schemas/QuoteDealType" }, "expiryDays" : { "type" : "integer", "description" : "Number of days after publishing in which the quote will expire. Overrides the template's value when provided.", "format" : "int32", "nullable" : true, "example" : 30 }, "preliminaryBillingStartDate" : { "type" : "string", "description" : "Preliminary start date of the contract. A template does not carry one, so this sets the new quote's value.", "nullable" : true, "example" : "2022-10-01" }, "defaultDueDateDays" : { "type" : "integer", "description" : "Default number of days between issue date and due date. Passed onto a billing schedule created from the quote. Overrides the template's value when provided.", "nullable" : true, "example" : 30 }, "integrationIds" : { "type" : "array", "description" : "IDs of external entities that are linked to this quote.", "nullable" : true, "example" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "salesforceOpportunityId" : { "type" : "string", "description" : "Salesforce ID of the opportunity that created this quote.", "nullable" : true, "example" : "a00Hr00001BiFbjIAF" }, "ownerId" : { "type" : "string", "description" : "ID of the quote owner. Required when the request is not made by a Sequence user.", "nullable" : true, "example" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da" }, "phases" : { "type" : "array", "description" : "Phases for this quote, in sequential order. Replaces the template's phases entirely when provided.", "nullable" : true, "example" : [ { "name" : "My 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" : { "$ref" : "#/components/schemas/CreateQuotePhaseRequest" } }, "contactIds" : { "type" : "array", "description" : "IDs of contacts who will receive this quote (and sign this quote if using e-signatures).", "nullable" : true, "example" : [ "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc" ], "items" : { "type" : "string" } }, "counterSignerIds" : { "type" : "array", "description" : "IDs of internal counter signers who will receive this quote. Replaces the default counter signer when provided; send an empty list for no counter signers.", "nullable" : true, "example" : [ "0190dae7-7228-7619-aad8-c51f56733b2b" ], "items" : { "type" : "string" } }, "attachmentAssetIds" : { "type" : "array", "description" : "IDs of assets to attach to this quote. Merged with the template's attachments rather than replacing them.", "nullable" : true, "example" : [ "0191761e-197f-79b6-b30a-012b54eae71b" ], "items" : { "type" : "string" } } } }, "PublishQuoteRequestBody" : { "required" : [ "makeReadyToSign", "sendRecipientsEmail" ], "type" : "object", "example" : { "sendRecipientsEmail" : true, "emailMessage" : "Here's your quote", "makeReadyToSign" : true, "messageForApprover" : "Please can you take a look at this quote" }, "properties" : { "sendRecipientsEmail" : { "type" : "boolean", "description" : "If true Sequence will send an email to all quote recipients notifying them of the published quote", "example" : true }, "emailMessage" : { "type" : "string", "description" : "Optional message to include in email body", "nullable" : true, "example" : "Here's your quote" }, "makeReadyToSign" : { "type" : "boolean", "description" : "If true the quote is made ready to sign as part of publishing. An amendment quote is still published, but not made ready to sign, while another quote for the same billing schedule is out for signature or accepted but not yet executed; the published quote then names that quote in amendment.outForSignatureQuoteId.", "example" : true }, "messageForApprover" : { "type" : "string", "description" : "Optional comment for the approver, used when the account requires quote approval", "nullable" : true, "example" : "Please can you take a look at this quote" } } }, "PublishQuoteResponseBody" : { "required" : [ "outcome" ], "type" : "object", "example" : { "outcome" : "PUBLISHED" }, "properties" : { "outcome" : { "description" : "Whether the quote was published directly, or sent into an approval flow", "$ref" : "#/components/schemas/PublishQuoteOutcome" } } }, "PublishQuoteOutcome" : { "type" : "string", "example" : "PUBLISHED", "enum" : [ "PUBLISHED", "APPROVAL_REQUESTED" ] }, "PublicQuoteTemplatesResponse" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "678ca125-8bc3-478f-9a96-6ba73605cf1e", "createdBy" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "defaultDueDateDays" : 30, "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2022-06-28T16:47:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "properties" : { "items" : { "type" : "array", "description" : "Quote templates", "example" : [ { "id" : "678ca125-8bc3-478f-9a96-6ba73605cf1e", "createdBy" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "defaultDueDateDays" : 30, "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2022-06-28T16:47:00Z" } ], "items" : { "$ref" : "#/components/schemas/PublicQuoteTemplate" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationMeta" } } }, "PublicQuoteTemplate" : { "required" : [ "createdAt", "createdBy", "id", "updatedAt" ], "type" : "object", "example" : { "id" : "678ca125-8bc3-478f-9a96-6ba73605cf1e", "createdBy" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da", "title" : "My quote", "currency" : "GBP", "dealType" : "NEW_BUSINESS", "expiryDays" : 30, "defaultDueDateDays" : 30, "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "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 template", "example" : "4ffd439e-32e5-4046-bb40-3cb81f40e5da" }, "title" : { "type" : "string", "description" : "The quote title", "nullable" : true, "example" : "My quote" }, "currency" : { "description" : "Quote currency", "nullable" : true, "$ref" : "#/components/schemas/Currency" }, "dealType" : { "description" : "Quote deal type", "nullable" : true, "$ref" : "#/components/schemas/QuoteDealType" }, "expiryDays" : { "type" : "integer", "description" : "Number of days after publishing in which quote will expire", "format" : "int32", "nullable" : true, "example" : 30 }, "defaultDueDateDays" : { "type" : "integer", "description" : "Default number of days between issue date and due date for quotes created from this template. Null means the quote inherits the account default.", "nullable" : true, "example" : 30 }, "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" }, "archivedAt" : { "type" : "string", "description" : "Date and time the quote was archived. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" } } }, "GetQuoteViewTrackingResponse" : { "required" : [ "totalViews", "uniqueViewers", "viewsByDay" ], "type" : "object", "example" : { "totalViews" : 42, "uniqueViewers" : [ { "visitorIdentifier" : "0190dae7-7228-7619-aad8-c51f56733b2b", "lastViewedAt" : "2024-01-07T10:30:00Z", "loginType" : "SEQUENCE_USER", "email" : "johndoe@example.com" } ], "viewsByDay" : [ { "date" : "2024-01-07", "totalViews" : 15 } ] }, "properties" : { "totalViews" : { "type" : "integer", "format" : "int32", "example" : 42 }, "uniqueViewers" : { "type" : "array", "example" : [ { "visitorIdentifier" : "0190dae7-7228-7619-aad8-c51f56733b2b", "lastViewedAt" : "2024-01-07T10:30:00Z", "loginType" : "SEQUENCE_USER", "email" : "johndoe@example.com" } ], "items" : { "$ref" : "#/components/schemas/UniqueViewerResponse" } }, "viewsByDay" : { "type" : "array", "example" : [ { "date" : "2024-01-07", "totalViews" : 15 } ], "items" : { "$ref" : "#/components/schemas/DailyQuoteViewTotalResponse" } } } }, "UniqueViewerResponse" : { "required" : [ "lastViewedAt", "loginType", "visitorIdentifier" ], "type" : "object", "example" : { "visitorIdentifier" : "0190dae7-7228-7619-aad8-c51f56733b2b", "lastViewedAt" : "2024-01-07T10:30:00Z", "loginType" : "SEQUENCE_USER", "email" : "johndoe@example.com" }, "properties" : { "visitorIdentifier" : { "type" : "string", "example" : "0190dae7-7228-7619-aad8-c51f56733b2b" }, "lastViewedAt" : { "type" : "string", "example" : "2024-01-07T10:30:00Z" }, "loginType" : { "type" : "string", "example" : "SEQUENCE_USER" }, "email" : { "type" : "string", "nullable" : true, "example" : "johndoe@example.com" } } }, "DailyQuoteViewTotalResponse" : { "required" : [ "date", "totalViews" ], "type" : "object", "example" : { "date" : "2024-01-07", "totalViews" : 15 }, "properties" : { "date" : { "type" : "string", "example" : "2024-01-07" }, "totalViews" : { "type" : "integer", "format" : "int32", "example" : 15 } } }, "QuoteApiResponse" : { "required" : [ "activeErrors", "attachmentAssets", "ccContactIds", "ccContacts", "contactIds", "contacts", "counterSigners", "createdAt", "createdBy", "id", "integrationIds", "isExpired", "isSignaturesEnabled", "merchantBranding", "pdfStatus", "phases", "presentation", "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", "presentation" : [ ], "status" : "ACCEPTED", "dealType" : "AMENDMENT", "amendment" : { "billingScheduleId" : "0192a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "effectiveFrom" : "2022-11-01", "executableUntil" : "2022-12-31", "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" }, "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", "nullable" : true, "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", "nullable" : true, "example" : "My quote" }, "currency" : { "description" : "Quote currency", "nullable" : true, "$ref" : "#/components/schemas/Currency" }, "presentation" : { "type" : "array", "description" : "JSON for the visual presentation of the quote", "example" : [ ], "items" : { } }, "status" : { "description" : "The status of the quote", "$ref" : "#/components/schemas/QuoteStatus" }, "dealType" : { "description" : "Quote deal type", "nullable" : true, "$ref" : "#/components/schemas/QuoteDealType" }, "amendment" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteAmendmentResponseModel" }, "preliminaryBillingStartDate" : { "type" : "string", "description" : "Preliminary start date of contract", "nullable" : true, "example" : "2022-10-01" }, "expiresAt" : { "type" : "string", "description" : "Date when quote expires", "nullable" : true, "example" : "2022-10-01" }, "publishedAt" : { "type" : "string", "description" : "Timestamp when quote was published. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "readyToSignAt" : { "type" : "string", "description" : "Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "acceptedAt" : { "type" : "string", "description" : "Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "executedAt" : { "type" : "string", "description" : "Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.", "nullable" : true, "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" : { "nullable" : true, "$ref" : "#/components/schemas/QuoteCreatedFrom" }, "salesforceOpportunityId" : { "type" : "string", "description" : "Salesforce ID of the opportunity that created this quote", "nullable" : true, "example" : "006Hr00001MfnEIIAZ" }, "expiryDays" : { "type" : "integer", "description" : "Number of days after publishing in which quote will expire", "format" : "int32", "nullable" : true, "example" : 30 }, "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" : -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" : { "$ref" : "#/components/schemas/QuotePhase" } }, "archivedAt" : { "type" : "string", "description" : "Date and time the quote was archived", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "approvalWorkflowId" : { "type" : "string", "description" : "The ID of the active approval workflow for this quote, if one is in progress", "nullable" : true, "example" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "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" } }, "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" : { "$ref" : "#/components/schemas/QuoteContact" } }, "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" } }, "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" : { "$ref" : "#/components/schemas/QuoteCcContact" } }, "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" : { "$ref" : "#/components/schemas/QuoteCounterSigner" } }, "isSignaturesEnabled" : { "type" : "boolean", "description" : "Enable e-signatures to allow customers to sign this quote through Dropbox Sign.", "example" : false }, "integrationIds" : { "type" : "array", "description" : "IDs of external entities that are linked to this quote", "example" : [ { "service" : "Salesforce", "id" : "a00Hr00001BiFbjIAF", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customerLegalName" : { "type" : "string", "description" : "Customer legal name", "nullable" : true, "example" : "Acme Corp" }, "customerAddress" : { "nullable" : true, "$ref" : "#/components/schemas/Address" }, "pdfStatus" : { "description" : "Status of quote PDF generation for this variant", "$ref" : "#/components/schemas/QuotePdfStatus" }, "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" : { "$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.", "nullable" : true, "example" : 30 }, "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.", "nullable" : true, "$ref" : "#/components/schemas/SignatureMode" }, "preparingSignatureRequestAt" : { "type" : "string", "description" : "Timestamp when quote ready-to-sign operation was triggered.", "nullable" : true, "example" : "2022-06-28T16:47:00Z" }, "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" : { "$ref" : "#/components/schemas/QuoteErrorResponse" } } } }, "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" ] }, "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" ] }, "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" ] }, "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" ] }, "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" ] } }, "requestBodies" : { }, "securitySchemes" : { } } }