--- title: "A quote has been voided" method: POST path: "quote_voided" --- # A quote has been voided `POST quote_voided` (webhook) A version of a quote has been voided. It is emitted whichever way the version was voided, so read `version.void_reason` to tell them apart: `manual` for an explicit void, `superseded` when the version was cloned into a new draft, `cascade_of_expired` or `cascade_of_voided` when the order form generated from it expired or was voided. This is a premium feature. ## Headers - `X-Lago-Signature` string, required - `X-Lago-Signature-Algorithm` 'jwt' | 'hmac', required - `X-Lago-Unique-Key` string, uuid, required ## Payload - object - `webhook_type` 'quote.voided', required - `object_type` 'quote', required - `organization_id` string, uuid, required: Unique identifier of the organization, created by Lago. - `quote` QuoteWithVersionObject, required - `lago_id` string, uuid, required: Unique identifier of the quote, created by Lago. - `number` string, required: The unique number assigned to the quote by Lago. - `order_type` 'subscription_creation' | 'subscription_amendment' | 'one_off', required: The commercial motion the quote describes. It can be any of the following values: - `subscription_creation`: the quote creates one or more subscriptions. - `subscription_amendment`: the quote amends an existing subscription, named by the quote's own `lago_subscription_id`. - `one_off`: the quote bills add-ons once, without any subscription. - `lago_customer_id` string, uuid, required: Unique identifier of the customer the quote is addressed to, created by Lago. - `lago_subscription_id` string, uuid, nullable, required: Unique identifier of the subscription the quote amends, created by Lago. It is set only when the `order_type` is `subscription_amendment`. - `lago_organization_id` string, uuid, required: Unique identifier of the organization, created by Lago. - `created_at` string, date-time, required: The date and time in UTC (ISO 8601) when the quote was created. - `updated_at` string, date-time, required: The date and time in UTC (ISO 8601) when the quote was last updated. - `version` QuoteVersionObject, required - `lago_id` string, uuid, required: Unique identifier of the quote version, created by Lago. - `lago_quote_id` string, uuid, required: Unique identifier of the quote the version belongs to, created by Lago. - `lago_organization_id` string, uuid, required: Unique identifier of the organization, created by Lago. - `version` integer, required: The number of the version within the quote. It starts at 1 and increases by 1 for every new version created by cloning. - `status` 'draft' | 'approved' | 'voided', required: 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`. - `currency` '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' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW', nullable, required - `billing_entity_code` string, nullable, required: 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. - `void_reason` 'null' | 'manual' | 'superseded' | 'cascade_of_expired' | 'cascade_of_voided', nullable, required: 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. - `approved_at` string, date-time, nullable, required: The date and time in UTC (ISO 8601) when the version was approved. It is `null` unless the `status` is `approved`. - `voided_at` string, date-time, nullable, required: The date and time in UTC (ISO 8601) when the version was voided. It is `null` unless the `status` is `voided`. - `created_at` string, date-time, required: The date and time in UTC (ISO 8601) when the version was created. - `updated_at` string, date-time, required: The date and time in UTC (ISO 8601) when the version was last updated. ## Acknowledgement `200` Return a 200 status to indicate that the data was received successfully --- [API](https://skmtc.dev/getlago/apis/lago-api-documentation.md) - [All operations](https://skmtc.dev/getlago/apis/lago-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/getlago/apis/lago-api-documentation/revisions/b216574b9612?raw)