POST
/
v1
/
quotes

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

customer_id
string
required

ID of the customer.

template_id
string
required

ID of the quote template. If not specified, a subscription configuration must be defined.

status
enum<string>

Quote status.

  • draft: The quote is a draft.
  • approved: The quote is approved and ready to be sent to the customer.
  • pending_signature: The quote is awaiting the customer's signature.
Available options:
draft,
approved,
pending_signature
owner_email
string

Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.

invoicing_entity_id
string

ID of the invoicing entity attached to the quote.

comments
string

Custom comments displayed on the quote.

terms
string

Custom quotation terms.

amount
number | null

Estimated contract value. If not specified, automatically computed from the subscription configuration.

collect_payment_details

Collect customer payment method mandate during signature flow or not.

collect_custom_property_ids
string[]

IDs of the customer custom properties required to be filled during the signature flow.

automatically_start_subscription

Whether the subscription should be automatically started when the quote is signed.

expires_at
string

Quote expiration date. UTC date time string in the ISO 8601 format.

subscription
object

Subscription configuration constituting the quote.

Response

201 - application/json
id
string
required

Quote ID.

customer_id
string
required

ID of the customer.

invoicing_entity_id
string
required

ID of the invoicing entity attached to the quote.

template_id
string | null
required

ID of the quote template.

crm_opportunity_id
string | null
required

ID of the related opportunity/deal in the connected CRM.

number
string
required

Quote sequential number.

comments
string | null
required

Custom comments displayed on the quote.

terms
string | null
required

Custom quotation terms.

collect_payment_details
boolean
required

Collect customer payment method mandate during signature flow or not.

collect_custom_property_ids
string[]
required

IDs of the customer custom properties required to be filled during the signature flow.

attachments
object[]
required

List of documents attached to the quote.

signed_file
object
required

Final signed quote (manually uploaded).

url
string | null
required

URL to access the quote publicly. Only applies to the pending_signature or signed quote.

created_at
string
required

UTC date time string in the ISO 8601 format.

subscription_id
string | null
required

ID of the subscription attached to the quote. The GET /v2/subscriptions/{id} (Get subscription) endpoint can be used to retrieve the related details.

automatically_start_subscription
boolean
required

Whether the subscription should be automatically started when the quote is signed.

status
enum<string>
required

Quote status.

  • draft: The quote is a draft.
  • pending_approval: The quote is pending manager review and approval.
  • changes_requested: Some changes have been requested following manager review.
  • approved: The quote is approved and ready to be sent to the customer.
  • pending_signature: The quote is awaiting the customer's signature.
  • signed: The quote is signed and fully finalized.
  • voided: The quote is voided.
Available options:
voided
void_reason
string
required

Quote voiding reason. Only applies to the voided quote.

voided_at
string
required

Quote voiding date. Only applies to the voided quote.

amount
number
required

Estimated contract value.

expires_at
string
required

Quote expiration date. UTC date time string in the ISO 8601 format.

approved_at
string
required

Quote approbation date. UTC date time string in the ISO 8601 format.

signature
object | null
required

Quote signature. Only applies to the signed quote.

signed_at
string
required

Quote signature date. Only applies to the signed quote.

Was this page helpful?

Get quotesGet quote