Get quotes

GET

quotes

curl --request GET \
  --url https://api.hyperline.co/v1/quotes \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "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

Authorization

string

header

required

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

Query Parameters

take

number | null

default:50

Required range: 0 <= x <= 100

skip

number | null

default:0

Required range: x >= 0

status

Available options:

all,

draft,

pending_approval,

changes_requested,

approved,

pending_signature,

signed,

voided

status__in

Available options:

all,

draft,

pending_approval,

changes_requested,

approved,

pending_signature,

signed,

voided

customer_id

string

customer_id__not

string

customer_id__isNull

string

customer_id__isNotNull

string

customer_id__equals

string

customer_id__contains

string

customer_id__startsWith

string

customer_id__endWith

string

Response

200 - application/json

meta

object

required

data

object[]

required

List of Quote.

data.id

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

data.customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

data.invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

data.template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

data.crm_opportunity_id

string | null

required

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

data.number

string

required

Quote sequential number.

Example:

"327"

data.comments

string | null

required

Custom comments displayed on the quote.

Example:

"Please find the contract and subscription details we discussed."

data.terms

string | null

required

Custom quotation terms.

Example:

"By signing this quote, you accept our conditions of use for the use of our products and services."

data.owner_email

string | null

required

Email address of the Hyperline user acting as the quote owner.

Example:

"joe@acme.com"

data.collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

data.collect_custom_property_ids

string[]

required

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

Example:

[]

data.attachments

object[]

required

List of documents attached to the quote.

Example:

[
  {
    "id": "quof_5GYXy8P3QCdaXh",
    "name": "General Conditions of Sale",
    "mimetype": "application/pdf"
  }
]

data.signed_file

object

required

Final signed quote (manually uploaded).

data.url

string | null

required

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

Example:

"https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa"

data.created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

data.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:

draft

Example:

"draft"

data.amount

number

required

Estimated contract value.

Example:

200000

data.expires_at

string | null

required

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

Example:

"2024-10-13T02:00:00.000Z"

data.type

enum<string>

required

Quote type.

subscription: The quote will create and start a new subscription.
subscription_update: The quote will update an existing subscription.
one_off: The quote will issue an one-off invoice.

Available options:

subscription,

subscription_update

Example:

"subscription"

data.subscription_id

string | null

required

ID of the subscription attached to the quote. It corresponds to the state at the time of the quote signature. Only applies to the subscription and subscription_update quote types. The get subscription endpoint (GET /v2/subscriptions/{id}) can be used to retrieve the related details.

Example:

"sub_B6ClkdqNqVNBgY"

data.child_subscription_ids

string[]

required

IDs of the created subscriptions from the quote. Subscriptions configuration can change after the quote signature. The get subscription endpoint (GET /v2/subscriptions/{id}) can be used to retrieve the related details.

Example:

["sub_0z39oqdhKl0PXb"]

data.automatically_start_subscription

boolean

required

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

Example:

true

Was this page helpful?

Unarchive product Get quote

curl --request GET \
  --url https://api.hyperline.co/v1/quotes \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "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
    }
  ]
}

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Query Parameters

Response