Prepared for Acme Corp.
billing_items: $ref: '#/components/schemas/QuoteBillingItems' ApiErrorUnauthorized: type: object required: - status - error properties: status: type: integer format: int32 example: 401 error: type: string example: Unauthorized ApiErrorForbidden: type: object required: - status - error - code properties: status: type: integer format: int32 example: 403 error: type: string example: Forbidden code: type: string example: feature_unavailable ApiErrorNotFound: type: object required: - status - error - code properties: status: type: integer format: int32 example: 404 error: type: string example: Not Found code: type: string example: object_not_found QuoteVersionObject: type: object required: - lago_id - lago_quote_id - lago_organization_id - version - status - currency - billing_entity_code - void_reason - approved_at - voided_at - created_at - updated_at properties: lago_id: type: string format: uuid description: Unique identifier of the quote version, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 lago_quote_id: type: string format: uuid description: >- Unique identifier of the quote the version belongs to, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 lago_organization_id: type: string format: uuid description: Unique identifier of the organization, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 version: type: integer description: >- The number of the version within the quote. It starts at 1 and increases by 1 for every new version created by cloning. example: 1 status: $ref: '#/components/schemas/QuoteVersionStatusEnum' currency: $ref: '#/components/schemas/CurrencyOrNull' description: The currency the version is quoted in. billing_entity_code: type: - string - 'null' description: >- Unique code identifying the billing entity that issues the deal. It is resolved rather than stored: the version's own entity when it names one, then the entity of the subscription being amended for a `subscription_amendment` quote, then the customer's own. It is `null` when none of them resolves. An amendment cannot name an entity itself, since the subscription it restates is already bound to one, and naming one on an amendment is rejected. example: acme_corp void_reason: $ref: '#/components/schemas/QuoteVersionVoidReasonEnum' approved_at: type: - string - 'null' format: date-time description: >- The date and time in UTC (ISO 8601) when the version was approved. It is `null` unless the `status` is `approved`. example: '2026-04-29T08:59:51Z' voided_at: type: - string - 'null' format: date-time description: >- The date and time in UTC (ISO 8601) when the version was voided. It is `null` unless the `status` is `voided`. example: '2026-04-29T08:59:51Z' created_at: type: string format: date-time description: The date and time in UTC (ISO 8601) when the version was created. example: '2026-04-29T08:59:51Z' updated_at: type: string format: date-time description: >- The date and time in UTC (ISO 8601) when the version was last updated. example: '2026-04-29T08:59:51Z' QuoteBillingItems: type: - object - 'null' description: > A snapshot of everything the quote bills. Unlike the rest of the Lago API, the keys nested in this object are camelCased: the object is stored and returned as it is authored in the Lago user interface. Which top-level keys are present depends on the `order_type` of the parent quote: - `one_off`: `addOns`. - `subscription_creation` and `subscription_amendment`: `plans`, plus the optional `coupons` and `walletCredits`. Every entry pins the catalog record it was built from through its `id` and its `payload`, so that an approved quote keeps billing what was approved even if the catalog changes afterwards. The optional `overrides` object carries the deviations from that record negotiated on the quote. This object is the single source of truth for the term of the deal. Three of its nested dates bound that term, because the execution flow refuses them once past: `plans[].payload.endDate`, `walletCredits[].payload.expirationAt` and the `expirationAt` of a wallet credit's recurring top-up rule. The earliest of them is the day the deal stops being executable, and both the signing window and the execution date must fall strictly before it. A `one_off` quote carries none of them and is never bounded. On a `draft` version this object may be incomplete: only the properties documented as required below are enforced on every save, the others are enforced when the version is approved. properties: addOns: type: array description: >- The add-ons billed once by a `one_off` quote. At least one entry is required to approve the version. items: $ref: '#/components/schemas/QuoteBillingItemAddOnObject' plans: type: array description: >- The plans subscribed to, or amended, by a `subscription_creation` or `subscription_amendment` quote. At least one entry is required to approve the version. items: $ref: '#/components/schemas/QuoteBillingItemPlanObject' coupons: type: array description: The coupons applied to the customer when the quote is executed. items: $ref: '#/components/schemas/QuoteBillingItemCouponObject' walletCredits: type: array description: >- The prepaid credit wallets created for the customer when the quote is executed. items: $ref: '#/components/schemas/QuoteBillingItemWalletCreditObject' QuoteVersionStatusEnum: type: string description: > The status of the quote version. It can be any of the following values: - `draft`: the version is still editable. - `approved`: the version has been approved and an order form has been generated from it. - `voided`: the version is no longer actionable. A quote has at most one version in `draft` or `approved` status at any time; all the other versions are `voided`. enum: - draft - approved - voided example: draft CurrencyOrNull: type: - string - 'null' example: USD enum: - null - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BIF - BMD - BND - BOB - BRL - BSD - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - ISK - JMD - JPY - KES - KGS - KHR - KMF - KRW - KYD - KZT - LAK - LBP - LKR - LRD - LSL - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLL - SOS - SRD - STD - SZL - THB - TJS - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW QuoteVersionVoidReasonEnum: type: - string - 'null' description: > The reason why the quote version was voided. It is `null` unless the `status` is `voided`. It can be any of the following values: - `manual`: voided explicitly, through the API or the Lago user interface. - `superseded`: voided because the version was cloned into a new draft. - `cascade_of_expired`: voided because the order form generated from the version expired. - `cascade_of_voided`: voided because the order form generated from the version was voided. enum: - null - manual - superseded - cascade_of_expired - cascade_of_voided example: manual QuoteBillingItemAddOnObject: type: object required: - id - localId - type - payload properties: id: type: string format: uuid description: >- Unique identifier of the add-on in Lago, pinned when the entry was added to the quote. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 localId: type: string description: >- Identifier of the entry within the quote version, assigned by the Lago user interface. It allows the quote document to reference the entry. example: b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b type: type: string description: The kind of billing item. enum: - add_on example: add_on payload: type: object description: >- A snapshot of the add-on as it was added to the quote. `code`, `units`, `unitAmountCents` and `totalAmountCents` are required to approve the version. properties: code: type: string description: Unique code identifying the add-on. example: setup_fee units: type: number description: The number of units billed. It must be greater than 0. example: 1 unitAmountCents: type: integer description: >- The amount of one unit, in cents, in the currency of the quote version. example: 10000 totalAmountCents: type: integer description: >- The total amount billed for the entry, in cents, in the currency of the quote version. example: 10000 fromDatetime: type: - string - 'null' format: date-time description: >- The beginning of the period covered by the entry, in UTC (ISO 8601). example: '2026-01-01T00:00:00Z' toDatetime: type: - string - 'null' format: date-time description: The end of the period covered by the entry, in UTC (ISO 8601). example: '2026-12-31T23:59:59Z' overrides: type: object description: >- The deviations from the add-on snapshot negotiated on the quote. Only the properties set here are overridden. properties: description: type: string description: Overrides the description of the add-on. example: Onboarding package, discounted for the first year units: type: number description: Overrides the number of units billed. It must be greater than 0. example: 2 unitAmountCents: type: integer description: Overrides the amount of one unit, in cents. example: 8000 totalAmountCents: type: integer description: Overrides the total amount billed for the entry, in cents. example: 16000 invoiceDisplayName: type: string description: Overrides the name of the add-on as it appears on the invoice. example: Onboarding fromDatetime: type: - string - 'null' format: date-time description: >- Overrides the beginning of the period covered by the entry, in UTC (ISO 8601). example: '2026-01-01T00:00:00Z' toDatetime: type: - string - 'null' format: date-time description: >- Overrides the end of the period covered by the entry, in UTC (ISO 8601). example: '2026-12-31T23:59:59Z' QuoteBillingItemPlanObject: type: object required: - id - type - payload properties: id: type: string format: uuid description: >- Unique identifier of the plan in Lago, pinned when the entry was added to the quote. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 localId: type: - string - 'null' description: >- Identifier of the entry within the quote version, assigned by the Lago user interface. It allows the quote document to reference the entry. example: b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b type: type: string description: The kind of billing item. enum: - plan example: plan payload: type: object description: >- A snapshot of the plan as it was added to the quote, and of the subscription to create from it. Additional catalog properties may be present, as only the ones Lago reads when the quote is executed are documented here. `code` is required to approve the version. properties: code: type: string description: Unique code identifying the plan. example: premium_plan subscriptionExternalId: type: - string - 'null' description: >- The external unique identifier to assign to the subscription created from the entry. For a `subscription_amendment` quote, it identifies the subscription being amended. example: sub_1234567890 subscriptionName: type: - string - 'null' description: The name to assign to the subscription created from the entry. example: Premium plan - Acme Corp billingTime: type: - string - 'null' description: The billing time of the subscription created from the entry. enum: - null - calendar - anniversary example: calendar startDate: type: - string - 'null' description: >- The date and time in UTC (ISO 8601) when the subscription starts. It is optional, and a plan naming none starts the moment the order is executed. example: '2026-01-01T00:00:00Z' endDate: type: - string - 'null' description: >- The date and time in UTC (ISO 8601) when the subscription ends. Leaving it unset makes the deal open-ended, and on a `subscription_amendment` quote it leaves the amended subscription's own ending date in place. It bounds the deal, so the signing window and the execution date must both fall strictly before it. example: '2027-01-01T00:00:00Z' paymentMethodId: type: - string - 'null' format: uuid description: >- Unique identifier of the payment method to charge for the subscription, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 charges: type: - array - 'null' description: >- A snapshot of the usage-based charges of the plan. It pins the charge each entry of `overrides.charges` applies to. items: type: object properties: id: type: string format: uuid description: >- Unique identifier of the charge in Lago. It is required to approve the version. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 billableMetric: type: object description: The billable metric the charge is based on. properties: code: type: string description: >- Unique code identifying the billable metric. It is required to approve the version. example: api_calls chargeModel: type: - string - 'null' description: The pricing model of the charge. enum: - null - standard - graduated - graduated_percentage - package - percentage - volume - custom - dynamic example: standard fixedCharges: type: - array - 'null' description: >- A snapshot of the fixed charges of the plan. It pins the fixed charge each entry of `overrides.fixedCharges` applies to. items: type: object properties: id: type: string format: uuid description: >- Unique identifier of the fixed charge in Lago. It is required to approve the version. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 addOn: type: object description: The add-on the fixed charge is based on. properties: code: type: string description: >- Unique code identifying the add-on. It is required to approve the version. example: seats chargeModel: type: - string - 'null' description: The pricing model of the fixed charge. enum: - null - standard - graduated - volume example: standard overrides: type: - object - 'null' description: >- The deviations from the plan snapshot negotiated on the quote. Only the properties set here are overridden. properties: amountCents: type: - integer - 'null' description: Overrides the base amount of the plan, in cents. example: 50000 amountCurrency: $ref: '#/components/schemas/CurrencyOrNull' description: >- Overrides the currency the plan is priced in, which is how a catalog plan is quoted in the currency of the deal. The figure in `amountCents` is not converted, it is restated in this currency. It is set only while it differs from the catalog record, and removed once they agree. invoiceDisplayName: type: - string - 'null' description: Overrides the name of the plan as it appears on the invoice. example: Premium name: type: - string - 'null' description: Overrides the name of the plan. example: Premium plan - Acme Corp description: type: - string - 'null' description: Overrides the description of the plan. example: Negotiated premium plan trialPeriod: type: - number - 'null' description: Overrides the trial period of the plan, in days. example: 30 minimumCommitment: type: - object - 'null' description: Overrides the minimum commitment of the plan. properties: amountCents: type: - integer - 'null' description: >- The amount of the minimum commitment, in cents. It must be greater than 0. example: 100000 invoiceDisplayName: type: - string - 'null' description: >- The name of the minimum commitment as it appears on the invoice. example: Annual commitment usageThresholds: type: - array - 'null' description: Overrides the progressive billing thresholds of the plan. items: type: object required: - amountCents properties: amountCents: type: integer description: >- The usage amount, in cents, at which the threshold is reached. It must be greater than 0. example: 100000 recurring: type: - boolean - 'null' description: >- Whether the threshold applies to every period, instead of only once. example: false thresholdDisplayName: type: - string - 'null' description: The name of the threshold as it appears on the invoice. example: First 1,000 EUR of usage charges: type: - array - 'null' description: >- Overrides the usage-based charges of the plan. Each entry applies to the charge of the same billable metric in `payload.charges`. items: type: object required: - billableMetricCode properties: billableMetricCode: type: string description: >- Unique code identifying the billable metric of the charge to override. example: api_calls chargeModel: type: - string - 'null' description: The pricing model of the charge. enum: - null - standard - graduated - graduated_percentage - package - percentage - volume - custom - dynamic example: standard properties: type: - object - 'null' description: >- The pricing properties of the charge. Their shape depends on the charge model, and is validated when the quote is executed. example: amount: '0.02' minAmountCents: type: - integer - 'null' description: The minimum amount billed for the charge, in cents. example: 10000 invoiceDisplayName: type: - string - 'null' description: The name of the charge as it appears on the invoice. example: API calls fixedCharges: type: - array - 'null' description: >- Overrides the fixed charges of the plan. Each entry applies to the fixed charge of the same add-on in `payload.fixedCharges`. items: type: object required: - addOnCode properties: addOnCode: type: string description: >- Unique code identifying the add-on of the fixed charge to override. example: seats units: type: - string - 'null' description: The number of units billed by the fixed charge. example: '10' properties: type: - object - 'null' description: >- The pricing properties of the fixed charge. Their shape depends on the charge model, and is validated when the quote is executed. example: amount: '5' invoiceDisplayName: type: - string - 'null' description: The name of the fixed charge as it appears on the invoice. example: Seats QuoteBillingItemCouponObject: type: object required: - id - localId - type - payload properties: id: type: string format: uuid description: >- Unique identifier of the coupon in Lago, pinned when the entry was added to the quote. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 localId: type: string description: >- Identifier of the entry within the quote version, assigned by the Lago user interface. It allows the quote document to reference the entry. example: b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b type: type: string description: The kind of billing item. enum: - coupon example: coupon payload: type: object description: >- A snapshot of the coupon as it was added to the quote. `code` and `type` are required to approve the version. properties: code: type: string description: Unique code identifying the coupon. example: welcome_offer type: type: string description: Whether the coupon deducts a fixed amount or a percentage. enum: - fixed_amount - percentage example: fixed_amount amountCents: type: - integer - 'null' description: >- The amount deducted by the coupon, in cents. Only for a `fixed_amount` coupon. example: 10000 currency: $ref: '#/components/schemas/CurrencyOrNull' description: The currency of `amountCents`. Only for a `fixed_amount` coupon. percentageRate: type: - number - 'null' description: >- The percentage deducted by the coupon. Only for a `percentage` coupon. It must be greater than 0. example: 10.5 frequency: type: - string - 'null' description: How often the coupon is deducted. enum: - null - once - recurring - forever example: once frequencyDuration: type: - integer - 'null' description: >- The number of billing periods the coupon is deducted over. Only for a `recurring` coupon. It must be greater than 0. example: 3 overrides: type: - object - 'null' description: >- The deviations from the coupon snapshot negotiated on the quote. Only the properties set here are overridden. properties: amountCents: type: - integer - 'null' description: Overrides the amount deducted by the coupon, in cents. example: 15000 amountCurrency: $ref: '#/components/schemas/CurrencyOrNull' description: >- Overrides the currency the coupon is priced in, which is how a catalog coupon is quoted in the currency of the deal. The figure in `amountCents` is not converted, it is restated in this currency. It is set only while it differs from the catalog record, and removed once they agree. percentageRate: type: - number - 'null' description: >- Overrides the percentage deducted by the coupon. It must be greater than 0. example: 15 frequency: type: - string - 'null' description: Overrides how often the coupon is deducted. enum: - null - once - recurring - forever example: recurring frequencyDuration: type: - integer - 'null' description: >- Overrides the number of billing periods the coupon is deducted over. It must be greater than 0. example: 6 QuoteBillingItemWalletCreditObject: type: object required: - localId - type - payload properties: localId: type: string description: >- Identifier of the entry within the quote version, assigned by the Lago user interface. It allows the quote document to reference the entry. example: b5c1e2a4-4e1e-4a7f-9f0e-9c1a0c7e1f2b type: type: string description: The kind of billing item. enum: - wallet_credit example: wallet_credit payload: type: object description: >- The prepaid credit wallet to create for the customer. Unlike the other billing items, a wallet credit is not built from an existing record, so it carries no `id` and no `overrides`. `paidCredits`, `grantedCredits` and `rateAmount` are required to approve the version. properties: paidCredits: type: - string - 'null' description: The number of credits the customer pays for. example: '100.0' grantedCredits: type: - string - 'null' description: The number of credits granted for free. example: '20.0' rateAmount: type: - string - 'null' description: The value of one credit, in the currency of the wallet. example: '1.0' currency: $ref: '#/components/schemas/CurrencyOrNull' description: The currency of the wallet. expirationAt: type: - string - 'null' format: date-time description: The date and time in UTC (ISO 8601) when the credits expire. example: '2027-01-01T00:00:00Z' appliesTo: type: - object - 'null' description: The limitations restricting what the credits can be spent on. properties: feeTypes: type: - array - 'null' description: The fee types the credits can be spent on. items: type: string enum: - charge - add_on - subscription - credit - commitment - fixed_charge - product example: - charge billableMetricCodes: type: - array - 'null' description: >- The codes of the billable metrics the credits can be spent on. items: type: string example: - api_calls recurringTransactionRules: type: - array - 'null' description: >- The rule automatically topping the wallet up. At most one rule is allowed, and its `trigger` is required, to approve the version. items: type: object properties: trigger: type: - string - 'null' description: What triggers the top-up. enum: - null - interval - threshold example: interval interval: type: - string - 'null' description: >- How often the wallet is topped up. Only for an `interval` trigger. enum: - null - weekly - monthly - quarterly - semiannual - yearly example: monthly thresholdCredits: type: - string - 'null' description: >- The credit balance below which the wallet is topped up. Only for a `threshold` trigger. example: '10.0' method: type: - string - 'null' description: >- Whether the top-up grants a fixed number of credits, or brings the balance up to a target. enum: - null - fixed - target example: fixed targetOngoingBalance: type: - string - 'null' description: >- The balance the top-up brings the wallet up to. Only for a `target` method. example: '100.0' grantsTargetTopUp: type: - boolean - 'null' description: >- Whether the granted credits count towards the target balance. example: false paidCredits: type: - string - 'null' description: >- The number of credits the customer pays for on every top-up. example: '100.0' grantedCredits: type: - string - 'null' description: The number of credits granted for free on every top-up. example: '20.0' startedAt: type: - string - 'null' format: date-time description: >- The date and time in UTC (ISO 8601) when the rule starts applying. example: '2026-01-01T00:00:00Z' expirationAt: type: - string - 'null' format: date-time description: >- The date and time in UTC (ISO 8601) when the rule stops applying. example: '2027-01-01T00:00:00Z' transactionName: type: - string - 'null' description: >- The name given to the wallet transactions created by the rule. example: Monthly top-up invoiceRequiresSuccessfulPayment: type: - boolean - 'null' description: >- Whether the credits are granted only once the top-up invoice is paid. example: false responses: Unauthorized: description: Unauthorized error content: application/json: schema: $ref: '#/components/schemas/ApiErrorUnauthorized' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorForbidden' NotFound: description: Not Found error content: application/json: schema: $ref: '#/components/schemas/ApiErrorNotFound' securitySchemes: bearerAuth: type: http scheme: bearer ````