logo

Partially update a quote

Partially updates a quote with a specified ID.

The update operation can only be used for quotes with a status of draft.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json
required
object (Taxes)

Taxes.

calculator
required
string

Type of tax calculator.

required
Array of objects (TaxItem)

Taxes applied.

Array
amount
required
number <double>

Amount of the tax.

description
required
string

Description of the tax.

Responses
200

Quote updated.

Response Schema: application/json
websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

required
Array of objects non-empty

Items included in the quote.

Array (non-empty)
required
OriginalPlan (object) or (FlexiblePlan (OneTimeSalePlan (object) or SubscriptionOrderPlan (object) or TrialOnlyPlan (object)))

Plan details.

quantity
required
integer >= 1

Number of product units in the specified plan.

id
string

ID of the quote item.

description
string <= 255 characters
Default: ""

Description of the quote item.

priceDescription
string <= 255 characters
Default: ""

Price description of the quote item. This value is only used for metered billing items.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

object

Embedded objects that are requested by the expand query parameter.

id
string <= 50 characters

ID of the quote.

type
string

Specifies the type of quote. A quote can be a subscription or a one-time purchase.

Enum: "subscription-order" "one-time-order"
status
string

Status of the quote.

Enum: Description
draft

Quote can be edited. This quote cannot be sent to a customer.

issued

Quote cannot be edited. This quote can be sent to a customer.

accepted

Customer accepted the quote and created an order.

rejected

Customer rejected the quote.

canceled

Organization canceled the quote.

expired

Expired before customer or organization interaction.

orderId
string or null <= 50 characters

ID of the order.

object or null

Delivery address of the order.

firstName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\p{L},.'&]+$

Contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array
label
required
string <= 45 characters

Phone number label or name.

value
required
string <= 50 characters

Phone number value.

primary
boolean

Specifies if the phone number is the contact's primary phone number.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

Array
label
required
string <= 45 characters

Email label or name.

value
required
string <email> <= 255 characters

Email address value.

primary
boolean

Specifies if the email address is the contact's primary email address.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

object or null

Billing address of the order.

firstName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\p{L},.'&]+$

Contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array
label
required
string <= 45 characters

Phone number label or name.

value
required
string <= 50 characters

Phone number value.

primary
boolean

Specifies if the phone number is the contact's primary phone number.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

Array
label
required
string <= 45 characters

Email label or name.

value
required
string <email> <= 255 characters

Email address value.

primary
boolean

Specifies if the email address is the contact's primary email address.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

object

Preview of the quote invoice.

currency
string = 3 characters

Currency of the invoice.

object

Total amounts of the initial invoice.

amount
number <double>

Amount of the invoice.

subtotalAmount
number <double>

Subtotal amount of the invoice.

discountAmount
number <double>

Discount amount that is applied to the invoice.

shippingAmount
number <double>

Shipping amount that is applied to the invoice.

taxAmount
number <double>

Tax amount that is applied to the invoice.

object or null

Total amounts of the recurring invoice. This includes recurring items only. If the quote does not have recurring items, the value of this field is null.

amount
number <double>

Amount of the invoice.

subtotalAmount
number <double>

Subtotal amount of the invoice.

discountAmount
number <double>

Discount amount that is applied to the invoice.

shippingAmount
number <double>

Shipping amount that is applied to the invoice.

taxAmount
number <double>

Tax amount that is applied to the invoice.

Array of objects

Invoice items.

Array
quoteItemId
string

ID of the related quote item.

type
string

Type of the invoice item.

Enum: "debit" "credit"
name
string <= 1000 characters

Name of the invoice item.

description
string <= 255 characters

Description of the invoice item.

priceDescription
string <= 255 characters

Price description of the invoice item.

unitPrice
number or null <double>

Unit price of the invoice item.

quantity
integer

Quantity of the invoice item.

period
string or null

Date interval of the invoice item.

setupUnitPrice
number or null <double>

Unit price of the invoice item.

trialUnitPrice
number or null <double>

Unit price of the invoice item.

trialPeriod
string or null

Date interval of the invoice item trial.

taxAmount
number or null <double>

Invoice item tax.

setupTaxAmount
number or null <double>

Tax amount of the setup that is applied to the invoice.

trialTaxAmount
number or null <double>

Tax amount of the trial that is applied to the invoice.

paymentTerms
string

Payment terms for the customer which are displayed on the quote.

expirationTime
string or null <date-time>

Date and time when the quote expires. The default expiration time is one month from the time the quote is issued. In a draft state, this field may be null.

issuedTime
string or null <date-time>

Date and time when the quote is issued.

acceptedTime
string or null <date-time>

Date and time when the quote is accepted.

rejectedTime
string or null <date-time>

Date and time when the quote is rejected.

canceledTime
string or null <date-time>

Date and time when the quote is canceled.

redirectUrl
string <uri>

URL to redirect the customer to when a quote is rejected. The default value is the website URL.

object
showWrittenSignatureLines
boolean
Default: false

Specifies whether to show written signature lines.

organizationPrintedName
string or null
Default: null

Printed name of the organization.

object (Shipping)

Shipping settings.

amount
required
number <double>

Shipping amount.

calculator
required
string

Shipping calculator.

object (Taxes)

Taxes.

calculator
required
string

Type of tax calculator.

required
Array of objects (TaxItem)

Taxes applied.

Array
amount
required
number <double>

Amount of the tax.

description
required
string

Description of the tax.

rate
number or null <double>

Overall sales tax rate which includes state, county, city and district tax.

stateAmount
number or null <double>

Amount of sales tax to collect for the state.

countyAmount
number or null <double>

Amount of sales tax to collect for the county.

cityAmount
number or null <double>

Amount of sales tax to collect for the city.

specialDistrictAmount
number or null <double>

Amount of sales tax to collect for the special district.

stateRate
number or null <double>

State sales tax rate for given location.

countyRate
number or null <double>

County sales tax rate for given location.

cityRate
number or null <double>

City sales tax rate for given location.

specialDistrictRate
number or null <double>

Special district sales tax rate for given location.

object or null

Jurisdiction names for the invoice.

amount
integer

Total amount of taxes.

couponIds
Array of strings or null

List of coupons to redeem on the customer and apply to the order when the quote is accepted.

For more information, see Coupons.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "quoteAcceptanceFormUrl"
object

Embedded objects that are requested by the expand query parameter.

customer
object
website
object
order
object
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

patch/quotes/{id}
Request samples
application/json
{
  • "tax": {
    }
}
Response samples
application/json
{
  • "id": "qt_0YV7DES3WPC5J8JD8QTVNZBZNZ",
  • "type": "subscription-order",
  • "status": "draft",
  • "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  • "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  • "orderId": "ord_0YV7DES3WPC5J8JD8QTVNZBZNZ",
  • "items": [
    ],
  • "deliveryAddress": {
    },
  • "billingAddress": {
    },
  • "invoicePreview": {
    },
  • "paymentTerms": "string",
  • "expirationTime": "2019-08-24T14:15:22Z",
  • "issuedTime": "2019-08-24T14:15:22Z",
  • "acceptedTime": "2019-08-24T14:15:22Z",
  • "rejectedTime": "2019-08-24T14:15:22Z",
  • "canceledTime": "2019-08-24T14:15:22Z",
  • "redirectUrl": "http://example.com",
  • "signature": {
    },
  • "shipping": {
    },
  • "tax": {
    },
  • "couponIds": [
    ],
  • "_links": [
    ],
  • "_embedded": {
    }
}
➔ Next to Accept a quote