Get the published version of one of your quotes
curl --request GET \
--url https://eu.sequencehq.com/api/quotes/{id}/published \
--header 'Authorization: <authorization>'import requests
url = "https://eu.sequencehq.com/api/quotes/{id}/published"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://eu.sequencehq.com/api/quotes/{id}/published', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.sequencehq.com/api/quotes/{id}/published",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eu.sequencehq.com/api/quotes/{id}/published"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eu.sequencehq.com/api/quotes/{id}/published")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.sequencehq.com/api/quotes/{id}/published")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"id": "678ca125-8bc3-478f-9a96-6ba73605cf1e",
"createdBy": "4ffd439e-32e5-4046-bb40-3cb81f40e5da",
"customerId": "377bf97b-ca1d-4538-be06-4022afa6bde3",
"quoteNumber": "Q00001",
"title": "My quote",
"currency": "GBP",
"presentation": [],
"status": "ACCEPTED",
"dealType": "NEW_BUSINESS",
"preliminaryBillingStartDate": "2022-10-01",
"expiresAt": "2022-10-01",
"publishedAt": "2022-06-28T16:47:00Z",
"readyToSignAt": "2022-06-28T16:47:00Z",
"acceptedAt": "2022-06-28T16:47:00Z",
"executedAt": "2022-06-28T16:47:00Z",
"createdAt": "2022-06-28T16:47:00Z",
"updatedAt": "2022-06-28T16:47:00Z",
"createdFrom": {
"entityType": "QUOTE",
"entityId": "dc0e2104-7df5-4fc1-8f65-1823f427d111"
},
"salesforceOpportunityId": "006Hr00001MfnEIIAZ",
"merchantBranding": {
"logoUrl": "logo",
"legalCompanyName": "Acme Corp",
"primaryColour": "colour",
"url": "www.example.com",
"address": {
"line1": "1 Market Street",
"line2": "Suite 100",
"town": "San Francisco",
"state": "CA",
"postcode": "94105",
"country": "US"
},
"email": "accounting@example.com",
"showUsageInCustomerPortal": true,
"supportEmail": "support@example.com",
"supportUrl": "https://www.example.com/support"
},
"phases": [
{
"id": "abe4bf01-9b75-495d-f5fd-ca82b001f3a8",
"name": "Onboarding",
"createdAt": "2022-06-28T16:47:00Z",
"duration": {
"days": 0,
"weeks": 0,
"months": 6,
"years": 1
},
"prices": [
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"price": "150.00",
"pricingType": "ONE_TIME"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"price": "20.00",
"pricingType": "FIXED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"pricePerUnit": "0.25",
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"isPricePercentage": false,
"pricingType": "LINEAR"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"seatMetricId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"pricePerSeat": "0.25",
"prorationStrategy": "USE_MAXIMUM",
"contractedMinimumSeats": 10,
"overagesBillingFrequency": "YEARLY",
"tiers": [
{
"upperBound": "100",
"price": "1.00",
"fee": "50.00"
},
{
"price": "0.75",
"fee": "25.00"
}
],
"prorateFlatFees": false,
"pricingType": "SEAT_BASED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"tiers": [
{
"upperBound": "200",
"price": "1.00",
"fee": "50.00",
"isPricePercentage": false
},
{
"upperBound": "400",
"price": "0.75",
"fee": "25.00",
"isPricePercentage": false
},
{
"price": "0.50",
"fee": "0.00",
"isPricePercentage": false
}
],
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"usageCalculationMode": "BILLING_PERIOD",
"pricingType": "GRADUATED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
"usageCalculationPeriod": {
"frequency": "MONTHLY",
"interval": 1
}
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"tiers": [
{
"upperBound": "100",
"price": "1.00",
"fee": "50.00",
"isPricePercentage": true,
"maxPrice": "10",
"minPrice": "5"
},
{
"price": "0.75",
"fee": "25.00",
"isPricePercentage": true,
"maxPrice": "10",
"minPrice": "5"
}
],
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"pricingType": "VOLUME"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"packageSize": "50",
"pricePerPackage": "2.00",
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"pricingType": "PACKAGE"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
}
],
"discounts": [
{
"id": "018f920a-40d1-7e62-91ca-f3a4b4ac5d9d",
"restrictToPrices": [
"5100e884-e007-4183-8355-4771865cb4d7"
],
"amount": "50",
"discountCalculationType": "PERCENTAGE",
"message": "message",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"seatDiscountType": "ALL_SEATS"
}
],
"minimums": [
{
"id": "018f9164-c2d9-7eb2-bb98-11ecb5454055",
"amount": "50",
"restrictToPrices": [
"5100e884-e007-4183-8355-4771865cb4d7"
],
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z"
}
]
}
],
"contacts": [
{
"contactId": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
"name": "Jane Doe",
"email": "jane@example.com",
"signedAt": "2022-06-28T16:47:00Z"
}
],
"counterSigners": [
{
"id": "0190da0c-980d-7fa2-9b65-4c79784a95b1",
"name": "Jane Doe",
"email": "jane@example.com",
"signedAt": "2022-06-28T16:47:00Z"
}
],
"isSignaturesEnabled": false,
"customerLegalName": "Acme Corp",
"customerAddress": {
"line1": "1 Fake Street",
"line2": "Fakesville",
"town": "Faketown",
"state": "CA",
"postcode": "F4KE",
"country": "US"
},
"pdfStatus": "NOT_YET_REQUESTED",
"archivedAt": "2022-06-28T16:47:00Z",
"attachmentAssets": [
{
"id": "e007e884-5100-4183-8355-4771865cb4dd",
"createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
"type": "IMAGE",
"format": "PNG",
"fileName": "my-image.png",
"fileSizeBytes": 12345,
"url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
"createdAt": "2022-06-28T16:47:00Z"
}
],
"isExpired": false,
"defaultDueDateDays": 30,
"signatureMode": "EMBEDDED",
"preparingSignatureRequestAt": "2022-06-28T16:47:00Z"
}This response has no body data.This response has no body data.This response has no body data.This response has no body data.Quotes
Get the published version of one of your quotes
Get the latest published version of a quote by ID, including its phases.
GET
/
quotes
/
{id}
/
published
Get the published version of one of your quotes
curl --request GET \
--url https://eu.sequencehq.com/api/quotes/{id}/published \
--header 'Authorization: <authorization>'import requests
url = "https://eu.sequencehq.com/api/quotes/{id}/published"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://eu.sequencehq.com/api/quotes/{id}/published', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu.sequencehq.com/api/quotes/{id}/published",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eu.sequencehq.com/api/quotes/{id}/published"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eu.sequencehq.com/api/quotes/{id}/published")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.sequencehq.com/api/quotes/{id}/published")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"id": "678ca125-8bc3-478f-9a96-6ba73605cf1e",
"createdBy": "4ffd439e-32e5-4046-bb40-3cb81f40e5da",
"customerId": "377bf97b-ca1d-4538-be06-4022afa6bde3",
"quoteNumber": "Q00001",
"title": "My quote",
"currency": "GBP",
"presentation": [],
"status": "ACCEPTED",
"dealType": "NEW_BUSINESS",
"preliminaryBillingStartDate": "2022-10-01",
"expiresAt": "2022-10-01",
"publishedAt": "2022-06-28T16:47:00Z",
"readyToSignAt": "2022-06-28T16:47:00Z",
"acceptedAt": "2022-06-28T16:47:00Z",
"executedAt": "2022-06-28T16:47:00Z",
"createdAt": "2022-06-28T16:47:00Z",
"updatedAt": "2022-06-28T16:47:00Z",
"createdFrom": {
"entityType": "QUOTE",
"entityId": "dc0e2104-7df5-4fc1-8f65-1823f427d111"
},
"salesforceOpportunityId": "006Hr00001MfnEIIAZ",
"merchantBranding": {
"logoUrl": "logo",
"legalCompanyName": "Acme Corp",
"primaryColour": "colour",
"url": "www.example.com",
"address": {
"line1": "1 Market Street",
"line2": "Suite 100",
"town": "San Francisco",
"state": "CA",
"postcode": "94105",
"country": "US"
},
"email": "accounting@example.com",
"showUsageInCustomerPortal": true,
"supportEmail": "support@example.com",
"supportUrl": "https://www.example.com/support"
},
"phases": [
{
"id": "abe4bf01-9b75-495d-f5fd-ca82b001f3a8",
"name": "Onboarding",
"createdAt": "2022-06-28T16:47:00Z",
"duration": {
"days": 0,
"weeks": 0,
"months": 6,
"years": 1
},
"prices": [
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"price": "150.00",
"pricingType": "ONE_TIME"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"price": "20.00",
"pricingType": "FIXED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"pricePerUnit": "0.25",
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"isPricePercentage": false,
"pricingType": "LINEAR"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"seatMetricId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"pricePerSeat": "0.25",
"prorationStrategy": "USE_MAXIMUM",
"contractedMinimumSeats": 10,
"overagesBillingFrequency": "YEARLY",
"tiers": [
{
"upperBound": "100",
"price": "1.00",
"fee": "50.00"
},
{
"price": "0.75",
"fee": "25.00"
}
],
"prorateFlatFees": false,
"pricingType": "SEAT_BASED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"tiers": [
{
"upperBound": "200",
"price": "1.00",
"fee": "50.00",
"isPricePercentage": false
},
{
"upperBound": "400",
"price": "0.75",
"fee": "25.00",
"isPricePercentage": false
},
{
"price": "0.50",
"fee": "0.00",
"isPricePercentage": false
}
],
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"usageCalculationMode": "BILLING_PERIOD",
"pricingType": "GRADUATED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
"usageCalculationPeriod": {
"frequency": "MONTHLY",
"interval": 1
}
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"tiers": [
{
"upperBound": "100",
"price": "1.00",
"fee": "50.00",
"isPricePercentage": true,
"maxPrice": "10",
"minPrice": "5"
},
{
"price": "0.75",
"fee": "25.00",
"isPricePercentage": true,
"maxPrice": "10",
"minPrice": "5"
}
],
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"pricingType": "VOLUME"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"packageSize": "50",
"pricePerPackage": "2.00",
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"pricingType": "PACKAGE"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
}
],
"discounts": [
{
"id": "018f920a-40d1-7e62-91ca-f3a4b4ac5d9d",
"restrictToPrices": [
"5100e884-e007-4183-8355-4771865cb4d7"
],
"amount": "50",
"discountCalculationType": "PERCENTAGE",
"message": "message",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"seatDiscountType": "ALL_SEATS"
}
],
"minimums": [
{
"id": "018f9164-c2d9-7eb2-bb98-11ecb5454055",
"amount": "50",
"restrictToPrices": [
"5100e884-e007-4183-8355-4771865cb4d7"
],
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z"
}
]
}
],
"contacts": [
{
"contactId": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
"name": "Jane Doe",
"email": "jane@example.com",
"signedAt": "2022-06-28T16:47:00Z"
}
],
"counterSigners": [
{
"id": "0190da0c-980d-7fa2-9b65-4c79784a95b1",
"name": "Jane Doe",
"email": "jane@example.com",
"signedAt": "2022-06-28T16:47:00Z"
}
],
"isSignaturesEnabled": false,
"customerLegalName": "Acme Corp",
"customerAddress": {
"line1": "1 Fake Street",
"line2": "Fakesville",
"town": "Faketown",
"state": "CA",
"postcode": "F4KE",
"country": "US"
},
"pdfStatus": "NOT_YET_REQUESTED",
"archivedAt": "2022-06-28T16:47:00Z",
"attachmentAssets": [
{
"id": "e007e884-5100-4183-8355-4771865cb4dd",
"createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
"type": "IMAGE",
"format": "PNG",
"fileName": "my-image.png",
"fileSizeBytes": 12345,
"url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
"createdAt": "2022-06-28T16:47:00Z"
}
],
"isExpired": false,
"defaultDueDateDays": 30,
"signatureMode": "EMBEDDED",
"preparingSignatureRequestAt": "2022-06-28T16:47:00Z"
}This response has no body data.This response has no body data.This response has no body data.This response has no body data.Headers
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
Available options:
2024-07-30 Path Parameters
Quote ID
Response
OK
Unique ID
Example:
"678ca125-8bc3-478f-9a96-6ba73605cf1e"
The Sequence user who created this quote
Example:
"4ffd439e-32e5-4046-bb40-3cb81f40e5da"
ID of Customer to which this quote pertains
Example:
"377bf97b-ca1d-4538-be06-4022afa6bde3"
An alpha-numeric value that identifies the quote
Example:
"Q00001"
The quote title
Example:
"My quote"
Quote currency
Available options:
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 Example:
"GBP"
JSON for the visual presentation of the quote
Example:
[]
The status of the quote
Available options:
DRAFT, PUBLISHED, PREPARING_SIGNATURE_REQUEST, READY_TO_SIGN, ACCEPTED, EXECUTED Example:
"DRAFT"
Quote deal type
Available options:
NEW_BUSINESS, RENEWAL Example:
"NEW_BUSINESS"
Date when quote expires
Example:
"2022-10-01"
Timestamp when quote was published. Formatted as an ISO 8601 timestamp.
Example:
"2022-06-28T16:47:00Z"
Creation timestamp. Formatted as an ISO 8601 timestamp.
Example:
"2022-06-28T16:47:00Z"
Timestamp when quote was last updated. Formatted as an ISO 8601 timestamp.
Example:
"2022-06-28T16:47:00Z"
Merchant information and branding (for quote rendering)
Show child attributes
Show child attributes
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"
}
Phases for this quote, in sequential order
Show child attributes
Show child attributes
Example:
[
{
"id": "abe4bf01-9b75-495d-f5fd-ca82b001f3a8",
"name": "Onboarding",
"createdAt": "2022-06-28T16:47:00Z",
"duration": {
"days": 0,
"weeks": 0,
"months": 6,
"years": 1
},
"prices": [
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"price": "150.00",
"pricingType": "ONE_TIME"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": { "price": "20.00", "pricingType": "FIXED" },
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"pricePerUnit": "0.25",
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"isPricePercentage": false,
"pricingType": "LINEAR"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"seatMetricId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
"pricePerSeat": "0.25",
"prorationStrategy": "USE_MAXIMUM",
"contractedMinimumSeats": 10,
"overagesBillingFrequency": "YEARLY",
"tiers": [
{
"upperBound": "100",
"price": "1.00",
"fee": "50.00"
},
{ "price": "0.75", "fee": "25.00" }
],
"prorateFlatFees": false,
"pricingType": "SEAT_BASED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"tiers": [
{
"upperBound": "200",
"price": "1.00",
"fee": "50.00",
"isPricePercentage": false
},
{
"upperBound": "400",
"price": "0.75",
"fee": "25.00",
"isPricePercentage": false
},
{
"price": "0.50",
"fee": "0.00",
"isPricePercentage": false
}
],
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"usageCalculationMode": "BILLING_PERIOD",
"pricingType": "GRADUATED"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
"usageCalculationPeriod": { "frequency": "MONTHLY", "interval": 1 }
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"tiers": [
{
"upperBound": "100",
"price": "1.00",
"fee": "50.00",
"isPricePercentage": true,
"maxPrice": "10",
"minPrice": "5"
},
{
"price": "0.75",
"fee": "25.00",
"isPricePercentage": true,
"maxPrice": "10",
"minPrice": "5"
}
],
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"pricingType": "VOLUME"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
},
{
"id": "5100e884-e007-4183-8355-4771865cb4d7",
"productId": "e007e884-5100-4183-8355-4771865cb4dd",
"name": "Sample product",
"structure": {
"packageSize": "50",
"pricePerPackage": "2.00",
"usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
"pricingType": "PACKAGE"
},
"billingFrequency": "MONTHLY",
"billingType": "IN_ARREARS",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"integrationIds": [
{
"service": "Xero",
"id": "123",
"isPending": false
}
],
"customMetricParameters": [
{
"parameterId": "2963e49a-c8e0-4673-89f5-7a805c0faf14",
"value": "10"
}
],
"listPriceId": "b4d7e884-e007-4183-8355-4771865c5100"
}
],
"discounts": [
{
"id": "018f920a-40d1-7e62-91ca-f3a4b4ac5d9d",
"restrictToPrices": ["5100e884-e007-4183-8355-4771865cb4d7"],
"amount": "50",
"discountCalculationType": "PERCENTAGE",
"message": "message",
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z",
"seatDiscountType": "ALL_SEATS"
}
],
"minimums": [
{
"id": "018f9164-c2d9-7eb2-bb98-11ecb5454055",
"amount": "50",
"restrictToPrices": ["5100e884-e007-4183-8355-4771865cb4d7"],
"createdAt": "2021-08-25T12:00:00Z",
"updatedAt": "2021-08-25T12:00:00Z"
}
]
}
]
List of contacts requested to sign this quote
Show child attributes
Show child attributes
Example:
[
{
"contactId": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
"name": "Jane Doe",
"email": "jane@example.com",
"signedAt": "2022-06-28T16:47:00Z"
}
]
List of internal persons who countersign every quote
Show child attributes
Show child attributes
Example:
[
{
"id": "0190da0c-980d-7fa2-9b65-4c79784a95b1",
"name": "Jane Doe",
"email": "jane@example.com",
"signedAt": "2022-06-28T16:47:00Z"
}
]
Enable e-signatures to allow customers to sign this quote through Dropbox Sign.
Example:
false
Customer legal name
Example:
"Acme Corp"
Show child attributes
Show child attributes
Example:
{
"line1": "1 Market Street",
"line2": "Suite 100",
"town": "San Francisco",
"state": "CA",
"postcode": "94105",
"country": "US"
}
Status of quote PDF generation for this variant
Available options:
NOT_YET_REQUESTED, REQUESTED, IN_PROGRESS, FAILED, GENERATED Example:
"NOT_YET_REQUESTED"
Assets attached to this quote
Show child attributes
Show child attributes
Example:
[
{
"id": "e007e884-5100-4183-8355-4771865cb4dd",
"createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
"type": "IMAGE",
"format": "PNG",
"fileName": "my-image.png",
"fileSizeBytes": 12345,
"url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
"createdAt": "2022-06-28T16:47:00Z"
}
]
True if the quote expiry date has passed
Example:
false
Preliminary start date of contract
Example:
"2022-10-01"
Timestamp when quote was ready to sign. Formatted as an ISO 8601 timestamp.
Example:
"2022-06-28T16:47:00Z"
Timestamp when quote was accepted. Formatted as an ISO 8601 timestamp.
Example:
"2022-06-28T16:47:00Z"
Timestamp when quote was executed. Formatted as an ISO 8601 timestamp.
Example:
"2022-06-28T16:47:00Z"
Entity from which this quote was created
Show child attributes
Show child attributes
Example:
{
"entityType": "QUOTE",
"entityId": "dc0e2104-7df5-4fc1-8f65-1823f427d111"
}
Salesforce ID of the opportunity that created this quote
Example:
"006Hr00001MfnEIIAZ"
Date and time the quote was archived
Example:
"2022-06-28T16:47:00Z"
Default number of days between issue date and due date. Passed onto a billing schedule created from the Quote.
Example:
30
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.
Available options:
EMBEDDED, NON_EMBEDDED Example:
"EMBEDDED"
Timestamp when quote ready-to-sign operation was triggered.
Example:
"2022-06-28T16:47:00Z"