GET
/
v1
/
quotes
/
{id}
curl --request GET \
  --url https://api.hyperline.co/v1/quotes/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Quote ID.

number
string
required

Quote sequential number.

comments
string | null
required

Quote custom comments.

terms
string | null
required

Quote custom terms.

automatically_start_subscription
boolean
required

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

customer_id
string
required

ID of the customer.

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

UTC date time string in the ISO 8601 format.

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.

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.

amount
number
required

Estimated contract value.

expires_at
string | null
required

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

approved_at
string | null
required

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

signatory
string | null
required

Signatory of the quote. Only applies to the signed quote.

signed_at
string | null
required

Quote signature date. Only applies to the signed quote.

Get quotesDownload quote file