Create quote

POST

quotes

Option 1 · object

status

enum<string>

owner_email

string

customer_id

string

invoicing_entity_id

string

comments

string

terms

string

amount

number

collect_payment_details

boolean

collect_custom_property_ids

array

automatically_start_subscription

boolean

template_id

string

expires_at

string

subscription

object

purchase_order

string

invoicing_entity_id

string

generate_draft_invoices

boolean

commitment_interval

object, deprecated

period

enum<string>

count

number

renew_automatically

boolean

renew_for

object

period

enum<string>

count

number

minimum_invoice_fee

number

starts_at

string, deprecated

contract_start

string

contract_end

string

initial_billing_at

string

trial_ends_at

string

trial_delay_first_invoice

boolean

cancel_at

string

cancellation_strategy

enum<string>

cancellation_amount

number

products

array

coupons

array

properties

object

custom_properties

object

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.

subscription.purchase_order

string

Reference to the purchase order.

subscription.invoicing_entity_id

string

ID of the invoicing entity attached to the subscription.

subscription.generate_draft_invoices

default: false

Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent

subscription.commitment_interval

object

deprecated

Use contract_start contract_end and renew_automatically instead. Interval previously used to represent the commitment period of the subscription.

subscription.renew_automatically

default: true

Indicates if the subscription should automatically renew.

subscription.renew_for

object

If renew_automatically is enabled, will renew the subscription for the given interval.

subscription.minimum_invoice_fee

number | null

Minimum fee applied to each invoice outside of one time payments.

subscription.starts_at

string

deprecated

Deprecated field, please use contract_start.

subscription.contract_start

string

Subscription contract start date. UTC date time string in the ISO 8601 format.

subscription.contract_end

string

Subscription contract end date. UTC date time string in the ISO 8601 format.

subscription.initial_billing_at

string

Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.

subscription.trial_ends_at

string

End date of the trial period. UTC date time string in the ISO 8601 format.

subscription.trial_delay_first_invoice

default: false

Delay first invoice to the end of the trial period.

subscription.cancel_at

string

Subscription cancel date. UTC date time string in the ISO 8601 format.

subscription.cancellation_strategy

enum<string>

Strategy used to cancel the subscription. If not specified do_nothing is used.

charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.
charge_custom: Will charge the customer a custom amount.
refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.
refund_custom: Will refund to the customer a custom amount.
end_of_period: Will cancel the subscription at the end date of the current billing period.
do_nothing: Will only cease the subscription without any additional actions.

Available options:

refund_prorata,

refund_custom,

charge_prorata,

charge_custom,

end_of_period,

do_nothing

subscription.cancellation_amount

number

Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.

subscription.products

object[]

Products that make up the subscription.

subscription.products.id

string

required

Product ID.

subscription.products.name

string

Product name. This will appear on the final invoices.

subscription.products.description

string

Product description. This will appear on the final invoices.

subscription.products.description_display_interval_dates

boolean

default: false

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

subscription.products.payment_interval

object

Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.

subscription.products.payment_schedule

enum<string>

Indicates if the product should be billed at the start or the end of the payment interval.

Available options:

start,

end

subscription.products.price

object

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

subscription.products.prices

object[]

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

subscription.products.count

number

Number of product units. Only applies to products of type flat_fee or seat.

Required range: x > 1

subscription.products.unit_name

string

Product name. This will appear on the final invoices. Only applies to products of type seat or usage.

subscription.products.min_committed_count

number

Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type usage.

Required range: x > 1

subscription.products.min_amount

number

Minimum amount billed. If the final computed amount from the usage for this product is less than this amount, then this value will be used. Only applies to products of type usage.

subscription.products.max_amount

number

Maximum amount billed. If the final computed amount from the usage for this product is greater than this amount, then this value will be used. Only applies to products of type usage.

subscription.products.metering_interval_type

enum<string>

Indicates on which type of interval the usage should be aggregated.

subscription_commitment: For the usage contained within the subscription commitment period.
payment_interval: For the usage contained within the payment interval of the product.
full_database: For all the usage we ingested for this product, no matter the period. Only applies to products of type usage.

Available options:

subscription_commitment,

payment_interval,

full_database

subscription.products.bill_usage_difference

default: false

Only bill the usage difference comparing to the previous period (i.e. actual amount minus last invoice amount). Doesn't apply to payment_interval metering interval type. Only applies to products of type usage.

subscription.coupons

object[]

subscription.properties

object

Key/value pairs to store any information you find useful.

subscription.custom_properties

object

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

Response

201 - application/json

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 quotes Get quote

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Body

Response