GET
/
v1
/
quotes
curl --request GET \
  --url https://api.hyperline.co/v1/quotes \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 123
  },
  "data": [
    {
      "id": "quo_hXQCd5y8P3GYXa",
      "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.",
      "automatically_start_subscription": true,
      "customer_id": "quo_hXQCd5y8P3GYXa",
      "documents": [
        {
          "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": "2023-01-20T16:04:11Z",
      "status": "voided",
      "void_reason": "The customer has decided not to sign the quote.",
      "voided_at": "2024-04-22T12:00:01.320Z",
      "subscription_id": "sub_B6ClkdqNqVNBgY",
      "amount": 200000,
      "expires_at": "2023-11-07T05:31:56Z",
      "approved_at": "2024-04-24T09:10:00.220Z",
      "signatory": "2024-04-24T09:10:00.220Z",
      "signed_at": "2024-04-25T12:22:08.100Z"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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

Query Parameters

take
number | null
default: 50
skip
number | null
default: 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
status__notIn
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.

Update productGet quote