API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Quotes
Create quote
Create a new quote.
POST
/
v1
/
quotes
curl --request POST \
--url https://api.hyperline.co/v1/quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"status": "draft",
"owner_email": "joe@acme.com",
"customer_id": "cus_QalW2vTAdkR6IY",
"invoicing_entity_id": "ive_47484fjdhy5",
"comments": "Please find the contract and subscription details we discussed.",
"terms": "By signing this quote, you accept our conditions of use for the use of our products and services.",
"amount": 20000,
"collect_payment_details": true,
"collect_custom_property_ids": [],
"automatically_start_subscription": true,
"template_id": "quot_9hNWq4c84Z146W",
"expires_at": "2024-04-28T14:12:09.293Z",
"subscription": {
"name": "<string>",
"purchase_order": "<string>",
"invoicing_entity_id": "ive_jerrb484RHn",
"generate_draft_invoices": true,
"commitment_interval": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"renew_for": {
"period": "years",
"count": 1
},
"minimum_invoice_fee": 250,
"starts_at": "2024-12-20T16:04:11Z",
"contract_start": "2024-01-15T00:00:00Z",
"contract_end": "2025-01-15T00:00:00Z",
"initial_billing_at": "2024-12-20T16:04:11Z",
"cancel_at": "2024-12-20T16:04:11Z",
"cancellation_strategy": "refund_prorata",
"cancellation_amount": 24000,
"properties": {},
"custom_properties": {},
"contract_terms": {
"starts_at": "2024-12-20T16:04:11Z",
"ends_at": "2024-12-20T16:04:11Z",
"duration": {
"count": 6,
"period": "months"
},
"renew_automatically": true,
"renew_for_duration": {
"count": 1,
"period": "years"
},
"activation_strategy": "start_date",
"end_strategy": "duration"
},
"trial": {
"end_strategy": "manual",
"starts_at": "2024-12-20T16:04:11Z",
"ends_at": "2024-12-20T16:04:11Z",
"duration": {
"period": "days",
"count": 2
}
},
"phases": [
{
"type": "standard",
"order": 0,
"activation_strategy": "manual",
"end_strategy": "duration",
"duration": {
"count": 1,
"period": "years"
},
"billing_date_setting": "phase_start",
"initial_billing_at": "2024-12-20T16:04:11Z",
"starts_at": "2024-12-20T16:04:11Z",
"ends_at": "2024-12-20T16:04:11Z",
"billing_cycle_alignment": "anniversary",
"transition_calculation_method": "prorata",
"transition_invoicing_schedule": "immediately",
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": false,
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"price": {
"type": "fee",
"amount": 200
},
"prices": [
{
"type": "volume",
"from": 0,
"to": 20,
"amount": 200,
"unit_count": 1,
"on_tier_incomplete": null
},
{
"type": "volume",
"from": 21,
"to": null,
"amount": 150,
"unit_count": 1,
"on_tier_incomplete": null
}
],
"count": 2,
"unit_name": "user",
"min_committed_count": 2,
"min_amount": 123,
"max_amount": 123,
"metering_interval_type": "subscription_commitment",
"bill_usage_difference": true
}
],
"coupons": [
{
"id": "<string>",
"repeat": "once",
"expires_at": "2024-12-20T16:04:11Z",
"apply_at": "2024-12-20T16:04:11Z",
"product_ids": [
"<string>"
]
}
]
}
]
}
}'
{
"id": "quo_hXQCd5y8P3GYXa",
"customer_id": "cus_QalW2vTAdkR6IY",
"invoicing_entity_id": "ive_47484fjdhy5",
"template_id": "quot_9hNWq4c84Z146W",
"crm_opportunity_id": "<string>",
"number": "327",
"comments": "Please find the contract and subscription details we discussed.",
"terms": "By signing this quote, you accept our conditions of use for the use of our products and services.",
"owner_email": "joe@acme.com",
"collect_payment_details": true,
"collect_custom_property_ids": [],
"attachments": [
{
"id": "quof_5GYXy8P3QCdaXh",
"name": "General Conditions of Sale",
"mimetype": "application/pdf"
}
],
"signed_file": {
"id": "<string>",
"name": "<string>",
"mimetype": "<string>"
},
"url": "https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa",
"created_at": "2024-12-20T16:04:11Z",
"status": "draft",
"amount": 200000,
"expires_at": "2024-10-13T02:00:00.000Z",
"type": "subscription",
"subscription_id": "sub_B6ClkdqNqVNBgY",
"child_subscription_ids": [
"sub_0z39oqdhKl0PXb"
],
"automatically_start_subscription": true
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Response
201 - application/json
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.hyperline.co/v1/quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"status": "draft",
"owner_email": "joe@acme.com",
"customer_id": "cus_QalW2vTAdkR6IY",
"invoicing_entity_id": "ive_47484fjdhy5",
"comments": "Please find the contract and subscription details we discussed.",
"terms": "By signing this quote, you accept our conditions of use for the use of our products and services.",
"amount": 20000,
"collect_payment_details": true,
"collect_custom_property_ids": [],
"automatically_start_subscription": true,
"template_id": "quot_9hNWq4c84Z146W",
"expires_at": "2024-04-28T14:12:09.293Z",
"subscription": {
"name": "<string>",
"purchase_order": "<string>",
"invoicing_entity_id": "ive_jerrb484RHn",
"generate_draft_invoices": true,
"commitment_interval": {
"period": "years",
"count": 1
},
"renew_automatically": true,
"renew_for": {
"period": "years",
"count": 1
},
"minimum_invoice_fee": 250,
"starts_at": "2024-12-20T16:04:11Z",
"contract_start": "2024-01-15T00:00:00Z",
"contract_end": "2025-01-15T00:00:00Z",
"initial_billing_at": "2024-12-20T16:04:11Z",
"cancel_at": "2024-12-20T16:04:11Z",
"cancellation_strategy": "refund_prorata",
"cancellation_amount": 24000,
"properties": {},
"custom_properties": {},
"contract_terms": {
"starts_at": "2024-12-20T16:04:11Z",
"ends_at": "2024-12-20T16:04:11Z",
"duration": {
"count": 6,
"period": "months"
},
"renew_automatically": true,
"renew_for_duration": {
"count": 1,
"period": "years"
},
"activation_strategy": "start_date",
"end_strategy": "duration"
},
"trial": {
"end_strategy": "manual",
"starts_at": "2024-12-20T16:04:11Z",
"ends_at": "2024-12-20T16:04:11Z",
"duration": {
"period": "days",
"count": 2
}
},
"phases": [
{
"type": "standard",
"order": 0,
"activation_strategy": "manual",
"end_strategy": "duration",
"duration": {
"count": 1,
"period": "years"
},
"billing_date_setting": "phase_start",
"initial_billing_at": "2024-12-20T16:04:11Z",
"starts_at": "2024-12-20T16:04:11Z",
"ends_at": "2024-12-20T16:04:11Z",
"billing_cycle_alignment": "anniversary",
"transition_calculation_method": "prorata",
"transition_invoicing_schedule": "immediately",
"products": [
{
"id": "itm_FJKlqUb8COXw55",
"name": "Product name",
"description": "A description of the product.",
"description_display_interval_dates": false,
"payment_interval": {
"period": "months",
"count": 1
},
"payment_schedule": "start",
"price": {
"type": "fee",
"amount": 200
},
"prices": [
{
"type": "volume",
"from": 0,
"to": 20,
"amount": 200,
"unit_count": 1,
"on_tier_incomplete": null
},
{
"type": "volume",
"from": 21,
"to": null,
"amount": 150,
"unit_count": 1,
"on_tier_incomplete": null
}
],
"count": 2,
"unit_name": "user",
"min_committed_count": 2,
"min_amount": 123,
"max_amount": 123,
"metering_interval_type": "subscription_commitment",
"bill_usage_difference": true
}
],
"coupons": [
{
"id": "<string>",
"repeat": "once",
"expires_at": "2024-12-20T16:04:11Z",
"apply_at": "2024-12-20T16:04:11Z",
"product_ids": [
"<string>"
]
}
]
}
]
}
}'
{
"id": "quo_hXQCd5y8P3GYXa",
"customer_id": "cus_QalW2vTAdkR6IY",
"invoicing_entity_id": "ive_47484fjdhy5",
"template_id": "quot_9hNWq4c84Z146W",
"crm_opportunity_id": "<string>",
"number": "327",
"comments": "Please find the contract and subscription details we discussed.",
"terms": "By signing this quote, you accept our conditions of use for the use of our products and services.",
"owner_email": "joe@acme.com",
"collect_payment_details": true,
"collect_custom_property_ids": [],
"attachments": [
{
"id": "quof_5GYXy8P3QCdaXh",
"name": "General Conditions of Sale",
"mimetype": "application/pdf"
}
],
"signed_file": {
"id": "<string>",
"name": "<string>",
"mimetype": "<string>"
},
"url": "https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa",
"created_at": "2024-12-20T16:04:11Z",
"status": "draft",
"amount": 200000,
"expires_at": "2024-10-13T02:00:00.000Z",
"type": "subscription",
"subscription_id": "sub_B6ClkdqNqVNBgY",
"child_subscription_ids": [
"sub_0z39oqdhKl0PXb"
],
"automatically_start_subscription": true
}
Assistant
Responses are generated using AI and may contain mistakes.