Create quote

POST

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": [
      {
        "activation_strategy": "manual",
        "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>"
            ]
          }
        ],
        "billing_cycle_alignment": "anniversary",
        "end_strategy": "duration",
        "starts_at": "2024-10-13T02:00:00.000Z",
        "ends_at": "2024-10-13T02:00:00.000Z",
        "billing_date_setting": "phase_start",
        "initial_billing_at": "2024-10-13T02:00:00.000Z",
        "duration": {
          "count": 1,
          "period": "years"
        },
        "order": 0,
        "transition_calculation_method": "prorata",
        "transition_invoicing_schedule": "immediately",
        "type": "standard"
      }
    ]
  }
}'

{
  "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.

Body

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

template_id

string

required

ID of the quote template. If not specified, a subscription configuration must be defined.

Example:

"quot_9hNWq4c84Z146W"

status

enum<string>

Quote status.

draft: The quote is a draft.
approved: The quote is approved and ready to be sent to the customer.
pending_signature: The quote is awaiting the customer's signature.

Available options:

draft,

approved,

pending_signature

Example:

"draft"

owner_email

string

Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.

Example:

"joe@acme.com"

invoicing_entity_id

string

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

comments

string

Custom comments displayed on the quote.

Example:

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

terms

string

Custom quotation terms.

Example:

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

amount

number | null

Estimated contract value. If not specified, automatically computed from the subscription configuration.

Example:

20000

collect_payment_details

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

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

Example:

[]

automatically_start_subscription

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

Example:

true

expires_at

string

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

Example:

"2024-04-28T14:12:09.293Z"

subscription

object

Subscription configuration constituting the quote.

subscription.phases

object[]

required

subscription.phases.activation_strategy

enum<string>

required

Activation strategy of subscription phase.

immediately: The phase starts as soon as the subscription is activated.
manual: The phase starts when a user manually activates it.
start_date: The phase starts on a specified date.
quote_signature: The phase starts when the subscription quote is signed.
checkout: The phase starts when the subscription checkout is completed.
contract_start_date: The phase starts on the start date of the related subscription contract.
previous_phase_end: The phase starts when the previous phase ends.

Available options:

start_date,

manual,

checkout,

contract_start_date,

previous_phase_end,

immediately,

quote_signature

Example:

"manual"

subscription.phases.products

object[]

required

subscription.phases.products.id

string

required

Product ID.

Example:

"itm_FJKlqUb8COXw55"

subscription.phases.products.name

string

Product name. This will appear on the final invoices.

Example:

"Product name"

subscription.phases.products.description

string

Product description. This will appear on the final invoices.

Example:

"A description of the product."

subscription.phases.products.description_display_interval_dates

boolean

default:false

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

subscription.phases.products.payment_interval

object

Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.

Example:

{ "period": "months", "count": 1 }

subscription.phases.products.payment_schedule

enum<string>

Indicates if the product should be billed at the start or the end of the payment interval.

Available options:

start,

end

Example:

"start"

subscription.phases.products.price

object

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

Example:

{ "type": "fee", "amount": 200 }

subscription.phases.products.prices

object[]

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

Example:

[
  {
    "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
  }
]

subscription.phases.products.count

number

Number of product units. Only applies to products of type flat_fee or seat.

Required range: x >= 1

Example:

2

subscription.phases.products.unit_name

string

Product name. This will appear on the final invoices. Only applies to products of type seat or usage.

Example:

"user"

subscription.phases.products.min_committed_count

number

Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type usage.

Required range: x >= 1

subscription.phases.products.min_amount

number

Minimum amount billed. If the final computed amount from the usage for this product is less than this amount, then this value will be used. Only applies to products of type usage.

subscription.phases.products.max_amount

number

Maximum amount billed. If the final computed amount from the usage for this product is greater than this amount, then this value will be used. Only applies to products of type usage.

subscription.phases.products.metering_interval_type

enum<string>

Indicates on which type of interval the usage should be aggregated.

subscription_commitment: For the usage contained within the subscription commitment period.
payment_interval: For the usage contained within the payment interval of the product.
full_database: For all the usage we ingested for this product, no matter the period. Only applies to products of type usage.

Available options:

subscription_commitment,

payment_interval,

full_database

subscription.phases.products.bill_usage_difference

default:false

Only bill the usage difference comparing to the previous period (i.e. actual amount minus last invoice amount). Doesn't apply to payment_interval metering interval type. Only applies to products of type usage.

subscription.phases.end_strategy

enum<string>

required

End strategy of subscription phase.

manual: The phase ends when a user manually stops it.
end_date: The phase ends on a specified date.
duration: The phase ends after a specific relative duration.
contract_end_date: The phase ends on the end date of the related subscription contract.

Available options:

manual,

end_date,

duration,

contract_end_date

Example:

"duration"

subscription.phases.starts_at

string | null

required

Actual start date of the phase. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.ends_at

string | null

required

Actual end date of the phase. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.billing_date_setting

enum<string>

required

Represents when the first billing date occurs.

phase_start: Aligns with the start of the phase.
specific_date: Occurs on a specified date.

Available options:

phase_start,

specific_date

Example:

"phase_start"

subscription.phases.initial_billing_at

string | null

required

Date when the subscription phase will start being billed. Only applies to specific_date billing date setting. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.duration

object | null

required

Interval over which the subscription phase spans. Only applies to duration end strategy.

Example:

{ "count": 1, "period": "years" }

subscription.phases.order

number

required

Order in which the phase is executed within all subscription phases.

Example:

0

subscription.phases.transition_calculation_method

enum<string>

required

Calculation method used when transitioning from one phase to the next one.

prorata: The prorated amount between the two phases relative to the end date (the transition date) must be paid.
pay_in_full: The full amount for the phase billing period must be paid.
none: No amount will need to be paid, phase will simply transition from one to the next.

Available options:

prorata,

pay_in_full,

none

Example:

"prorata"

subscription.phases.transition_invoicing_schedule

enum<string>

required

Represents when the transition amount will be invoiced.

immediately: An invoice will be generated immediately with the corresponding amount.

Available options:

immediately

Example:

"immediately"

subscription.phases.type

enum<string>

required

Type of subscription phase.

setup: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.
trial: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.
standard: The phase represents a standard recurring billing.

Available options:

setup,

trial,

standard

Example:

"standard"

subscription.phases.coupons

object[]

subscription.phases.billing_cycle_alignment

enum<string>

default:anniversary

Alignment of product billing cycles.

calendar_period: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.
anniversary: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.

Available options:

calendar_period,

anniversary

subscription.name

string

Subscription custom name.

subscription.purchase_order

string

Reference to the purchase order.

subscription.invoicing_entity_id

string

ID of the invoicing entity attached to the subscription.

Example:

"ive_jerrb484RHn"

subscription.generate_draft_invoices

default:false

Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent

subscription.commitment_interval

object

deprecated

Use contract_terms instead. Interval previously used to represent the commitment period of the subscription.

Example:

{ "period": "years", "count": 1 }

subscription.renew_automatically

default:true

deprecated

Use contract_terms instead. Indicates if the subscription should automatically renew.

Example:

true

subscription.renew_for

object

deprecated

Use contract_terms instead. If renew_automatically is enabled, will renew the subscription for the given interval.

Example:

{ "period": "years", "count": 1 }

subscription.minimum_invoice_fee

number | null

Minimum fee applied to each invoice outside of one time payments.

Example:

250

subscription.starts_at

string

Applies only if the activation strategy is start_date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_start

string

deprecated

Use contract_terms instead. Subscription contract start date. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

subscription.contract_end

string

deprecated

Use contract_terms instead. Subscription contract end date. UTC date time string in the ISO 8601 format.

Example:

"2025-01-15T00:00:00Z"

subscription.initial_billing_at

string

Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.cancel_at

string

Subscription cancel date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.cancellation_strategy

enum<string>

Strategy used to cancel the subscription. If not specified do_nothing is used.

charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.
charge_custom: Will charge the customer a custom amount.
refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.
refund_custom: Will refund to the customer a custom amount.
end_of_period: Will cancel the subscription at the end date of the current billing period.
do_nothing: Will only cease the subscription without any additional actions.

Available options:

refund_prorata,

refund_custom,

charge_prorata,

charge_custom,

end_of_period,

do_nothing

subscription.cancellation_amount

number

Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.

Example:

24000

subscription.properties

object

Key/value pairs to store any information you find useful.

subscription.custom_properties

object

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

subscription.contract_terms

object

Contract terms linked to the subscription.

subscription.contract_terms.activation_strategy

enum<string>

required

Activation strategy of the contract.

immediately: The contract will be activated immediately.
manual: The contract will be activated when a user manually activates it.
start_date: The contract will be activated on a specified date.
quote_signature: The contract will be activated when the subscription quote is signed.
checkout: The contract will be activated when the subscription checkout is completed.

Available options:

start_date,

immediately,

manual,

quote_signature,

checkout

Example:

"start_date"

subscription.contract_terms.end_strategy

enum<string>

required

End strategy of contract.

manual: The contract ends when a user manually stops it.
end_date: The contract ends on a specified date.
duration: The contract ends after a specific relative duration, unless renew_automatically is true.

Available options:

end_date,

duration,

manual

Example:

"duration"

subscription.contract_terms.starts_at

string

Start date of the contract. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_terms.ends_at

string

End date of the contract. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_terms.duration

object

Interval over which the contract initially spans. Only applies to duration end strategy.

Example:

{ "count": 6, "period": "months" }

subscription.contract_terms.renew_automatically

Indicates if the contract should be renewed automatically.

true: The contract will be renewed automatically.
false: The contract will not be renewed automatically.

Example:

true

subscription.contract_terms.renew_for_duration

object

Interval over which the contract will be renewed. Only applies if renew_automatically is true.

Example:

{ "count": 1, "period": "years" }

subscription.trial

object

Create a free trial phase based on the plan configuration.

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

template_id

string

required

ID of the quote template. If not specified, a subscription configuration must be defined.

Example:

"quot_9hNWq4c84Z146W"

status

enum<string>

Quote status.

draft: The quote is a draft.
approved: The quote is approved and ready to be sent to the customer.
pending_signature: The quote is awaiting the customer's signature.

Available options:

draft,

approved,

pending_signature

Example:

"draft"

owner_email

string

Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.

Example:

"joe@acme.com"

invoicing_entity_id

string

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

comments

string

Custom comments displayed on the quote.

Example:

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

terms

string

Custom quotation terms.

Example:

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

amount

number | null

Estimated contract value. If not specified, automatically computed from the subscription configuration.

Example:

20000

collect_payment_details

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

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

Example:

[]

automatically_start_subscription

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

Example:

true

expires_at

string

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

Example:

"2024-04-28T14:12:09.293Z"

subscription

object

Subscription configuration constituting the quote.

subscription.phases

object[]

required

subscription.phases.activation_strategy

enum<string>

required

Activation strategy of subscription phase.

immediately: The phase starts as soon as the subscription is activated.
manual: The phase starts when a user manually activates it.
start_date: The phase starts on a specified date.
quote_signature: The phase starts when the subscription quote is signed.
checkout: The phase starts when the subscription checkout is completed.
contract_start_date: The phase starts on the start date of the related subscription contract.
previous_phase_end: The phase starts when the previous phase ends.

Available options:

start_date,

manual,

checkout,

contract_start_date,

previous_phase_end,

immediately,

quote_signature

Example:

"manual"

subscription.phases.products

object[]

required

subscription.phases.products.id

string

required

Product ID.

Example:

"itm_FJKlqUb8COXw55"

subscription.phases.products.name

string

Product name. This will appear on the final invoices.

Example:

"Product name"

subscription.phases.products.description

string

Product description. This will appear on the final invoices.

Example:

"A description of the product."

subscription.phases.products.description_display_interval_dates

boolean

default:false

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

subscription.phases.products.payment_interval

object

Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.

Example:

{ "period": "months", "count": 1 }

subscription.phases.products.payment_schedule

enum<string>

Indicates if the product should be billed at the start or the end of the payment interval.

Available options:

start,

end

Example:

"start"

subscription.phases.products.price

object

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

Example:

{ "type": "fee", "amount": 200 }

subscription.phases.products.prices

object[]

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

Example:

[
  {
    "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
  }
]

subscription.phases.products.count

number

Number of product units. Only applies to products of type flat_fee or seat.

Required range: x >= 1

Example:

2

subscription.phases.products.unit_name

string

Product name. This will appear on the final invoices. Only applies to products of type seat or usage.

Example:

"user"

subscription.phases.products.min_committed_count

number

Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type usage.

Required range: x >= 1

subscription.phases.products.min_amount

number

Minimum amount billed. If the final computed amount from the usage for this product is less than this amount, then this value will be used. Only applies to products of type usage.

subscription.phases.products.max_amount

number

Maximum amount billed. If the final computed amount from the usage for this product is greater than this amount, then this value will be used. Only applies to products of type usage.

subscription.phases.products.metering_interval_type

enum<string>

Indicates on which type of interval the usage should be aggregated.

subscription_commitment: For the usage contained within the subscription commitment period.
payment_interval: For the usage contained within the payment interval of the product.
full_database: For all the usage we ingested for this product, no matter the period. Only applies to products of type usage.

Available options:

subscription_commitment,

payment_interval,

full_database

subscription.phases.products.bill_usage_difference

default:false

subscription.phases.end_strategy

enum<string>

required

End strategy of subscription phase.

manual: The phase ends when a user manually stops it.
end_date: The phase ends on a specified date.
duration: The phase ends after a specific relative duration.
contract_end_date: The phase ends on the end date of the related subscription contract.

Available options:

manual,

end_date,

duration,

contract_end_date

Example:

"duration"

subscription.phases.starts_at

string | null

required

Actual start date of the phase. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.ends_at

string | null

required

Actual end date of the phase. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.billing_date_setting

enum<string>

required

Represents when the first billing date occurs.

phase_start: Aligns with the start of the phase.
specific_date: Occurs on a specified date.

Available options:

phase_start,

specific_date

Example:

"phase_start"

subscription.phases.initial_billing_at

string | null

required

Date when the subscription phase will start being billed. Only applies to specific_date billing date setting. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.duration

object | null

required

Interval over which the subscription phase spans. Only applies to duration end strategy.

Example:

{ "count": 1, "period": "years" }

subscription.phases.order

number

required

Order in which the phase is executed within all subscription phases.

Example:

0

subscription.phases.transition_calculation_method

enum<string>

required

Calculation method used when transitioning from one phase to the next one.

prorata: The prorated amount between the two phases relative to the end date (the transition date) must be paid.
pay_in_full: The full amount for the phase billing period must be paid.
none: No amount will need to be paid, phase will simply transition from one to the next.

Available options:

prorata,

pay_in_full,

none

Example:

"prorata"

subscription.phases.transition_invoicing_schedule

enum<string>

required

Represents when the transition amount will be invoiced.

immediately: An invoice will be generated immediately with the corresponding amount.

Available options:

immediately

Example:

"immediately"

subscription.phases.type

enum<string>

required

Type of subscription phase.

setup: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.
trial: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.
standard: The phase represents a standard recurring billing.

Available options:

setup,

trial,

standard

Example:

"standard"

subscription.phases.coupons

object[]

subscription.phases.billing_cycle_alignment

enum<string>

default:anniversary

Alignment of product billing cycles.

calendar_period: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.
anniversary: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.

Available options:

calendar_period,

anniversary

subscription.name

string

Subscription custom name.

subscription.purchase_order

string

Reference to the purchase order.

subscription.invoicing_entity_id

string

ID of the invoicing entity attached to the subscription.

Example:

"ive_jerrb484RHn"

subscription.generate_draft_invoices

default:false

Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent

subscription.commitment_interval

object

deprecated

Use contract_terms instead. Interval previously used to represent the commitment period of the subscription.

Example:

{ "period": "years", "count": 1 }

subscription.renew_automatically

default:true

deprecated

Use contract_terms instead. Indicates if the subscription should automatically renew.

Example:

true

subscription.renew_for

object

deprecated

Use contract_terms instead. If renew_automatically is enabled, will renew the subscription for the given interval.

Example:

{ "period": "years", "count": 1 }

subscription.minimum_invoice_fee

number | null

Minimum fee applied to each invoice outside of one time payments.

Example:

250

subscription.starts_at

string

Applies only if the activation strategy is start_date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_start

string

deprecated

Use contract_terms instead. Subscription contract start date. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

subscription.contract_end

string

deprecated

Use contract_terms instead. Subscription contract end date. UTC date time string in the ISO 8601 format.

Example:

"2025-01-15T00:00:00Z"

subscription.initial_billing_at

string

Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.cancel_at

string

Subscription cancel date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.cancellation_strategy

enum<string>

Strategy used to cancel the subscription. If not specified do_nothing is used.

charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.
charge_custom: Will charge the customer a custom amount.
refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.
refund_custom: Will refund to the customer a custom amount.
end_of_period: Will cancel the subscription at the end date of the current billing period.
do_nothing: Will only cease the subscription without any additional actions.

Available options:

refund_prorata,

refund_custom,

charge_prorata,

charge_custom,

end_of_period,

do_nothing

subscription.cancellation_amount

number

Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.

Example:

24000

subscription.properties

object

Key/value pairs to store any information you find useful.

subscription.custom_properties

object

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

subscription.contract_terms

object

Contract terms linked to the subscription.

subscription.contract_terms.activation_strategy

enum<string>

required

Activation strategy of the contract.

immediately: The contract will be activated immediately.
manual: The contract will be activated when a user manually activates it.
start_date: The contract will be activated on a specified date.
quote_signature: The contract will be activated when the subscription quote is signed.
checkout: The contract will be activated when the subscription checkout is completed.

Available options:

start_date,

immediately,

manual,

quote_signature,

checkout

Example:

"start_date"

subscription.contract_terms.end_strategy

enum<string>

required

End strategy of contract.

manual: The contract ends when a user manually stops it.
end_date: The contract ends on a specified date.
duration: The contract ends after a specific relative duration, unless renew_automatically is true.

Available options:

end_date,

duration,

manual

Example:

"duration"

subscription.contract_terms.starts_at

string

Start date of the contract. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_terms.ends_at

string

End date of the contract. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_terms.duration

object

Interval over which the contract initially spans. Only applies to duration end strategy.

Example:

{ "count": 6, "period": "months" }

subscription.contract_terms.renew_automatically

Indicates if the contract should be renewed automatically.

true: The contract will be renewed automatically.
false: The contract will not be renewed automatically.

Example:

true

subscription.contract_terms.renew_for_duration

object

Interval over which the contract will be renewed. Only applies if renew_automatically is true.

Example:

{ "count": 1, "period": "years" }

subscription.trial

object

Create a free trial phase based on the plan configuration.

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

subscription

object

required

Subscription configuration constituting the quote.

subscription.phases

object[]

required

subscription.phases.activation_strategy

enum<string>

required

Activation strategy of subscription phase.

immediately: The phase starts as soon as the subscription is activated.
manual: The phase starts when a user manually activates it.
start_date: The phase starts on a specified date.
quote_signature: The phase starts when the subscription quote is signed.
checkout: The phase starts when the subscription checkout is completed.
contract_start_date: The phase starts on the start date of the related subscription contract.
previous_phase_end: The phase starts when the previous phase ends.

Available options:

start_date,

manual,

checkout,

contract_start_date,

previous_phase_end,

immediately,

quote_signature

Example:

"manual"

subscription.phases.products

object[]

required

subscription.phases.products.id

string

required

Product ID.

Example:

"itm_FJKlqUb8COXw55"

subscription.phases.products.name

string

Product name. This will appear on the final invoices.

Example:

"Product name"

subscription.phases.products.description

string

Product description. This will appear on the final invoices.

Example:

"A description of the product."

subscription.phases.products.description_display_interval_dates

boolean

default:false

Indicates if the dates of the interval should be automatically added in the product description on the invoices.

subscription.phases.products.payment_interval

object

Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.

Example:

{ "period": "months", "count": 1 }

subscription.phases.products.payment_schedule

enum<string>

Indicates if the product should be billed at the start or the end of the payment interval.

Available options:

start,

end

Example:

"start"

subscription.phases.products.price

object

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

Example:

{ "type": "fee", "amount": 200 }

subscription.phases.products.prices

object[]

Price of the product. If not specified, the matching prices (depending on the currency, interval, etc) of the product defined in the products catalog/plan are used.

Example:

[
  {
    "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
  }
]

subscription.phases.products.count

number

Number of product units. Only applies to products of type flat_fee or seat.

Required range: x >= 1

Example:

2

subscription.phases.products.unit_name

string

Product name. This will appear on the final invoices. Only applies to products of type seat or usage.

Example:

"user"

subscription.phases.products.min_committed_count

number

Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type usage.

Required range: x >= 1

subscription.phases.products.min_amount

number

Minimum amount billed. If the final computed amount from the usage for this product is less than this amount, then this value will be used. Only applies to products of type usage.

subscription.phases.products.max_amount

number

Maximum amount billed. If the final computed amount from the usage for this product is greater than this amount, then this value will be used. Only applies to products of type usage.

subscription.phases.products.metering_interval_type

enum<string>

Indicates on which type of interval the usage should be aggregated.

subscription_commitment: For the usage contained within the subscription commitment period.
payment_interval: For the usage contained within the payment interval of the product.
full_database: For all the usage we ingested for this product, no matter the period. Only applies to products of type usage.

Available options:

subscription_commitment,

payment_interval,

full_database

subscription.phases.products.bill_usage_difference

default:false

subscription.phases.end_strategy

enum<string>

required

End strategy of subscription phase.

manual: The phase ends when a user manually stops it.
end_date: The phase ends on a specified date.
duration: The phase ends after a specific relative duration.
contract_end_date: The phase ends on the end date of the related subscription contract.

Available options:

manual,

end_date,

duration,

contract_end_date

Example:

"duration"

subscription.phases.starts_at

string | null

required

Actual start date of the phase. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.ends_at

string | null

required

Actual end date of the phase. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.billing_date_setting

enum<string>

required

Represents when the first billing date occurs.

phase_start: Aligns with the start of the phase.
specific_date: Occurs on a specified date.

Available options:

phase_start,

specific_date

Example:

"phase_start"

subscription.phases.initial_billing_at

string | null

required

Date when the subscription phase will start being billed. Only applies to specific_date billing date setting. UTC date time string in the ISO 8601 format.

Example:

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

subscription.phases.duration

object | null

required

Interval over which the subscription phase spans. Only applies to duration end strategy.

Example:

{ "count": 1, "period": "years" }

subscription.phases.order

number

required

Order in which the phase is executed within all subscription phases.

Example:

0

subscription.phases.transition_calculation_method

enum<string>

required

Calculation method used when transitioning from one phase to the next one.

prorata: The prorated amount between the two phases relative to the end date (the transition date) must be paid.
pay_in_full: The full amount for the phase billing period must be paid.
none: No amount will need to be paid, phase will simply transition from one to the next.

Available options:

prorata,

pay_in_full,

none

Example:

"prorata"

subscription.phases.transition_invoicing_schedule

enum<string>

required

Represents when the transition amount will be invoiced.

immediately: An invoice will be generated immediately with the corresponding amount.

Available options:

immediately

Example:

"immediately"

subscription.phases.type

enum<string>

required

Type of subscription phase.

setup: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.
trial: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.
standard: The phase represents a standard recurring billing.

Available options:

setup,

trial,

standard

Example:

"standard"

subscription.phases.coupons

object[]

subscription.phases.billing_cycle_alignment

enum<string>

default:anniversary

Alignment of product billing cycles.

calendar_period: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.
anniversary: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.

Available options:

calendar_period,

anniversary

subscription.name

string

Subscription custom name.

subscription.purchase_order

string

Reference to the purchase order.

subscription.invoicing_entity_id

string

ID of the invoicing entity attached to the subscription.

Example:

"ive_jerrb484RHn"

subscription.generate_draft_invoices

default:false

Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent

subscription.commitment_interval

object

deprecated

Use contract_terms instead. Interval previously used to represent the commitment period of the subscription.

Example:

{ "period": "years", "count": 1 }

subscription.renew_automatically

default:true

deprecated

Use contract_terms instead. Indicates if the subscription should automatically renew.

Example:

true

subscription.renew_for

object

deprecated

Use contract_terms instead. If renew_automatically is enabled, will renew the subscription for the given interval.

Example:

{ "period": "years", "count": 1 }

subscription.minimum_invoice_fee

number | null

Minimum fee applied to each invoice outside of one time payments.

Example:

250

subscription.starts_at

string

Applies only if the activation strategy is start_date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_start

string

deprecated

Use contract_terms instead. Subscription contract start date. UTC date time string in the ISO 8601 format.

Example:

"2024-01-15T00:00:00Z"

subscription.contract_end

string

deprecated

Use contract_terms instead. Subscription contract end date. UTC date time string in the ISO 8601 format.

Example:

"2025-01-15T00:00:00Z"

subscription.initial_billing_at

string

Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.cancel_at

string

Subscription cancel date. UTC date time string in the ISO 8601 format.

Example:

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

subscription.cancellation_strategy

enum<string>

Strategy used to cancel the subscription. If not specified do_nothing is used.

charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.
charge_custom: Will charge the customer a custom amount.
refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.
refund_custom: Will refund to the customer a custom amount.
end_of_period: Will cancel the subscription at the end date of the current billing period.
do_nothing: Will only cease the subscription without any additional actions.

Available options:

refund_prorata,

refund_custom,

charge_prorata,

charge_custom,

end_of_period,

do_nothing

subscription.cancellation_amount

number

Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.

Example:

24000

subscription.properties

object

Key/value pairs to store any information you find useful.

subscription.custom_properties

object

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

subscription.contract_terms

object

Contract terms linked to the subscription.

subscription.contract_terms.activation_strategy

enum<string>

required

Activation strategy of the contract.

immediately: The contract will be activated immediately.
manual: The contract will be activated when a user manually activates it.
start_date: The contract will be activated on a specified date.
quote_signature: The contract will be activated when the subscription quote is signed.
checkout: The contract will be activated when the subscription checkout is completed.

Available options:

start_date,

immediately,

manual,

quote_signature,

checkout

Example:

"start_date"

subscription.contract_terms.end_strategy

enum<string>

required

End strategy of contract.

manual: The contract ends when a user manually stops it.
end_date: The contract ends on a specified date.
duration: The contract ends after a specific relative duration, unless renew_automatically is true.

Available options:

end_date,

duration,

manual

Example:

"duration"

subscription.contract_terms.starts_at

string

Start date of the contract. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_terms.ends_at

string

End date of the contract. UTC date time string in the ISO 8601 format.

Example:

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

subscription.contract_terms.duration

object

Interval over which the contract initially spans. Only applies to duration end strategy.

Example:

{ "count": 6, "period": "months" }

subscription.contract_terms.renew_automatically

Indicates if the contract should be renewed automatically.

true: The contract will be renewed automatically.
false: The contract will not be renewed automatically.

Example:

true

subscription.contract_terms.renew_for_duration

object

Interval over which the contract will be renewed. Only applies if renew_automatically is true.

Example:

{ "count": 1, "period": "years" }

subscription.trial

object

Create a free trial phase based on the plan configuration.

status

enum<string>

Quote status.

draft: The quote is a draft.
approved: The quote is approved and ready to be sent to the customer.
pending_signature: The quote is awaiting the customer's signature.

Available options:

draft,

approved,

pending_signature

Example:

"draft"

owner_email

string

Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.

Example:

"joe@acme.com"

invoicing_entity_id

string

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

comments

string

Custom comments displayed on the quote.

Example:

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

terms

string

Custom quotation terms.

Example:

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

amount

number | null

Estimated contract value. If not specified, automatically computed from the subscription configuration.

Example:

20000

collect_payment_details

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

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

Example:

[]

automatically_start_subscription

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

Example:

true

Response

201 - application/json

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

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"

amount

number

required

Estimated contract value.

Example:

200000

expires_at

string | null

required

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

Example:

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

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"

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"

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

automatically_start_subscription

boolean

required

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

Example:

true

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

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"

amount

number

required

Estimated contract value.

Example:

200000

expires_at

string | null

required

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

Example:

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

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"

subscription_id

string | null

required

Example:

"sub_B6ClkdqNqVNBgY"

child_subscription_ids

string[]

required

Example:

["sub_0z39oqdhKl0PXb"]

automatically_start_subscription

boolean

required

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

Example:

true

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

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"

amount

number

required

Estimated contract value.

Example:

200000

expires_at

string | null

required

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

Example:

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

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:

one_off

Example:

"one_off"

invoice_id

string | null

required

ID of the invoice attached to the quote. Only applies to the one_off quote type. The get invoice endpoint (GET /v1/invoices/{id}) can be used to retrieve the related details.

Example:

"inv_0ADWB0lzH52RFt"

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

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"

subscription_id

string

required

Example:

"sub_B6ClkdqNqVNBgY"

child_subscription_ids

string[]

required

Example:

["sub_0z39oqdhKl0PXb"]

automatically_start_subscription

boolean

required

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

Example:

true

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:

pending_approval,

changes_requested

Example:

"pending_approval"

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

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"

subscription_id

string

required

Example:

"sub_B6ClkdqNqVNBgY"

child_subscription_ids

string[]

required

Example:

["sub_0z39oqdhKl0PXb"]

automatically_start_subscription

boolean

required

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

Example:

true

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:

approved,

pending_signature

Example:

"pending_signature"

approved_at

string

required

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

Example:

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

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

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"

subscription_id

string

required

Example:

"sub_B6ClkdqNqVNBgY"

child_subscription_ids

string[]

required

Example:

["sub_0z39oqdhKl0PXb"]

automatically_start_subscription

boolean

required

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

Example:

true

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:

signed

Example:

"signed"

approved_at

string

required

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

Example:

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

signature

object

required

Quote signature. Only applies to the signed quote.

Example:

{ "mode": "basic", "signerName": "Acme" }

signed_at

string

required

Quote signature date. Only applies to the signed quote.

Example:

"2024-04-25T12:22:08.100Z"

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

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:

one_off

Example:

"one_off"

invoice_id

string

required

ID of the invoice attached to the quote. Only applies to the one_off quote type. The get invoice endpoint (GET /v1/invoices/{id}) can be used to retrieve the related details.

Example:

"inv_0ADWB0lzH52RFt"

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:

pending_approval,

changes_requested

Example:

"pending_approval"

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

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:

one_off

Example:

"one_off"

invoice_id

string

required

ID of the invoice attached to the quote. Only applies to the one_off quote type. The get invoice endpoint (GET /v1/invoices/{id}) can be used to retrieve the related details.

Example:

"inv_0ADWB0lzH52RFt"

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:

approved,

pending_signature

Example:

"pending_signature"

approved_at

string

required

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

Example:

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

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string

required

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

Example:

"2024-04-28T14:12:09.293Z"

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:

one_off

Example:

"one_off"

invoice_id

string

required

ID of the invoice attached to the quote. Only applies to the one_off quote type. The get invoice endpoint (GET /v1/invoices/{id}) can be used to retrieve the related details.

Example:

"inv_0ADWB0lzH52RFt"

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:

signed

Example:

"signed"

approved_at

string

required

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

Example:

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

signature

object

required

Quote signature. Only applies to the signed quote.

Example:

{ "mode": "basic", "signerName": "Acme" }

signed_at

string

required

Quote signature date. Only applies to the signed quote.

Example:

"2024-04-25T12:22:08.100Z"

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

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

Example:

"voided"

void_reason

string

required

Quote voiding reason. Only applies to the voided quote.

Example:

"The customer is ultimately not interested."

voided_at

string

required

Quote voiding date. Only applies to the voided quote.

Example:

"2024-04-26T12:00:01.320Z"

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string | null

required

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

Example:

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

approved_at

string | null

required

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

Example:

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

signature

object | null

required

Quote signature. Only applies to the signed quote.

Example:

{ "mode": "basic", "signerName": "Acme" }

signed_at

string | null

required

Quote signature date. Only applies to the signed quote.

Example:

"2024-04-25T12:22:08.100Z"

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"

subscription_id

string | null

required

Example:

"sub_B6ClkdqNqVNBgY"

child_subscription_ids

string[]

required

Example:

["sub_0z39oqdhKl0PXb"]

automatically_start_subscription

boolean

required

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

Example:

true

string

required

Quote ID.

Example:

"quo_hXQCd5y8P3GYXa"

customer_id

string

required

ID of the customer.

Example:

"cus_QalW2vTAdkR6IY"

invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

Example:

"ive_47484fjdhy5"

template_id

string | null

required

ID of the quote template.

Example:

"quot_9hNWq4c84Z146W"

crm_opportunity_id

string | null

required

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

number

string

required

Quote sequential number.

Example:

"327"

comments

string | null

required

Custom comments displayed on the quote.

Example:

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

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

owner_email

string | null

required

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

Example:

"joe@acme.com"

collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

Example:

true

collect_custom_property_ids

string[]

required

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

Example:

[]

attachments

object[]

required

List of documents attached to the quote.

Example:

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

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.

Example:

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

created_at

string | null

required

UTC date time string in the ISO 8601 format.

Example:

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

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

Example:

"voided"

void_reason

string

required

Quote voiding reason. Only applies to the voided quote.

Example:

"The customer is ultimately not interested."

voided_at

string

required

Quote voiding date. Only applies to the voided quote.

Example:

"2024-04-26T12:00:01.320Z"

amount

number

required

Estimated contract value.

Example:

20000

expires_at

string | null

required

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

Example:

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

approved_at

string | null

required

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

Example:

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

signature

object | null

required

Quote signature. Only applies to the signed quote.

Example:

{ "mode": "basic", "signerName": "Acme" }

signed_at

string | null

required

Quote signature date. Only applies to the signed quote.

Example:

"2024-04-25T12:22:08.100Z"

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:

one_off

Example:

"one_off"

invoice_id

string | null

required

ID of the invoice attached to the quote. Only applies to the one_off quote type. The get invoice endpoint (GET /v1/invoices/{id}) can be used to retrieve the related details.

Example:

"inv_0ADWB0lzH52RFt"

Get quote Download quote

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": [
      {
        "activation_strategy": "manual",
        "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>"
            ]
          }
        ],
        "billing_cycle_alignment": "anniversary",
        "end_strategy": "duration",
        "starts_at": "2024-10-13T02:00:00.000Z",
        "ends_at": "2024-10-13T02:00:00.000Z",
        "billing_date_setting": "phase_start",
        "initial_billing_at": "2024-10-13T02:00:00.000Z",
        "duration": {
          "count": 1,
          "period": "years"
        },
        "order": 0,
        "transition_calculation_method": "prorata",
        "transition_invoicing_schedule": "immediately",
        "type": "standard"
      }
    ]
  }
}'

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

Body

Response