Sign quote
Manually mark the quote as signed externally. Built-in Hyperline signature flow won’t be used.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
The body is of type object.
Response
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Quote ID.
"quo_hXQCd5y8P3GYXa"
Quote type.
subscription: The quote will create one or more subscriptions.subscription_update: The quote will update one or more existing subscriptions.one_off: The quote will issue one or more one-off invoices.mixed: Mixed configuration types.null: Empty quote.
subscription, subscription_update, one_off, mixed ID of the customer.
"cus_QalW2vTAdkR6IY"
ID of the invoicing entity attached to the quote.
"ive_47484fjdhy5"
Ordered configurations included in the quote.
- Option 1
- Option 2
ID of the quote template.
"quot_9hNWq4c84Z146W"
ID of the related opportunity/deal in the connected CRM.
"opp_Z2oSqnBCUoo1bQ"
What the customer pays over the contract, each coupon counted on the invoices it applies to. Computed from the subscription for subscription and subscription_update quotes, unless set manually. Not set on one_off quotes.
18000
Quote sequential number.
"327"
Custom comments displayed on the quote.
"Please find the contract and subscription details we discussed."
Custom quotation terms.
"By signing this quote, you accept our conditions of use for the use of our products and services."
Email address of the Hyperline user acting as the quote owner. The owner requests approval when the quote is finalized using an API key or finalized during creation.
"joe@acme.com"
Collect customer payment method mandate during signature flow or not.
true
IDs of the customer custom properties required to be filled during the signature flow.
Require the customer to provide a tax ID during the signature flow.
false
Display the total quote value on the quote.
true
Display the total quote value including tax on the quote. Only applies to one_off quotes.
false
Display tax breakdown on the quote.
true
Controls which price tiers are displayed on the quote.
all: Display all pricing tiers.matching: Only display the tiers used to compute the price based on quantity.none: Hide all pricing tiers.
all, matching, none "matching"
Display per-phase value breakdown on the quote.
false
Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.
false
Display the first invoice amount on the quote.
false
Display attached documents in the quote preview.
false
Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.
quote_update_details, subscription_details, both "quote_update_details"
Whether the subscription is automatically orchestrated after the quote is signed. Only applies to the Hyperline CPQ-only product.
true
When true, the invoice issued after signature stays in draft status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to false.
false
List of documents attached to the quote.
Final signed quote (manually uploaded).
null
URL to access the quote publicly. Only applies to the pending_signature or signed quote.
"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa"
Deprecated field, please use configurations[].subscription_id.
Deprecated. Use subscription_update_display. False displays quote update details; true displays both sections.
false
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.
draft "draft"
Estimated contract value.
200000
Deprecated field, please use configurations[].invoice_id.
Deprecated field, please use GET /v2/subscriptions with the original_quote_id filter.

