Get quotes

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

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0,
    "approximateCount": false
  },
  "data": [
    {
      "id": "quo_hXQCd5y8P3GYXa",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "invoicing_entity_id": "ive_47484fjdhy5",
      "template_id": "quot_9hNWq4c84Z146W",
      "crm_opportunity_id": null,
      "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": "[email protected]",
      "collect_payment_details": true,
      "collect_custom_property_ids": [],
      "attachments": [
        {
          "id": "quof_5GYXy8P3QCdaXh",
          "name": "General Conditions of Sale",
          "mimetype": "application/pdf"
        }
      ],
      "signed_file": null,
      "url": "https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa",
      "created_at": "2024-04-23T09:10:00.220Z",
      "updated_at": "2024-04-23T10:22:08.100Z",
      "status": "draft",
      "amount": 200000,
      "expires_at": null,
      "type": "subscription",
      "subscription_id": "sub_B6ClkdqNqVNBgY",
      "child_subscription_ids": [
        "sub_0z39oqdhKl0PXb"
      ]
    }
  ]
}

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,
    "approximateCount": false
  },
  "data": [
    {
      "id": "quo_hXQCd5y8P3GYXa",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "invoicing_entity_id": "ive_47484fjdhy5",
      "template_id": "quot_9hNWq4c84Z146W",
      "crm_opportunity_id": null,
      "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": "[email protected]",
      "collect_payment_details": true,
      "collect_custom_property_ids": [],
      "attachments": [
        {
          "id": "quof_5GYXy8P3QCdaXh",
          "name": "General Conditions of Sale",
          "mimetype": "application/pdf"
        }
      ],
      "signed_file": null,
      "url": "https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa",
      "created_at": "2024-04-23T09:10:00.220Z",
      "updated_at": "2024-04-23T10:22:08.100Z",
      "status": "draft",
      "amount": 200000,
      "expires_at": null,
      "type": "subscription",
      "subscription_id": "sub_B6ClkdqNqVNBgY",
      "child_subscription_ids": [
        "sub_0z39oqdhKl0PXb"
      ]
    }
  ]
}

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

string

id__not

string

id__isNull

string

id__isNotNull

string

id__equals

string

id__contains

string

id__startsWith

string

id__endWith

string

number

string

number__not

string

number__isNull

string

number__isNotNull

string

number__equals

string

number__contains

string

number__startsWith

string

number__endWith

string

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

template_id

string

template_id__not

string

template_id__isNull

string

template_id__isNotNull

string

template_id__equals

string

template_id__contains

string

template_id__startsWith

string

template_id__endWith

string

crm_opportunity_id

string

crm_opportunity_id__not

string

crm_opportunity_id__isNull

string

crm_opportunity_id__isNotNull

string

crm_opportunity_id__equals

string

crm_opportunity_id__contains

string

crm_opportunity_id__startsWith

string

crm_opportunity_id__endWith

string

type

string

type__not

string

type__isNull

string

type__isNotNull

string

type__equals

string

type__contains

string

type__startsWith

string

type__endWith

string

updated_at

string<date-time>

updated_at__not

string<date-time>

updated_at__isNull

string<date-time>

updated_at__isNotNull

string<date-time>

updated_at__equals

string<date-time>

updated_at__lt

string<date-time>

updated_at__lte

string<date-time>

updated_at__gt

string<date-time>

updated_at__gte

string<date-time>

Response

200 - application/json

meta

object

required

Show child attributes

meta.total

number

required

Total of existing items.

Example:

1

meta.taken

number

required

Number of items returned.

Example:

1

meta.skipped

number

required

Number of items skipped.

Example:

0

meta.approximateCount

boolean

Whether the total count is approximate.

Example:

false

data

(Quote for subscription (draft) · object | Quote for one-off invoice (draft) · object | Quote for subscription (approval) · object | Quote for subscription (ready) · object | Quote for subscription (signed) · object | Quote for one-off invoice (approval) · object | Quote for one-off invoice (ready) · object | Quote for one-off invoice (signed) · object | Quote for subscription (voided) · object | Quote for one-off invoice (voided) · object)[]

required

List of Quote.

Show child attributes

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.

Example:

null

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<email> | null

required

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

Example:

"[email protected]"

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.

Show child attributes

data.attachments.id

string

required

Quote file ID.

data.attachments.name

string

required

Quote file name.

data.attachments.mimetype

string

required

Quote file MIME type.

Example:

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

data.signed_file

object

required

Final signed quote (manually uploaded).

Show child attributes

data.signed_file.id

string

required

Quote file ID.

data.signed_file.name

string

required

Quote file name.

data.signed_file.mimetype

string

required

Quote file MIME type.

Example:

null

data.url

string<uri> | 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<date-time>

required

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

Example:

"2024-04-23T09:10:00.220Z"

data.updated_at

string<date-time>

required

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

Example:

"2024-04-23T10:22:08.100Z"

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 | null

required

Estimated contract value.

Example:

200000

data.expires_at

string<date-time> | null

required

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

Example:

null

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"]

Unarchive product Get quote

⌘I

API documentation

Integrations

Analytics

Bank Accounts

Billable events

Companies

Coupons

Coupons > Promotion codes

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Exports

Files

Integrations

Invoices

Invoices > Transactions

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Subscriptions > Templates

Taxes

Third-party apps

Wallets

Webhooks

Get quotes

Authorizations

Query Parameters

Response