@vrplatform/hyperline-client 1.0.9 → 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/build/main/_types.generated.d.ts +202 -80
  2. package/build/main/_types.generated.js.map +1 -1
  3. package/build/main/client.d.ts +7 -15
  4. package/build/main/client.js +2 -2
  5. package/build/main/client.js.map +1 -1
  6. package/build/main/const.d.ts +4 -0
  7. package/build/main/const.js +4 -0
  8. package/build/main/const.js.map +1 -1
  9. package/build/module/_types.generated.d.ts +202 -80
  10. package/build/module/_types.generated.js.map +1 -1
  11. package/build/module/client.d.ts +7 -15
  12. package/build/module/client.js +2 -2
  13. package/build/module/client.js.map +1 -1
  14. package/build/module/const.d.ts +4 -0
  15. package/build/module/const.js +4 -0
  16. package/build/module/const.js.map +1 -1
  17. package/package.json +1 -1
  18. package/src/_types.generated.ts +202 -80
  19. package/src/client.ts +4 -2
  20. package/src/const.ts +5 -0
package/build/module/_types.generated.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_types.generated.js","sourceRoot":"src/","sources":["_types.generated.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file was auto-generated by openapi-typescript.\n * Do not make direct changes to the file.\n */\n\nexport interface paths {\n \"/v1/invoices\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoices\n * @description Retrieve all existing invoices. By default, invoices with status `open` are not included.\n */\n get: operations[\"getInvoices\"];\n put?: never;\n /**\n * Create invoice\n * @description Create a new invoice.\n */\n post: operations[\"createInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/batch\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create invoices\n * @description Create new invoices in batch (max 50 items).\n */\n post: operations[\"createInvoices\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/validate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Validate draft invoice\n * @description Send a draft invoice for payment, set the status to `to_pay` and its number. This is not reversible.\n */\n post: operations[\"validateInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/charge\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Charge invoice\n * @description Manually trigger the payment of the invoice.\n */\n post: operations[\"chargeInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/void\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Void invoice\n * @description Void an invoice in a `to_pay` status. This action generates a corresponding credit note.\n */\n post: operations[\"voidInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoice\n * @description Retrieve the details of an existing invoice.\n */\n get: operations[\"getInvoice\"];\n put?: never;\n post?: never;\n /**\n * Delete invoice\n * @description Delete an invoice in `draft` status or imported from an external source. For other statuses, the `POST /v1/invoices/{id}/void` endpoint must be used.\n */\n delete: operations[\"deleteInvoice\"];\n options?: never;\n head?: never;\n /**\n * Update invoice\n * @description Update an invoice in draft or grace_period status.\n */\n patch: operations[\"updateInvoice\"];\n trace?: never;\n };\n \"/v1/invoices/{id}/upload\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Upload PDF to invoice\n * @description Upload a PDF file to an existing invoice.\n */\n post: operations[\"uploadPdfToInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/download\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Download invoice\n * @description Download the PDF of an existing invoice.\n */\n get: operations[\"downloadInvoice\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/transactions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create transaction\n * @description Create a transaction linked to an existing invoice. This may update the invoice status to paid/partially paid.\n */\n post: operations[\"createInvoiceTransaction\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/transactions/{transactionId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n post?: never;\n /**\n * Delete transaction\n * @description Delete a transaction linked to an existing invoice. Only applies to scheduled transaction.\n */\n delete: operations[\"deleteInvoiceTransaction\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/analytics\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get analytics\n * @description Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).\n */\n get: operations[\"getAnalytics\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/companies\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get companies\n * @description Retrieve all companies that the authentication token has access to.\n */\n get: operations[\"getCompanies\"];\n put?: never;\n /**\n * Create company\n * @description Create a new company to which the authentication token will have access to.\n */\n post: operations[\"createCompany\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/coupons\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get coupons\n * @description Retrieve all existing coupons.\n */\n get: operations[\"getCoupons\"];\n put?: never;\n /**\n * Create coupon\n * @description Create a new coupon.\n */\n post: operations[\"createCoupon\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/coupons/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get coupon\n * @description Retrieve the details of an existing coupon.\n */\n get: operations[\"getCoupon\"];\n /**\n * Update coupon\n * @description Update the details of an existing coupon.\n */\n put: operations[\"updateCoupon\"];\n post?: never;\n /**\n * Delete coupon\n * @description Delete an existing coupon.\n */\n delete: operations[\"deleteCoupon\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/custom-properties\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get custom properties\n * @description Retrieve all custom properties previously created.\n */\n get: operations[\"getCustomProperties\"];\n put?: never;\n /**\n * Create custom property\n * @description Create a new custom property.\n */\n post: operations[\"createCustomProperty\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/custom-properties/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Update custom property\n * @description Update an existing custom property.\n */\n put: operations[\"updateCustomProperty\"];\n post?: never;\n /**\n * Delete custom property\n * @description Delete an existing custom property.\n */\n delete: operations[\"deleteCustomProperty\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get credit products\n * @description List all credits products attached to a customer.\n */\n get: operations[\"listCustomerCredits\"];\n put?: never;\n /**\n * Create credit product\n * @description Create a credit entity for a given product with an optional balance for a customer.\n */\n post: operations[\"createCreditForProduct\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get credit product\n * @description Retrieve the details of an existing credit product for a customer.\n */\n get: operations[\"getOneCreditForCustomer\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/transactions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get credit transactions\n * @description Retrieve all credit transactions associated with a credit product for a specific customer.\n */\n get: operations[\"listCreditTransactionsForCustomer\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/purchase\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Purchase credits\n * @description Purchase a number of credits. This action will generate an invoice and charge the customer. Can take a few seconds to complete.\n */\n post: operations[\"purchaseCredits\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/topup\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Topup credits\n * @description Topup a number of free credits. This action will not charge the customer.\n */\n post: operations[\"usageCredits\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/usage\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create credits usage\n * @description Create a usage entry for a credit product. This will impact the balance of the customer by `usage_retained`.\n */\n post: operations[\"createUsageEntry\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customers\n * @description Retrieve all existing customers.\n */\n get: operations[\"getCustomers\"];\n put?: never;\n /**\n * Create customer\n * @description Create a new customer.\n */\n post: operations[\"createCustomer\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customer\n * @description Retrieve the details of an existing customer.\n */\n get: operations[\"getCustomer\"];\n /**\n * Update customer\n * @description Update the details of an existing customer.\n */\n put: operations[\"updateCustomer\"];\n post?: never;\n /**\n * Delete customer\n * @description Delete an existing customer. The customer must be archived prior to the deletion.\n */\n delete: operations[\"deleteCustomer\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/portal\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customer portal\n * @description Retrieve the URL of the customer portal.\n */\n get: operations[\"getCustomerPortalUrl\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/archive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Archive customer\n * @description Archive an existing customer.\n */\n put: operations[\"archiveCustomer\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/unarchive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Unarchive customer\n * @description Unarchive an archived customer.\n */\n put: operations[\"unarchiveCustomer\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/providers-bulk-update\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Bulk update providers/customers mapping\n * @description Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.\n */\n post: operations[\"bulkUpdateCustomersProviders\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/taxes/rates\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customer tax rates\n * @description Retrieve the eligible tax rates for a customer.\n */\n get: operations[\"getCustomerTaxRates\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/organisations/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get organisation\n * @description Retrieve the details of an existing organisation.\n */\n get: operations[\"getOrganisation\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n /**\n * Patch organisation\n * @description Update the details of an existing organisation.\n */\n patch: operations[\"patchOrganisation\"];\n trace?: never;\n };\n \"/v1/customers/{id}/payment-methods\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get payment methods\n * @description List all payment methods attached to a customer.\n */\n get: operations[\"listCustomerPaymentMethods\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/payment-methods/{paymentMethodId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get payment method\n * @description Retrieve the details of an existing customer payment method.\n */\n get: operations[\"getCustomerPaymentMethod\"];\n put?: never;\n post?: never;\n /**\n * Delete payment method\n * @description Delete an existing customer payment method.\n */\n delete: operations[\"deleteCustomerPaymentMethod\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/integrations/components/token\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create component token\n * @description Create a new token for embedded components.\n */\n post: operations[\"createComponentToken\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoicing-entities\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoicing entities\n * @description Retrieve all invoicing entities for your current client.\n */\n get: operations[\"getInvoicingEntities\"];\n put?: never;\n /**\n * Create invoicing entity\n * @description Create a new invoicing entity to send invoices from.\n */\n post: operations[\"createInvoicingEntity\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoicing-entities/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoicing entity\n * @description Retrieve a specific invoicing entity.\n */\n get: operations[\"getInvoicingEntity\"];\n /**\n * Update invoicing entity\n * @description Update an existing invoicing entity.\n */\n put: operations[\"updateInvoicingEntity\"];\n post?: never;\n /**\n * Delete invoicing entity\n * @description Soft deletes an invoicing entity. This action won't delete the associated invoices.\n */\n delete: operations[\"deleteInvoicingEntity\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/userinfo\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get user info\n * @description Returns the user information associated with an access token.\n */\n get: operations[\"getUserInfo\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/authorize\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Authorize\n * @description Redirects the user to the Hyperline's login page, and grants authorization to your integration.\n */\n get: operations[\"authorize\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/tokens\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Generate tokens\n * @description Exchange an auth code received at the authorize endpoint for an actual access token, or refresh it.\n */\n post: operations[\"generateTokens\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/revoke\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Revoke token\n * @description Revoke a refresh token. Once revoked the token can not be used anymore.\n */\n post: operations[\"revokeToken\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/payments\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create payment\n * @description Initiate a new payment (limited to one-time): generate an invoice and charge it directly or with a checkout session\n */\n post: operations[\"createPayment\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get products\n * @description Retrieve all existing products.\n */\n get: operations[\"getProducts\"];\n put?: never;\n /**\n * Create product\n * @description Create a new product.\n */\n post: operations[\"createProduct\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get product\n * @description Retrieve the details of an existing product.\n */\n get: operations[\"getProduct\"];\n /**\n * Update product\n * @description Update the details of an existing product.\n */\n put: operations[\"updateProduct\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products/{id}/archive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Archive product\n * @description Archive an existing product.\n */\n put: operations[\"archiveProduct\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products/{id}/unarchive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Unarchive product\n * @description Unarchive an archived product.\n */\n put: operations[\"unarchiveProduct\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/price-configurations/{id}/prices\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Update prices\n * @description Update prices of an existing price configuration.\n */\n put: operations[\"updatePrices\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/plans\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get plans\n * @description Retrieve all existing plans.\n */\n get: operations[\"getPlans\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/plans/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get plan\n * @description Retrieve the details of an existing plan.\n */\n get: operations[\"getPlan\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get quotes\n * @description Retrieve all existing quotes.\n */\n get: operations[\"getQuotes\"];\n put?: never;\n /**\n * Create quote\n * @description Create a new quote.\n */\n post: operations[\"createQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get quote\n * @description Retrieve the details of an existing quote.\n */\n get: operations[\"getQuote\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/download\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Download quote\n * @description Download an existing quote.\n */\n get: operations[\"downloadQuote\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/send\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Send quote\n * @description Send an existing quote by email for signature.\n */\n post: operations[\"sendQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/sign\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Sign quote\n * @description Manually mark the quote as signed externally. Built-in Hyperline signature flow won't be used.\n */\n post: operations[\"signQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/void\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Void quote\n * @description Void an existing quote.\n */\n post: operations[\"voidQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{quoteId}/files/{id}/download\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Download quote file\n * @description Download a file (attachment or manually signed file) attached to an existing quote.\n */\n get: operations[\"downloadQuoteFile\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/refresh\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Refresh subscriptions\n * @description Triggers refresh of subscriptions usage data and related open invoices. This action is used when the automatic billing update upon ingestion option is disabled for the account.\n */\n post: operations[\"refreshSubscriptions\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/update\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create subscription update\n * @description Create an update to apply on an existing subscription.\n */\n post: operations[\"createSubscriptionUpdate\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/update-many\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create subscription updates\n * @description Create multiple updates to apply at once to an existing subscription.\n */\n post: operations[\"createSubscriptionUpdates\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/cancel\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Cancel subscription\n * @description Cancel an existing subscription.\n */\n post: operations[\"cancelSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/reinstate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Reinstate subscription\n * @description Reinstate an existing subscription scheduled for cancellation.\n */\n post: operations[\"reinstateSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/pause\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Pause subscription\n * @description Pause a subscription.\n */\n post: operations[\"pauseSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/activate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Activate subscription\n * @description Manually start a subscription for the first time.\n */\n post: operations[\"activateSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/reactivate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Reactivate subscription\n * @description Reactivate a paused subscription.\n */\n post: operations[\"reactivateSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscriptions\n * @description Retrieve all existing subscriptions. By default, draft, voided, and cancelled subscriptions are not included.\n */\n get: operations[\"getSubscriptions\"];\n put?: never;\n /**\n * Create subscription\n * @description Create a new subscription from a plan or manually with products.\n */\n post: operations[\"createSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscription\n * @description Retrieve the details of an existing subscription.\n */\n get: operations[\"getSubscription\"];\n /**\n * Update subscription\n * @description Update parameters for a subscription.\n */\n put: operations[\"updateSubscription\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/phases\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscription phases\n * @description Retrieve the details of the phases for an existing subscription.\n */\n get: operations[\"getSubscriptionPhases\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/phases/{phaseId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscription phase\n * @description Retrieve the details of a phase for an existing subscription.\n */\n get: operations[\"getSubscriptionPhase\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/refresh-seat-products\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Refresh seat products\n * @description Triggers 'count' updates on connected seat products within the subscription. This action will use the dataloader query to retrieve and update the number of units for each seat product.\n */\n post: operations[\"refreshSeatProductsOnSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/next-phase\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Transition subscription to next phase\n * @description Update a subscription and transition it to the next available phase.\n */\n post: operations[\"transitionSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/taxes/rates\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get tax rates\n * @description Retrieve all existing custom tax rates.\n */\n get: operations[\"getTaxRates\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/taxes/rates/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get tax rate\n * @description Retrieve the details of an existing custom tax rate.\n */\n get: operations[\"getTaxRate\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/apps\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get apps\n * @description Retrieve all existing third-party apps.\n */\n get: operations[\"getApps\"];\n put?: never;\n /**\n * Create app\n * @description Create a new third-party app.\n */\n post: operations[\"createApp\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/apps/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Update app\n * @description Update an existing third-party app.\n */\n put: operations[\"updateApp\"];\n post?: never;\n /**\n * Delete app\n * @description Delete an existing third-party app.\n */\n delete: operations[\"deleteApp\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/settings\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallet settings\n * @description Retrieve the global settings of the wallets.\n */\n get: operations[\"getWalletSettings\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n /**\n * Update wallet settings\n * @description Update the global settings of the wallets.\n */\n patch: operations[\"updateWalletSettings\"];\n trace?: never;\n };\n \"/v1/wallets\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallets\n * @description Retrieve all existing wallets.\n */\n get: operations[\"getWallets\"];\n put?: never;\n /**\n * Create wallet\n * @description Create a new wallet.\n */\n post: operations[\"createWallet\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallet\n * @description Retrieve the details of an existing wallet.\n */\n get: operations[\"getWallet\"];\n /**\n * Update wallet\n * @description Update the details of an existing wallet.\n */\n put: operations[\"updateWallet\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/{id}/load\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Load wallet\n * @description Load credits on an existing wallet. The related customer must have an active payment method.\n */\n post: operations[\"loadWallet\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/{id}/transactions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallet transactions\n * @description Retrieve all transactions of an existing wallet.\n */\n get: operations[\"getWalletTransactions\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/webhooks/endpoints\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get webhook endpoints\n * @description Retrieve all webhook endpoints.\n */\n get: operations[\"getWebhookEndpoints\"];\n put?: never;\n /**\n * Create webhook endpoint\n * @description Create a new webhook endpoint.\n */\n post: operations[\"createWebhookEndpoint\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/webhooks/endpoints/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get webhook endpoint\n * @description Retrieve an existing webhook endpoint.\n */\n get: operations[\"getWebhookEndpoint\"];\n /**\n * Update webhook endpoint\n * @description Update an existing webhook endpoint.\n */\n put: operations[\"updateWebhookEndpoint\"];\n post?: never;\n /**\n * Delete webhook endpoint\n * @description Delete an existing webhook endpoint.\n */\n delete: operations[\"deleteWebhookEndpoint\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/webhooks/messages\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get webhook messages\n * @description\n * Retrieve all webhook messages sent.\n *\n * Please note that, by default, this endpoint is limited to retrieving 90 days' worth of data relative to now. Messages that date back more than 90 days are still accessible, but their payloads are expunged.\n * If an iterator is provided, the endpoint retrieves data spanning 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the before or after parameter as appropriate.\n *\n */\n get: operations[\"getWebhookMessages\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n}\nexport type webhooks = Record<string, never>;\nexport interface components {\n schemas: {\n /**\n * @description Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).\n * @example EUR\n * @enum {string}\n */\n Currency: \"EUR\" | \"AED\" | \"AFN\" | \"XCD\" | \"ALL\" | \"AMD\" | \"AOA\" | \"ARS\" | \"USD\" | \"AUD\" | \"AWG\" | \"AZN\" | \"BAM\" | \"BBD\" | \"BDT\" | \"XOF\" | \"BGN\" | \"BHD\" | \"BIF\" | \"BMD\" | \"BND\" | \"BOB\" | \"BRL\" | \"BSD\" | \"BTN\" | \"NOK\" | \"BWP\" | \"BYR\" | \"BZD\" | \"CAD\" | \"CDF\" | \"XAF\" | \"CHF\" | \"NZD\" | \"CLP\" | \"CNY\" | \"COP\" | \"CRC\" | \"CUP\" | \"CVE\" | \"ANG\" | \"CZK\" | \"DJF\" | \"DKK\" | \"DOP\" | \"DZD\" | \"EGP\" | \"MAD\" | \"ERN\" | \"ETB\" | \"FJD\" | \"FKP\" | \"GBP\" | \"GEL\" | \"GHS\" | \"GIP\" | \"GMD\" | \"GNF\" | \"GTQ\" | \"GYD\" | \"HKD\" | \"HNL\" | \"HRK\" | \"HTG\" | \"HUF\" | \"IDR\" | \"ILS\" | \"INR\" | \"IQD\" | \"IRR\" | \"ISK\" | \"JMD\" | \"JOD\" | \"JPY\" | \"KES\" | \"KGS\" | \"KHR\" | \"KMF\" | \"KPW\" | \"KRW\" | \"KWD\" | \"KYD\" | \"KZT\" | \"LAK\" | \"LBP\" | \"LKR\" | \"LRD\" | \"LSL\" | \"LYD\" | \"MDL\" | \"MGA\" | \"MKD\" | \"MMK\" | \"MNT\" | \"MOP\" | \"MRO\" | \"MUR\" | \"MVR\" | \"MWK\" | \"MXN\" | \"MYR\" | \"MZN\" | \"NAD\" | \"XPF\" | \"NGN\" | \"NIO\" | \"NPR\" | \"OMR\" | \"PAB\" | \"PEN\" | \"PGK\" | \"PHP\" | \"PKR\" | \"PLN\" | \"PYG\" | \"QAR\" | \"RON\" | \"RSD\" | \"RUB\" | \"RWF\" | \"SAR\" | \"SBD\" | \"SCR\" | \"SDG\" | \"SEK\" | \"SGD\" | \"SHP\" | \"SLL\" | \"SOS\" | \"SRD\" | \"SSP\" | \"STD\" | \"SYP\" | \"SZL\" | \"THB\" | \"TJS\" | \"TMT\" | \"TND\" | \"TOP\" | \"TRY\" | \"TTD\" | \"TWD\" | \"TZS\" | \"UAH\" | \"UGX\" | \"UYU\" | \"UZS\" | \"VEF\" | \"VND\" | \"VUV\" | \"WST\" | \"YER\" | \"ZAR\" | \"ZMW\" | \"ZWL\";\n /**\n * @description Sum of the amount and taxes amount of all products on the invoice. Expressed in the currency's smallest unit.\n * @example 24000\n */\n Amount: number;\n /**\n * Format: date-time\n * @description Date of the conversion of the amount.\n * @example 2024-10-13T02:00:00.000Z\n */\n DateTime: string | null;\n /**\n * @description Two-letter country code in ISO format. See [ISO 3166 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\n * @example FR\n * @enum {string|null}\n */\n Country: \"AD\" | \"AE\" | \"AF\" | \"AG\" | \"AI\" | \"AL\" | \"AM\" | \"AO\" | \"AQ\" | \"AR\" | \"AS\" | \"AT\" | \"AU\" | \"AW\" | \"AX\" | \"AZ\" | \"BA\" | \"BB\" | \"BD\" | \"BE\" | \"BF\" | \"BG\" | \"BH\" | \"BI\" | \"BJ\" | \"BL\" | \"BM\" | \"BN\" | \"BO\" | \"BQ\" | \"BR\" | \"BS\" | \"BT\" | \"BV\" | \"BW\" | \"BY\" | \"BZ\" | \"CA\" | \"CC\" | \"CD\" | \"CF\" | \"CG\" | \"CH\" | \"CI\" | \"CK\" | \"CL\" | \"CM\" | \"CN\" | \"CO\" | \"CR\" | \"CU\" | \"CV\" | \"CW\" | \"CX\" | \"CY\" | \"CZ\" | \"DE\" | \"DJ\" | \"DK\" | \"DM\" | \"DO\" | \"DZ\" | \"EC\" | \"EE\" | \"EG\" | \"EH\" | \"ER\" | \"ES\" | \"ET\" | \"FI\" | \"FJ\" | \"FK\" | \"FM\" | \"FO\" | \"FR\" | \"GA\" | \"GB\" | \"GD\" | \"GE\" | \"GF\" | \"GG\" | \"GH\" | \"GI\" | \"GL\" | \"GM\" | \"GN\" | \"GP\" | \"GQ\" | \"GR\" | \"GS\" | \"GT\" | \"GU\" | \"GW\" | \"GY\" | \"HK\" | \"HM\" | \"HN\" | \"HR\" | \"HT\" | \"HU\" | \"IC\" | \"ID\" | \"IE\" | \"IL\" | \"IM\" | \"IN\" | \"IO\" | \"IQ\" | \"IR\" | \"IS\" | \"IT\" | \"JE\" | \"JM\" | \"JO\" | \"JP\" | \"KE\" | \"KG\" | \"KH\" | \"KI\" | \"KM\" | \"KN\" | \"KP\" | \"KR\" | \"KW\" | \"KY\" | \"KZ\" | \"LA\" | \"LB\" | \"LC\" | \"LI\" | \"LK\" | \"LR\" | \"LS\" | \"LT\" | \"LU\" | \"LV\" | \"LY\" | \"MA\" | \"MC\" | \"MD\" | \"ME\" | \"MF\" | \"MG\" | \"MH\" | \"MK\" | \"ML\" | \"MM\" | \"MN\" | \"MO\" | \"MP\" | \"MQ\" | \"MR\" | \"MS\" | \"MT\" | \"MU\" | \"MV\" | \"MW\" | \"MX\" | \"MY\" | \"MZ\" | \"NA\" | \"NC\" | \"NE\" | \"NF\" | \"NG\" | \"NI\" | \"NL\" | \"NO\" | \"NP\" | \"NR\" | \"NU\" | \"NZ\" | \"OM\" | \"PA\" | \"PE\" | \"PF\" | \"PG\" | \"PH\" | \"PK\" | \"PL\" | \"PM\" | \"PN\" | \"PR\" | \"PS\" | \"PT\" | \"PT-20\" | \"PT-30\" | \"PW\" | \"PY\" | \"QA\" | \"RE\" | \"RO\" | \"RS\" | \"RU\" | \"RW\" | \"SA\" | \"SB\" | \"SC\" | \"SD\" | \"SE\" | \"SG\" | \"SH\" | \"SI\" | \"SJ\" | \"SK\" | \"SL\" | \"SM\" | \"SN\" | \"SO\" | \"SR\" | \"SS\" | \"ST\" | \"SV\" | \"SX\" | \"SY\" | \"SZ\" | \"TC\" | \"TD\" | \"TF\" | \"TG\" | \"TH\" | \"TJ\" | \"TK\" | \"TL\" | \"TM\" | \"TN\" | \"TO\" | \"TR\" | \"TT\" | \"TV\" | \"TW\" | \"TZ\" | \"UA\" | \"UG\" | \"UM\" | \"US\" | \"UY\" | \"UZ\" | \"VA\" | \"VC\" | \"VE\" | \"VG\" | \"VI\" | \"VN\" | \"VU\" | \"WF\" | \"WS\" | \"XK\" | \"YE\" | \"YT\" | \"ZA\" | \"ZM\" | \"ZW\" | null;\n /** @description Customer billing address. */\n Address: {\n /**\n * @description Address name.\n * @example Acme\n */\n name?: string | null;\n /**\n * @description Address first line.\n * @example 5 rue de Paradis\n */\n line1?: string | null;\n /** @description Address second line (optional). */\n line2?: string | null;\n /**\n * @description Address city.\n * @example Paris\n */\n city?: string | null;\n /**\n * @description Address ZIP code.\n * @example 75010\n */\n zip?: string | null;\n /** @description Address state (only for US country). */\n state?: string | null;\n country?: components[\"schemas\"][\"Country\"];\n } | null;\n InvoiceLineItem: {\n /**\n * @description Invoice line item ID.\n * @example ili_0FACNpeoEFkGu3\n */\n id: string;\n /**\n * @description Name of the line item, corresponding to the related product.\n * @example Platform access\n */\n name: string;\n /**\n * @description Product ID related to the invoice line item.\n * @example itm_KbLcWt2qm5p1S2\n */\n product_id: string | null;\n /**\n * @description Product type related to the invoice line item.\n * @example flat_fee\n * @enum {string|null}\n */\n product_type: \"flat_fee\" | \"seat\" | \"dynamic\" | \"credit\" | null;\n /**\n * @description Count of units of the product related to the invoice line item.\n * @example 1\n */\n units_count: number;\n unit_amount: components[\"schemas\"][\"Amount\"] & unknown;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n amount_excluding_tax: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Tax rate of the invoice line item.\n * @example 20\n */\n tax_rate: number;\n /** @description Custom tax rate ID applied to the invoice line item. */\n tax_rate_id: string | null;\n tax_amount: components[\"schemas\"][\"Amount\"] & unknown;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Percentage applied to compute the discounted part of the invoice line amount. Only if coupons applied are percentage based. */\n discount_percent: number | null;\n period_starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n Invoice: {\n /**\n * @description Invoice ID.\n * @example inv_1eTaiytfA0i2Va\n */\n id: string;\n /**\n * @description Invoice number. Generated by Hyperline using the sequential numbering and format defined in your settings.\n * @example INV-35\n */\n number: string;\n /**\n * @description Type of the invoice.\n *\n * - `invoice`: Legal invoice to be paid by your customer.\n * - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.\n * - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.\n *\n * @example invoice\n * @enum {string}\n */\n type: \"invoice\" | \"credit_note\" | \"document\" | \"child_invoice_ref\" | \"child_creditnote_ref\";\n /** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */\n document_name: string | null;\n /**\n * @description Current invoice status.\n *\n * - `draft`: Invoice is in draft mode (not finalized yet).\n * - `open`: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).\n * - `grace_period`: Invoice is in a review period after being issued for the billing period and before becoming due for payment.\n * - `to_pay`: Invoice is awaiting payment.\n * - `partially_paid`: Invoice is partially paid.\n * - `paid`: Invoice is fully paid.\n * - `voided`: Invoice has been voided and is no longer valid.\n * - `closed`: Invoice was not issued and has been discarded.\n * - `error`: Invoice failed to be paid.\n * - `archived`: A previous version of an invoice.\n * - `charged_on_parent`: Invoice is charged on the parent customer.\n * - `pending_parent_concat`: Invoice is pending invoices concatenation on the parent customer to be grouped.\n *\n * @example paid\n * @enum {string}\n */\n status: \"draft\" | \"open\" | \"to_pay\" | \"grace_period\" | \"partially_paid\" | \"paid\" | \"voided\" | \"closed\" | \"error\" | \"missing_info\" | \"archived\" | \"charged_on_parent\" | \"pending_parent_concat\";\n /**\n * @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.\n * @example V0KAHOU6J3\n */\n reference: string | null;\n /**\n * @description Reference to the purchase order linked to the invoice.\n * @example PO-12345\n */\n purchase_order: string | null;\n /** @description ID of the original invoice this credit note is linked to (only used for credit note). */\n original_invoice_id: string | null;\n /** @description Number of the original invoice this credit note is linked to (only used for credit note). */\n original_invoice_number: string | null;\n currency: components[\"schemas\"][\"Currency\"];\n total_amount: components[\"schemas\"][\"Amount\"];\n amount_due: components[\"schemas\"][\"Amount\"] & unknown;\n amount_paid: components[\"schemas\"][\"Amount\"] & unknown;\n amount_fixed: components[\"schemas\"][\"Amount\"] & unknown;\n amount_excluding_tax: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Tax amount of the invoice. Expressed in the currency's smallest unit.\n * @example 20\n */\n tax_rate: number;\n tax_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description\n * - `standard`: Default behavior, tax is automatically computed and applied.\n * - `exempt`: No tax rate applied because the customer country doesn't require it.\n * - `reverse_charge`: No tax rate applied because the customer is eligible to EU reverse charge.\n * - `manual`: Tax rate has been manually specified when creating the invoice.\n * - `not_eligible`: You've disabled tax collection in this country.\n *\n * @example standard\n * @enum {string}\n */\n tax_scheme: \"exempt\" | \"standard\" | \"reverse_charge\" | \"manual\" | \"not_eligible\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Conversion rate used between the invoice currency and your accounting currency.\n * @example 1\n */\n conversion_rate: number | null;\n converted_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n converted_at: components[\"schemas\"][\"DateTime\"];\n /**\n * @description ID of the payment method used to pay the invoice.\n * @example pm_1ryTrMj4TTAT1N\n */\n payment_method_id: string | null;\n /**\n * @description Custom note added to the invoice.\n * @example Thank you for your purchase!\n */\n custom_note: string | null;\n customer: {\n /**\n * @description Customer ID.\n * @example cus_Typ0px2W0aiEtl\n */\n id: string;\n /**\n * @description Customer name.\n * @example Acme\n */\n name: string;\n /**\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n email: string | null;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id: string | null;\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number: string | null;\n address: components[\"schemas\"][\"Address\"];\n };\n seller: {\n /**\n * @description ID of the invoicing entity attached to the invoice.\n * @example ive_47484fjdhy5\n */\n id: string;\n /**\n * @description Name of the invoicing entity\n * @example Name of the invoicing entity\n */\n name: string;\n /**\n * @description Tax identifier / VAT number of the invoicing entity\n * @example FR5878986578\n */\n tax_id: string | null;\n address: components[\"schemas\"][\"Address\"] & unknown;\n };\n /**\n * @description ID of the subscription related to the invoice.\n * @example sub_amiaWZ3lzDIWaoT\n */\n subscription_id: string | null;\n period_starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n emitted_at: components[\"schemas\"][\"DateTime\"] & string;\n due_at: components[\"schemas\"][\"DateTime\"] & string;\n refunded_at: components[\"schemas\"][\"DateTime\"] & unknown;\n grace_period_ended_at: components[\"schemas\"][\"DateTime\"] & unknown;\n settled_at: components[\"schemas\"][\"DateTime\"] & unknown;\n updated_at: components[\"schemas\"][\"DateTime\"] & unknown;\n line_items: components[\"schemas\"][\"InvoiceLineItem\"][];\n };\n PaginatedInvoice: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Invoice. */\n data: components[\"schemas\"][\"Invoice\"][];\n };\n PaymentMethodCard: {\n /**\n * @description Payment method ID.\n * @example pm_1xMpj5bwRqN7LM\n */\n id: string;\n } & ({\n /**\n * @description\n * Payment method status.\n *\n * - `active`: The payment method is ready to be used.\n * - `pending`: The payment method is pending activation or being validated.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"pending\";\n } | {\n /**\n * @description\n * Payment method status.\n *\n * - `errored`: The payment method has failed and can no longer be used.\n *\n * @example errored\n * @enum {string}\n */\n status: \"errored\";\n /**\n * @description\n * Payment method error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @example expired\n * @enum {string}\n */\n error_type: \"authentication_required\" | \"authorization_error\" | \"declined\" | \"expired\" | \"fraud\" | \"invalid\" | \"not_supported\" | \"unknown\";\n }) & {\n /**\n * @description\n * Payment method type.\n *\n * - `card`: Credit or debit card\n * - `direct_debit_sepa`: SEPA Direct Debit\n * - `direct_debit_ach`: ACH Direct Debit with an US bank account\n * - `direct_debit_bacs`: Bacs Direct Debit with an UK bank account\n *\n * @example card\n * @enum {string}\n */\n type: \"card\";\n /**\n * @description Last four digits of the card.\n * @example 2718\n */\n last_4_digits: number | null;\n /**\n * @description Expiration date of the card using YYYY-MM format.\n * @example 2026-11\n */\n expiration_date: string | null;\n /** @description Brand of the card. */\n brand: string | null;\n };\n PaymentMethodDirectDebit: {\n /**\n * @description Payment method ID.\n * @example pm_1xMpj5bwRqN7LM\n */\n id: string;\n } & ({\n /**\n * @description\n * Payment method status.\n *\n * - `active`: The payment method is ready to be used.\n * - `pending`: The payment method is pending activation or being validated.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"pending\";\n } | {\n /**\n * @description\n * Payment method status.\n *\n * - `errored`: The payment method has failed and can no longer be used.\n *\n * @example errored\n * @enum {string}\n */\n status: \"errored\";\n /**\n * @description\n * Payment method error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @example expired\n * @enum {string}\n */\n error_type: \"authentication_required\" | \"authorization_error\" | \"declined\" | \"expired\" | \"fraud\" | \"invalid\" | \"not_supported\" | \"unknown\";\n }) & {\n /**\n * @description\n * Payment method type.\n *\n * - `card`: Credit or debit card\n * - `direct_debit_sepa`: SEPA Direct Debit\n * - `direct_debit_ach`: ACH Direct Debit with an US bank account\n * - `direct_debit_bacs`: Bacs Direct Debit with an UK bank account\n *\n * @example direct_debit\n * @enum {string}\n */\n type: \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\";\n /**\n * @description Last characters of the account number.\n * @example 6789\n */\n account_number_ending: string | null;\n };\n PaymentMethod: components[\"schemas\"][\"PaymentMethodCard\"] | components[\"schemas\"][\"PaymentMethodDirectDebit\"] | null;\n BankAccount: ({\n /**\n * @description Bank account ID.\n * @example bac_KJyPrMA1toAqRG\n */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description Bank name.\n * @example Fake bank\n */\n bank_name: string | null;\n } & ({\n /** @enum {string} */\n format: \"iban_bic_swift\";\n iban: string;\n bic_swift: string | null;\n } | {\n /** @enum {string} */\n format: \"sort_code_account_number\";\n sort_code: string;\n account_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_routing_number\";\n account_number: string;\n routing_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_bic_swift\";\n account_number: string;\n bic_swift: string;\n })) | null;\n InvoiceDetails: components[\"schemas\"][\"Invoice\"] & {\n transactions: ({\n /**\n * @description Transaction ID.\n * @example tra_2QdJDDUej969ev\n */\n id: string;\n /**\n * @description\n * Transaction type.\n *\n * - `subscription`: The transaction is related to a subscription payment.\n * - `one_time`: The transaction is related to a one-time payment.\n * - `refund`: The transaction is related to a refund payment.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"one_time\" | \"refund\";\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description ID of the customer linked to the transaction.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the transaction on the payment provider (Stripe, Mollie, GoCardless, ...) side.\n * @example pi_xxxxxxxxxx\n */\n provider_id: string | null;\n process_at: components[\"schemas\"][\"DateTime\"] & string;\n refunded_at: components[\"schemas\"][\"DateTime\"] & unknown;\n last_refreshed_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Fee applied by the Payment Service Provider. Only supported for Stripe. */\n provider_fee: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n exchange_rate: number | null;\n } | null;\n /** @description Chargeback details related to the transaction. */\n chargeback: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n last_chargeback_at: components[\"schemas\"][\"DateTime\"] & string;\n } | null;\n } & ({\n /** @enum {string} */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\";\n payment_method: components[\"schemas\"][\"PaymentMethod\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"transfer\" | \"transfer_automated\";\n bank_account: components[\"schemas\"][\"BankAccount\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"wallet\";\n /** @example wal_PPpxP5d3uvgiTT */\n wallet_id: string;\n } | {\n /** @enum {string} */\n payment_method_type: \"external\";\n }) & ({\n /**\n * @description\n * Transaction status.\n *\n * - `scheduled`: The transaction is scheduled to be processed in the future.\n * - `to_process`: The transaction is waiting to be processed by our system.\n * - `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n * - `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n * - `cancelled`: The transaction has been cancelled and won't be processed again.\n *\n * @example settled\n * @enum {string}\n */\n status: \"scheduled\" | \"to_process\" | \"pending\" | \"settled\" | \"cancelled\";\n } | {\n /**\n * @description\n * Transaction status.\n *\n * - `failed`: The transaction failed.\n *\n * @example failed\n * @enum {string}\n */\n status: \"failed\";\n /**\n * @description\n * Transaction error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n * - `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n * - `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @enum {string|null}\n */\n error_type: \"authentication_required\" | \"declined\" | \"fraud\" | \"payment_method_authorization_error\" | \"payment_method_declined\" | \"payment_method_expired\" | \"payment_method_invalid\" | \"payment_method_not_supported\" | \"processing_error\" | \"provider_error\" | \"unknown\" | null;\n /** @description Details of the error. */\n error_message: string | null;\n }))[];\n coupons: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n discount_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n /** @description Percentage to apply as a discount on the amount (excluding taxes) of a product. */\n discount_percent: number | null;\n /**\n * @description IDs of the line items to which the coupon applies.\n * @example [\n * \"ili_0FACNpeoEFkGu3\"\n * ]\n */\n line_item_ids: string[];\n }[];\n };\n CreateInvoiceLineItem: {\n /**\n * @description Description of the line item as it will appear on the invoice. Default to the product description.\n * @example Access fee for the period of November 2024\n */\n description?: string;\n /**\n * @description Count of units of the product related to the invoice line item.\n * @default 1\n * @example 1\n */\n units_count: number;\n /**\n * @description Tax rate of the invoice line item.\n * @example 20\n */\n tax_rate?: number;\n period_start?: components[\"schemas\"][\"DateTime\"] & string;\n period_end?: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description Product ID related to the invoice line item.\n * @example itm_KbLcWt2qm5p1S2\n */\n product_id?: string;\n /**\n * @description Name of the line item as it will appear on the invoice. Default to the product name.\n * @example Platform access\n */\n name: string;\n unit_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /**\n * @description Product ID related to the invoice line item.\n * @example itm_KbLcWt2qm5p1S2\n */\n product_id: string;\n /**\n * @description Name of the line item as it will appear on the invoice. Default to the product name.\n * @example Platform access\n */\n name?: string;\n unit_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n });\n CreateInvoice: {\n /**\n * @description Customer ID.\n * @example inv_1eTaiytfA0i2Va\n */\n customer_id: string;\n currency?: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description ID of the invoicing entity attached to the invoice.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id?: string;\n /**\n * @description Invoice number. If specified, the invoice will be considered as imported from an external source and the number will not be generated by Hyperline. You are responsible for avoiding duplicates and ensuring it does not impact the numbering sequence in Hyperline.\n * @example INV-35\n */\n number?: string;\n /** @enum {string} */\n type?: \"invoice\" | \"credit_note\" | \"document\";\n /**\n * @description Current invoice status.\n *\n * - `draft`: Invoice is in draft mode (not finalized yet).\n * - `open`: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).\n * - `grace_period`: Invoice is in a review period after being issued for the billing period and before becoming due for payment.\n * - `to_pay`: Invoice is awaiting payment.\n * - `partially_paid`: Invoice is partially paid.\n * - `paid`: Invoice is fully paid.\n * - `voided`: Invoice has been voided and is no longer valid.\n * - `closed`: Invoice was not issued and has been discarded.\n * - `error`: Invoice failed to be paid.\n * - `archived`: A previous version of an invoice.\n * - `charged_on_parent`: Invoice is charged on the parent customer.\n * - `pending_parent_concat`: Invoice is pending invoices concatenation on the parent customer to be grouped.\n *\n * @default paid\n * @example paid\n * @enum {string}\n */\n status: \"to_pay\" | \"paid\" | \"draft\";\n /**\n * @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.\n * @example V0KAHOU6J3\n */\n reference?: string;\n /**\n * @description Reference to the purchase order linked to the invoice.\n * @example PO-12345\n */\n purchase_order?: string;\n /**\n * @description Tax rate of the invoice.\n * @example 20\n */\n tax_rate?: number;\n /**\n * @description\n * Payment method strategy used to charge the invoice. Only applies to `to_pay` status.\n *\n * - `current`: Use the current default payment method of the customer.\n * - `external`: Manage the payment of the invoice outside of Hyperline.\n *\n * @example external\n * @enum {string}\n */\n payment_method_strategy?: \"current\" | \"external\";\n /**\n * @description ID of the payment method used to pay the invoice.\n * @example pm_1ryTrMj4TTAT1N\n */\n payment_method_id?: string;\n emitted_at?: components[\"schemas\"][\"DateTime\"] & string;\n due_at?: components[\"schemas\"][\"DateTime\"] & string;\n settled_at?: components[\"schemas\"][\"DateTime\"] & string;\n line_items: components[\"schemas\"][\"CreateInvoiceLineItem\"][];\n /**\n * @description Custom note added to the invoice.\n * @example Thank you for your purchase!\n */\n custom_note?: string;\n };\n UpdateInvoice: {\n /**\n * @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.\n * @example V0KAHOU6J3\n */\n reference?: string | null;\n /**\n * @description Reference to the purchase order linked to the invoice.\n * @example PO-12345\n */\n purchase_order?: string | null;\n /**\n * @description Custom note added to the invoice.\n * @example Thank you for your purchase!\n */\n custom_note?: string | null;\n };\n /** @description A file in binary format. Accepted MIME types: application/pdf. Max size: 5000000 bytes. */\n File: unknown;\n PaginatedCompany: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Company. */\n data: {\n /**\n * @description Company ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Company name.\n * @example Acme\n */\n name: string;\n /** @description Logo URL of the default invoicing entity. */\n logo_url: string | null;\n /** @description Favicon URL of the default invoicing entity. */\n favicon_url: string | null;\n address: components[\"schemas\"][\"Address\"] ;\n }[];\n };\n Coupon: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n };\n PaginatedCoupon: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Coupon. */\n data: components[\"schemas\"][\"Coupon\"][];\n };\n CreateCoupon: {\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description?: string | null;\n expiration_date?: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit?: number | null;\n } & ({\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n } | {\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n });\n UpdateCoupon: {\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description?: string | null;\n expiration_date?: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit?: number | null;\n } & ({\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n } | {\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n });\n CustomProperty: {\n /**\n * @description Custom property ID.\n * @example cfi_efnjehRH304\n */\n id: string;\n /**\n * @description Custom property name.\n * @example Test custom property\n */\n name: string;\n /**\n * @description Custom property unique slug.\n * @example test_custom_property\n */\n slug: string;\n /**\n * @description Custom property type.\n * @enum {string}\n */\n type: \"date\" | \"boolean\" | \"number\" | \"text\" | \"select\";\n /** @description Entities on which the custom property is available. */\n entities: (\"customer\" | \"product\" | \"plan\" | \"quote\" | \"subscription\")[];\n /** @description If the custom property is of type `select` this is the list of available values. */\n authorized_values: string[] | null;\n /**\n * @description If true the custom property will not be displayed in the interface.\n * @default false\n */\n api_only: boolean;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedCustomProperty: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of CustomProperty. */\n data: components[\"schemas\"][\"CustomProperty\"][];\n };\n Credit: {\n /**\n * @description Credit product ID.\n * @example itm_3kXODDF42QXtnL\n */\n product_id: string;\n /**\n * @description Current credit balance.\n * @example 2000\n */\n current_balance: number;\n /**\n * @description Customer ID related to the credit\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @description Credit name\n * @example Credit name\n */\n name: string;\n /**\n * @description Value indicating a low threshold.\n * @example 10\n */\n low_count_threshold: number | null;\n /**\n * @description Credit last refresh date.\n * @example 2024-11-23T09:00:01.860Z\n */\n last_refreshed_at: string;\n /**\n * @description Credit creation date.\n * @example 2024-10-12T07:00:01.860Z\n */\n created_at: string;\n /**\n * @description Credit last edition date.\n * @example 2024-10-13T10:00:01.860Z\n */\n updated_at: string;\n };\n PaginatedCredit: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Credit. */\n data: components[\"schemas\"][\"Credit\"][];\n };\n CreditTransaction: {\n /**\n * @description Credit transaction ID.\n * @example cdt_BPZ19obsBS2qyo\n */\n id: string;\n /**\n * @description ID of the product related to the transaction.\n * @example itm_3kXODDF42QXtnL\n */\n product_id: string | null;\n /**\n * @description Price details related to the transaction.\n * @example {\n * \"id\": \"pri_0Jv8EbMDOGsHcn\",\n * \"amount\": 20000,\n * \"pack_size\": 120\n * }\n */\n price: {\n id: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n pack_size: number;\n } | null;\n /**\n * @description ID of the customer related to the transaction.\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @description ID of the payment method related to the transaction.\n * @example pm_1xMpj5bwRqN7LM\n */\n payment_method_id: string | null;\n /**\n * @description ID of the invoice related to the transaction.\n * @example inv_1eTaiytfA0i2Va\n */\n invoice_id: string | null;\n /** @description ID of the event related to the credit consumption. */\n event_id: string | null;\n /**\n * @description Type of credit transaction.\n * @example topup\n * @enum {string}\n */\n type: \"topup\" | \"usage\";\n /**\n * @description Type of credit transaction.\n * @example api\n * @enum {string}\n */\n source: \"app\" | \"portal\" | \"api\";\n amount_excluding_tax: components[\"schemas\"][\"Amount\"] & (number | null);\n /**\n * @description Value of credits related to the transaction.\n * @example 32\n */\n credit_count: number;\n /**\n * @description Credit balance after the transaction.\n * @example 2000\n */\n balance_after: number;\n /**\n * @description Credit transaction creation date.\n * @example 2024-10-13T07:00:01.860Z\n */\n created_at: string;\n /**\n * @description Credit transaction last edition date.\n * @example 2024-10-13T07:00:01.860Z\n */\n updated_at: string;\n };\n PaginatedCreditTransaction: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of CreditTransaction. */\n data: components[\"schemas\"][\"CreditTransaction\"][];\n };\n CreateCredit: {\n /**\n * @description Credit product ID.\n * @example itm_3kXODDF42QXtnL\n */\n product_id: string;\n /**\n * @description Current credit balance.\n * @example 2000\n */\n current_balance?: number | null;\n /**\n * @description Credit name\n * @example Credit name\n */\n name: string | null;\n /**\n * @description Value indicating a low threshold.\n * @example 10\n */\n low_count_threshold: number | null;\n };\n CreateCreditPurchase: {\n /**\n * @description Value indicating a number of credits to add. If `price_id` is defined, this value must correspond to a full credit pack for the price.\n * @example 32\n */\n credit_count: number;\n amount_excluding_tax?: components[\"schemas\"][\"Amount\"] & (number | null);\n /** @description Price ID used to add credits. The price must be of type `bundle`. Either `amount_excluding_tax` or `price_id` must be defined. */\n price_id?: string | null;\n };\n CreateCreditTopup: {\n /**\n * @description Value indicating a number of credits to add. If `price_id` is defined, this value must correspond to a full credit pack for the price.\n * @example 32\n */\n credit_count: number;\n };\n CreateCreditUsage: {\n /**\n * @description Value indicating the number of credits consumed.\n * @example 41\n */\n usage_retained: number;\n /** @description Event ID corresponding to the credit consumption. */\n event_id?: string | null;\n };\n Customer: {\n /**\n * @description Customer ID.\n * @example cus_Typ0px2W0aiEtl\n */\n id: string;\n /**\n * @description Customer name.\n * @example Acme\n */\n name: string;\n /**\n * @description\n * Customer type.\n *\n * - `corporate`: The customer is a business entity.\n * - `person`: The customer is a natural person.\n * - `automatically_created`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.\n *\n * @example corporate\n * @enum {string|null}\n */\n type: \"corporate\" | \"person\" | \"automatically_created\" | null;\n /**\n * @description Customer status.\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number: string | null;\n /**\n * @description Indicates customer's tax ID validity.\n * @example true\n */\n vat_number_valid: boolean;\n /** @description Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements. */\n vat_rate_custom: number | null;\n /**\n * @description Language used for invoices, emails, and hosted pages.\n * @example fr\n * @enum {string|null}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\" | null;\n /**\n * @description Customer timezone.\n * @example Europe/Paris\n * @enum {string|null}\n */\n timezone: \"Pacific/Niue\" | \"Pacific/Midway\" | \"Pacific/Pago_Pago\" | \"Pacific/Rarotonga\" | \"Pacific/Honolulu\" | \"Pacific/Tahiti\" | \"Pacific/Marquesas\" | \"Pacific/Gambier\" | \"America/Adak\" | \"America/Anchorage\" | \"Pacific/Pitcairn\" | \"America/Hermosillo\" | \"America/Phoenix\" | \"America/Los_Angeles\" | \"America/Tijuana\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Belize\" | \"America/Guatemala\" | \"America/Managua\" | \"America/Mexico_City\" | \"America/Costa_Rica\" | \"America/El_Salvador\" | \"America/Regina\" | \"America/Tegucigalpa\" | \"Pacific/Galapagos\" | \"America/Edmonton\" | \"America/Ciudad_Juarez\" | \"America/Denver\" | \"America/Rio_Branco\" | \"America/Chicago\" | \"America/Matamoros\" | \"America/Winnipeg\" | \"America/Bogota\" | \"Pacific/Easter\" | \"America/Atikokan\" | \"America/Cancun\" | \"America/Cayman\" | \"America/Jamaica\" | \"America/Panama\" | \"America/Guayaquil\" | \"America/Lima\" | \"America/Manaus\" | \"America/St_Kitts\" | \"America/Blanc-Sablon\" | \"America/Montserrat\" | \"America/Barbados\" | \"America/St_Lucia\" | \"America/Port_of_Spain\" | \"America/Martinique\" | \"America/St_Barthelemy\" | \"America/St_Vincent\" | \"America/Kralendijk\" | \"America/Guadeloupe\" | \"America/Marigot\" | \"America/Aruba\" | \"America/Lower_Princes\" | \"America/Tortola\" | \"America/Dominica\" | \"America/St_Thomas\" | \"America/Grenada\" | \"America/Antigua\" | \"America/Puerto_Rico\" | \"America/Santo_Domingo\" | \"America/Anguilla\" | \"America/Curacao\" | \"America/La_Paz\" | \"America/Havana\" | \"America/Grand_Turk\" | \"America/Nassau\" | \"America/New_York\" | \"America/Port-au-Prince\" | \"America/Toronto\" | \"America/Guyana\" | \"America/Asuncion\" | \"America/Caracas\" | \"America/Argentina/Buenos_Aires\" | \"America/Halifax\" | \"Atlantic/Bermuda\" | \"America/Thule\" | \"America/Sao_Paulo\" | \"Antarctica/Palmer\" | \"America/Punta_Arenas\" | \"America/Santiago\" | \"Atlantic/Stanley\" | \"America/Cayenne\" | \"America/Paramaribo\" | \"America/Montevideo\" | \"America/St_Johns\" | \"America/Noronha\" | \"Atlantic/South_Georgia\" | \"America/Miquelon\" | \"Atlantic/Cape_Verde\" | \"America/Scoresbysund\" | \"America/Nuuk\" | \"Atlantic/Azores\" | \"Etc/UTC\" | \"Africa/Abidjan\" | \"Africa/Bamako\" | \"Africa/Bissau\" | \"Africa/Conakry\" | \"Africa/Dakar\" | \"America/Danmarkshavn\" | \"Africa/Freetown\" | \"Atlantic/St_Helena\" | \"Africa/Accra\" | \"Africa/Lome\" | \"Africa/Monrovia\" | \"Africa/Nouakchott\" | \"Africa/Ouagadougou\" | \"Atlantic/Reykjavik\" | \"Africa/Sao_Tome\" | \"Africa/Banjul\" | \"Africa/Casablanca\" | \"Africa/El_Aaiun\" | \"Africa/Algiers\" | \"Africa/Tunis\" | \"Europe/Isle_of_Man\" | \"Europe/Dublin\" | \"Europe/London\" | \"Europe/Jersey\" | \"Europe/Guernsey\" | \"Africa/Bangui\" | \"Africa/Malabo\" | \"Africa/Brazzaville\" | \"Africa/Porto-Novo\" | \"Africa/Douala\" | \"Africa/Kinshasa\" | \"Africa/Lagos\" | \"Africa/Libreville\" | \"Africa/Luanda\" | \"Africa/Ndjamena\" | \"Africa/Niamey\" | \"Atlantic/Canary\" | \"Europe/Lisbon\" | \"Atlantic/Faroe\" | \"Africa/Bujumbura\" | \"Africa/Gaborone\" | \"Africa/Harare\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Kigali\" | \"Africa/Blantyre\" | \"Africa/Lubumbashi\" | \"Africa/Lusaka\" | \"Africa/Maputo\" | \"Africa/Windhoek\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Bratislava\" | \"Europe/Brussels\" | \"Europe/Budapest\" | \"Europe/Copenhagen\" | \"Europe/Gibraltar\" | \"Europe/Ljubljana\" | \"Arctic/Longyearbyen\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Monaco\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Podgorica\" | \"Europe/Prague\" | \"Europe/Rome\" | \"Europe/San_Marino\" | \"Europe/Malta\" | \"Europe/Sarajevo\" | \"Europe/Skopje\" | \"Europe/Stockholm\" | \"Europe/Tirane\" | \"Europe/Vaduz\" | \"Europe/Vatican\" | \"Europe/Vienna\" | \"Europe/Warsaw\" | \"Europe/Zagreb\" | \"Europe/Zurich\" | \"Africa/Cairo\" | \"Asia/Hebron\" | \"Europe/Kaliningrad\" | \"Africa/Tripoli\" | \"Antarctica/Troll\" | \"Africa/Johannesburg\" | \"Africa/Mbabane\" | \"Africa/Maseru\" | \"Asia/Kuwait\" | \"Asia/Bahrain\" | \"Asia/Baghdad\" | \"Asia/Qatar\" | \"Asia/Riyadh\" | \"Asia/Aden\" | \"Asia/Amman\" | \"Asia/Damascus\" | \"Africa/Addis_Ababa\" | \"Indian/Antananarivo\" | \"Africa/Asmara\" | \"Africa/Dar_es_Salaam\" | \"Africa/Djibouti\" | \"Africa/Kampala\" | \"Indian/Mayotte\" | \"Africa/Mogadishu\" | \"Indian/Comoro\" | \"Africa/Nairobi\" | \"Europe/Athens\" | \"Asia/Beirut\" | \"Europe/Bucharest\" | \"Europe/Chisinau\" | \"Europe/Helsinki\" | \"Europe/Kyiv\" | \"Europe/Mariehamn\" | \"Asia/Nicosia\" | \"Europe/Riga\" | \"Europe/Sofia\" | \"Europe/Tallinn\" | \"Europe/Vilnius\" | \"Asia/Jerusalem\" | \"Europe/Minsk\" | \"Europe/Moscow\" | \"Europe/Simferopol\" | \"Antarctica/Syowa\" | \"Europe/Istanbul\" | \"Asia/Tehran\" | \"Asia/Yerevan\" | \"Asia/Baku\" | \"Asia/Tbilisi\" | \"Asia/Dubai\" | \"Asia/Muscat\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"Europe/Samara\" | \"Indian/Mahe\" | \"Asia/Kabul\" | \"Asia/Almaty\" | \"Indian/Kerguelen\" | \"Indian/Maldives\" | \"Antarctica/Mawson\" | \"Asia/Karachi\" | \"Asia/Dushanbe\" | \"Asia/Ashgabat\" | \"Asia/Tashkent\" | \"Antarctica/Vostok\" | \"Asia/Aqtobe\" | \"Asia/Yekaterinburg\" | \"Asia/Colombo\" | \"Asia/Kolkata\" | \"Asia/Kathmandu\" | \"Asia/Dhaka\" | \"Asia/Thimphu\" | \"Asia/Urumqi\" | \"Indian/Chagos\" | \"Asia/Bishkek\" | \"Asia/Omsk\" | \"Indian/Cocos\" | \"Asia/Yangon\" | \"Indian/Christmas\" | \"Antarctica/Davis\" | \"Asia/Hovd\" | \"Asia/Bangkok\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Phnom_Penh\" | \"Asia/Vientiane\" | \"Asia/Novosibirsk\" | \"Asia/Jakarta\" | \"Australia/Perth\" | \"Asia/Brunei\" | \"Antarctica/Casey\" | \"Asia/Makassar\" | \"Asia/Macau\" | \"Asia/Shanghai\" | \"Asia/Hong_Kong\" | \"Asia/Irkutsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Manila\" | \"Asia/Singapore\" | \"Asia/Taipei\" | \"Asia/Ulaanbaatar\" | \"Australia/Eucla\" | \"Asia/Dili\" | \"Asia/Jayapura\" | \"Asia/Tokyo\" | \"Asia/Pyongyang\" | \"Asia/Seoul\" | \"Pacific/Palau\" | \"Asia/Chita\" | \"Australia/Darwin\" | \"Australia/Brisbane\" | \"Pacific/Guam\" | \"Pacific/Saipan\" | \"Pacific/Chuuk\" | \"Antarctica/DumontDUrville\" | \"Pacific/Port_Moresby\" | \"Asia/Vladivostok\" | \"Australia/Adelaide\" | \"Australia/Sydney\" | \"Pacific/Bougainville\" | \"Pacific/Kosrae\" | \"Australia/Lord_Howe\" | \"Pacific/Noumea\" | \"Asia/Sakhalin\" | \"Pacific/Guadalcanal\" | \"Pacific/Efate\" | \"Pacific/Fiji\" | \"Pacific/Tarawa\" | \"Pacific/Majuro\" | \"Pacific/Nauru\" | \"Pacific/Norfolk\" | \"Asia/Kamchatka\" | \"Pacific/Funafuti\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Antarctica/McMurdo\" | \"Pacific/Kanton\" | \"Pacific/Fakaofo\" | \"Pacific/Tongatapu\" | \"Pacific/Chatham\" | \"Pacific/Kiritimati\" | null;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id: string | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n billing_address: components[\"schemas\"][\"Address\"] ;\n /**\n * Format: email\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n billing_email: string | null;\n /**\n * @description Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the `billing_email`; otherwise, they won't be sent to the `billing_email`.\n * @example [\n * \"accounting@acme.com\"\n * ]\n */\n invoice_emails: string[];\n /**\n * @description ID of the invoicing entity this customer will be attached to.\n * @example ive_484dn4U48E\n */\n invoicing_entity_id: string;\n /** @description Indicates if invoice reminders are enabled for the customer. */\n invoice_reminders_enabled: boolean | (\"true\" | \"false\");\n /**\n * @description Default price book ID assigned to the customer.\n * @example prib_613_WbVIZ1329e\n */\n price_book_id: string | null;\n /**\n * @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.\n * @example [\n * \"card\",\n * \"direct_debit\"\n * ]\n */\n available_payment_methods: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * @description Default payment method type used to pay subscriptions and one-off invoices.\n * @example card\n * @enum {string|null}\n */\n current_payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n /**\n * @description ID of the default payment method of the customer. Only applies to card and direct debit.\n * @example pm_UTclbc1US8GzCe\n */\n current_payment_method_id: string | null;\n /**\n * @description Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.\n * @example 30\n */\n custom_payment_delay: number | null;\n subscriptions: {\n /**\n * @description Subscription ID.\n * @example sub_0kIc7jrF7gV00V\n */\n id: string;\n /**\n * @description Status of the subscription.\n * @example active\n * @enum {string}\n */\n status: \"draft\" | \"pending\" | \"trialing\" | \"active\" | \"paused\" | \"errored\" | \"cancelled\" | \"voided\" | \"archived\";\n /**\n * @description Start date of the current period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-10-12T07:00:01.860Z\n */\n current_period_started_at: string | null;\n /**\n * @description End date of the current period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-11-12T07:00:01.860Z\n */\n current_period_ends_at: string | null;\n /**\n * @description Plan ID.\n * @example plan_34hdd843hReh\n */\n plan_id: string | null;\n /**\n * @description Checkout session ID.\n * @example che_949djdj39RJj\n */\n checkout_session_id: string | null;\n }[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n deleted_at: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n PaginatedCustomer: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Customer. */\n data: components[\"schemas\"][\"Customer\"][];\n };\n CustomerDetails: components[\"schemas\"][\"Customer\"] & {\n /**\n * @description Provider/ID mapping of the customer in the related providers. Provider (key) can be gocardless, mollie, stripe, airwallex, hubspot, salesforce, xero, exact-online, pennylane, netsuite.\n * @example {\n * \"stripe\": \"cus_Ol3QIaTstxxxxx\"\n * }\n */\n providers: {\n gocardless?: string;\n mollie?: string;\n stripe?: string;\n airwallex?: string;\n hubspot?: string;\n salesforce?: string;\n xero?: string;\n \"exact-online\"?: string;\n pennylane?: string;\n netsuite?: string;\n };\n current_payment_method: components[\"schemas\"][\"PaymentMethod\"] & unknown;\n bank_account: components[\"schemas\"][\"BankAccount\"] & unknown;\n /** @description Parent organization ID to which the client is attached. */\n organisation_id: string | null;\n /**\n * @description\n * How customer invoices are issued from the parent organisation.\n *\n * - `none`: Invoices will keep being issued from this customer.\n * - `every_invoice`: Customer invoices will be issued from the organisation individually.\n * - `concat`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).\n *\n * @enum {string|null}\n */\n organisation_invoicing: \"none\" | \"every_invoice\" | \"concat\" | null;\n };\n /** @description Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used. */\n UpdateBankAccount: {\n /**\n * @description Bank name.\n * @example Fake bank\n */\n bank_name?: string | null;\n } & ({\n /** @enum {string} */\n format: \"iban_bic_swift\";\n iban: string;\n bic_swift: string | null;\n } | {\n /** @enum {string} */\n format: \"sort_code_account_number\";\n sort_code: string;\n account_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_routing_number\";\n account_number: string;\n routing_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_bic_swift\";\n account_number: string;\n bic_swift: string;\n });\n CreateCustomer: {\n /**\n * @description Customer name.\n * @example Acme\n */\n name?: string;\n /**\n * @description\n * Customer type.\n *\n * - `corporate`: The customer is a business entity.\n * - `person`: The customer is a natural person.\n * - `automatically_created`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.\n *\n * @example corporate\n * @enum {string}\n */\n type?: \"corporate\" | \"person\";\n currency?: components[\"schemas\"][\"Currency\"];\n country?: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number?: string;\n /** @description Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements. */\n vat_rate_custom?: number;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id?: string;\n /** @description ID of the invoicing entity this customer will be attached to. */\n invoicing_entity_id?: string;\n billing_address?: components[\"schemas\"][\"Address\"] ;\n /**\n * Format: email\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n billing_email?: string;\n /**\n * @description Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the `billing_email`; otherwise, they won't be sent to the `billing_email`.\n * @example [\n * \"accounting@acme.com\"\n * ]\n */\n invoice_emails?: string[];\n /**\n * @description Language used for invoices, emails, and hosted pages.\n * @example fr\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Customer timezone.\n * @example Europe/Paris\n * @enum {string}\n */\n timezone?: \"Pacific/Niue\" | \"Pacific/Midway\" | \"Pacific/Pago_Pago\" | \"Pacific/Rarotonga\" | \"Pacific/Honolulu\" | \"Pacific/Tahiti\" | \"Pacific/Marquesas\" | \"Pacific/Gambier\" | \"America/Adak\" | \"America/Anchorage\" | \"Pacific/Pitcairn\" | \"America/Hermosillo\" | \"America/Phoenix\" | \"America/Los_Angeles\" | \"America/Tijuana\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Belize\" | \"America/Guatemala\" | \"America/Managua\" | \"America/Mexico_City\" | \"America/Costa_Rica\" | \"America/El_Salvador\" | \"America/Regina\" | \"America/Tegucigalpa\" | \"Pacific/Galapagos\" | \"America/Edmonton\" | \"America/Ciudad_Juarez\" | \"America/Denver\" | \"America/Rio_Branco\" | \"America/Chicago\" | \"America/Matamoros\" | \"America/Winnipeg\" | \"America/Bogota\" | \"Pacific/Easter\" | \"America/Atikokan\" | \"America/Cancun\" | \"America/Cayman\" | \"America/Jamaica\" | \"America/Panama\" | \"America/Guayaquil\" | \"America/Lima\" | \"America/Manaus\" | \"America/St_Kitts\" | \"America/Blanc-Sablon\" | \"America/Montserrat\" | \"America/Barbados\" | \"America/St_Lucia\" | \"America/Port_of_Spain\" | \"America/Martinique\" | \"America/St_Barthelemy\" | \"America/St_Vincent\" | \"America/Kralendijk\" | \"America/Guadeloupe\" | \"America/Marigot\" | \"America/Aruba\" | \"America/Lower_Princes\" | \"America/Tortola\" | \"America/Dominica\" | \"America/St_Thomas\" | \"America/Grenada\" | \"America/Antigua\" | \"America/Puerto_Rico\" | \"America/Santo_Domingo\" | \"America/Anguilla\" | \"America/Curacao\" | \"America/La_Paz\" | \"America/Havana\" | \"America/Grand_Turk\" | \"America/Nassau\" | \"America/New_York\" | \"America/Port-au-Prince\" | \"America/Toronto\" | \"America/Guyana\" | \"America/Asuncion\" | \"America/Caracas\" | \"America/Argentina/Buenos_Aires\" | \"America/Halifax\" | \"Atlantic/Bermuda\" | \"America/Thule\" | \"America/Sao_Paulo\" | \"Antarctica/Palmer\" | \"America/Punta_Arenas\" | \"America/Santiago\" | \"Atlantic/Stanley\" | \"America/Cayenne\" | \"America/Paramaribo\" | \"America/Montevideo\" | \"America/St_Johns\" | \"America/Noronha\" | \"Atlantic/South_Georgia\" | \"America/Miquelon\" | \"Atlantic/Cape_Verde\" | \"America/Scoresbysund\" | \"America/Nuuk\" | \"Atlantic/Azores\" | \"Etc/UTC\" | \"Africa/Abidjan\" | \"Africa/Bamako\" | \"Africa/Bissau\" | \"Africa/Conakry\" | \"Africa/Dakar\" | \"America/Danmarkshavn\" | \"Africa/Freetown\" | \"Atlantic/St_Helena\" | \"Africa/Accra\" | \"Africa/Lome\" | \"Africa/Monrovia\" | \"Africa/Nouakchott\" | \"Africa/Ouagadougou\" | \"Atlantic/Reykjavik\" | \"Africa/Sao_Tome\" | \"Africa/Banjul\" | \"Africa/Casablanca\" | \"Africa/El_Aaiun\" | \"Africa/Algiers\" | \"Africa/Tunis\" | \"Europe/Isle_of_Man\" | \"Europe/Dublin\" | \"Europe/London\" | \"Europe/Jersey\" | \"Europe/Guernsey\" | \"Africa/Bangui\" | \"Africa/Malabo\" | \"Africa/Brazzaville\" | \"Africa/Porto-Novo\" | \"Africa/Douala\" | \"Africa/Kinshasa\" | \"Africa/Lagos\" | \"Africa/Libreville\" | \"Africa/Luanda\" | \"Africa/Ndjamena\" | \"Africa/Niamey\" | \"Atlantic/Canary\" | \"Europe/Lisbon\" | \"Atlantic/Faroe\" | \"Africa/Bujumbura\" | \"Africa/Gaborone\" | \"Africa/Harare\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Kigali\" | \"Africa/Blantyre\" | \"Africa/Lubumbashi\" | \"Africa/Lusaka\" | \"Africa/Maputo\" | \"Africa/Windhoek\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Bratislava\" | \"Europe/Brussels\" | \"Europe/Budapest\" | \"Europe/Copenhagen\" | \"Europe/Gibraltar\" | \"Europe/Ljubljana\" | \"Arctic/Longyearbyen\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Monaco\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Podgorica\" | \"Europe/Prague\" | \"Europe/Rome\" | \"Europe/San_Marino\" | \"Europe/Malta\" | \"Europe/Sarajevo\" | \"Europe/Skopje\" | \"Europe/Stockholm\" | \"Europe/Tirane\" | \"Europe/Vaduz\" | \"Europe/Vatican\" | \"Europe/Vienna\" | \"Europe/Warsaw\" | \"Europe/Zagreb\" | \"Europe/Zurich\" | \"Africa/Cairo\" | \"Asia/Hebron\" | \"Europe/Kaliningrad\" | \"Africa/Tripoli\" | \"Antarctica/Troll\" | \"Africa/Johannesburg\" | \"Africa/Mbabane\" | \"Africa/Maseru\" | \"Asia/Kuwait\" | \"Asia/Bahrain\" | \"Asia/Baghdad\" | \"Asia/Qatar\" | \"Asia/Riyadh\" | \"Asia/Aden\" | \"Asia/Amman\" | \"Asia/Damascus\" | \"Africa/Addis_Ababa\" | \"Indian/Antananarivo\" | \"Africa/Asmara\" | \"Africa/Dar_es_Salaam\" | \"Africa/Djibouti\" | \"Africa/Kampala\" | \"Indian/Mayotte\" | \"Africa/Mogadishu\" | \"Indian/Comoro\" | \"Africa/Nairobi\" | \"Europe/Athens\" | \"Asia/Beirut\" | \"Europe/Bucharest\" | \"Europe/Chisinau\" | \"Europe/Helsinki\" | \"Europe/Kyiv\" | \"Europe/Mariehamn\" | \"Asia/Nicosia\" | \"Europe/Riga\" | \"Europe/Sofia\" | \"Europe/Tallinn\" | \"Europe/Vilnius\" | \"Asia/Jerusalem\" | \"Europe/Minsk\" | \"Europe/Moscow\" | \"Europe/Simferopol\" | \"Antarctica/Syowa\" | \"Europe/Istanbul\" | \"Asia/Tehran\" | \"Asia/Yerevan\" | \"Asia/Baku\" | \"Asia/Tbilisi\" | \"Asia/Dubai\" | \"Asia/Muscat\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"Europe/Samara\" | \"Indian/Mahe\" | \"Asia/Kabul\" | \"Asia/Almaty\" | \"Indian/Kerguelen\" | \"Indian/Maldives\" | \"Antarctica/Mawson\" | \"Asia/Karachi\" | \"Asia/Dushanbe\" | \"Asia/Ashgabat\" | \"Asia/Tashkent\" | \"Antarctica/Vostok\" | \"Asia/Aqtobe\" | \"Asia/Yekaterinburg\" | \"Asia/Colombo\" | \"Asia/Kolkata\" | \"Asia/Kathmandu\" | \"Asia/Dhaka\" | \"Asia/Thimphu\" | \"Asia/Urumqi\" | \"Indian/Chagos\" | \"Asia/Bishkek\" | \"Asia/Omsk\" | \"Indian/Cocos\" | \"Asia/Yangon\" | \"Indian/Christmas\" | \"Antarctica/Davis\" | \"Asia/Hovd\" | \"Asia/Bangkok\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Phnom_Penh\" | \"Asia/Vientiane\" | \"Asia/Novosibirsk\" | \"Asia/Jakarta\" | \"Australia/Perth\" | \"Asia/Brunei\" | \"Antarctica/Casey\" | \"Asia/Makassar\" | \"Asia/Macau\" | \"Asia/Shanghai\" | \"Asia/Hong_Kong\" | \"Asia/Irkutsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Manila\" | \"Asia/Singapore\" | \"Asia/Taipei\" | \"Asia/Ulaanbaatar\" | \"Australia/Eucla\" | \"Asia/Dili\" | \"Asia/Jayapura\" | \"Asia/Tokyo\" | \"Asia/Pyongyang\" | \"Asia/Seoul\" | \"Pacific/Palau\" | \"Asia/Chita\" | \"Australia/Darwin\" | \"Australia/Brisbane\" | \"Pacific/Guam\" | \"Pacific/Saipan\" | \"Pacific/Chuuk\" | \"Antarctica/DumontDUrville\" | \"Pacific/Port_Moresby\" | \"Asia/Vladivostok\" | \"Australia/Adelaide\" | \"Australia/Sydney\" | \"Pacific/Bougainville\" | \"Pacific/Kosrae\" | \"Australia/Lord_Howe\" | \"Pacific/Noumea\" | \"Asia/Sakhalin\" | \"Pacific/Guadalcanal\" | \"Pacific/Efate\" | \"Pacific/Fiji\" | \"Pacific/Tarawa\" | \"Pacific/Majuro\" | \"Pacific/Nauru\" | \"Pacific/Norfolk\" | \"Asia/Kamchatka\" | \"Pacific/Funafuti\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Antarctica/McMurdo\" | \"Pacific/Kanton\" | \"Pacific/Fakaofo\" | \"Pacific/Tongatapu\" | \"Pacific/Chatham\" | \"Pacific/Kiritimati\";\n /**\n * @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.\n * @example [\n * \"card\",\n * \"direct_debit\"\n * ]\n */\n available_payment_methods?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * @description Default payment method type used to pay subscriptions and one-off invoices.\n * @example card\n * @enum {string}\n */\n payment_method_type?: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\";\n bank_account?: components[\"schemas\"][\"UpdateBankAccount\"];\n /**\n * @description Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.\n * @example 30\n */\n custom_payment_delay?: number;\n /** @description Parent organization ID to which the client is attached. */\n organisation_id?: string;\n /**\n * @description\n * How customer invoices are issued from the parent organisation.\n *\n * - `none`: Invoices will keep being issued from this customer.\n * - `every_invoice`: Customer invoices will be issued from the organisation individually.\n * - `concat`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).\n *\n * @default none\n * @enum {string}\n */\n organisation_invoicing: \"none\" | \"every_invoice\" | \"concat\";\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n /** @description Indicates if invoice reminders are enabled for the customer. */\n invoice_reminders_enabled?: boolean | (\"true\" | \"false\");\n };\n UpdateCustomer: {\n /**\n * @description Customer name.\n * @example Acme\n */\n name?: string;\n /**\n * @description\n * Customer type.\n *\n * - `corporate`: The customer is a business entity.\n * - `person`: The customer is a natural person.\n * - `automatically_created`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.\n *\n * @example corporate\n * @enum {string|null}\n */\n type?: \"corporate\" | \"person\" | null;\n currency?: components[\"schemas\"][\"Currency\"] & unknown;\n country?: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number?: string | null;\n /** @description Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements. */\n vat_rate_custom?: number | null;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id?: string | null;\n /** @description ID of the invoicing entity this customer will be attached to. */\n invoicing_entity_id?: string;\n billing_address?: components[\"schemas\"][\"Address\"];\n /**\n * Format: email\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n billing_email?: string | null;\n /**\n * @description Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the `billing_email`; otherwise, they won't be sent to the `billing_email`.\n * @example [\n * \"accounting@acme.com\"\n * ]\n */\n invoice_emails?: string[];\n /**\n * @description Language used for invoices, emails, and hosted pages.\n * @example fr\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Customer timezone.\n * @example Europe/Paris\n * @enum {string}\n */\n timezone?: \"Pacific/Niue\" | \"Pacific/Midway\" | \"Pacific/Pago_Pago\" | \"Pacific/Rarotonga\" | \"Pacific/Honolulu\" | \"Pacific/Tahiti\" | \"Pacific/Marquesas\" | \"Pacific/Gambier\" | \"America/Adak\" | \"America/Anchorage\" | \"Pacific/Pitcairn\" | \"America/Hermosillo\" | \"America/Phoenix\" | \"America/Los_Angeles\" | \"America/Tijuana\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Belize\" | \"America/Guatemala\" | \"America/Managua\" | \"America/Mexico_City\" | \"America/Costa_Rica\" | \"America/El_Salvador\" | \"America/Regina\" | \"America/Tegucigalpa\" | \"Pacific/Galapagos\" | \"America/Edmonton\" | \"America/Ciudad_Juarez\" | \"America/Denver\" | \"America/Rio_Branco\" | \"America/Chicago\" | \"America/Matamoros\" | \"America/Winnipeg\" | \"America/Bogota\" | \"Pacific/Easter\" | \"America/Atikokan\" | \"America/Cancun\" | \"America/Cayman\" | \"America/Jamaica\" | \"America/Panama\" | \"America/Guayaquil\" | \"America/Lima\" | \"America/Manaus\" | \"America/St_Kitts\" | \"America/Blanc-Sablon\" | \"America/Montserrat\" | \"America/Barbados\" | \"America/St_Lucia\" | \"America/Port_of_Spain\" | \"America/Martinique\" | \"America/St_Barthelemy\" | \"America/St_Vincent\" | \"America/Kralendijk\" | \"America/Guadeloupe\" | \"America/Marigot\" | \"America/Aruba\" | \"America/Lower_Princes\" | \"America/Tortola\" | \"America/Dominica\" | \"America/St_Thomas\" | \"America/Grenada\" | \"America/Antigua\" | \"America/Puerto_Rico\" | \"America/Santo_Domingo\" | \"America/Anguilla\" | \"America/Curacao\" | \"America/La_Paz\" | \"America/Havana\" | \"America/Grand_Turk\" | \"America/Nassau\" | \"America/New_York\" | \"America/Port-au-Prince\" | \"America/Toronto\" | \"America/Guyana\" | \"America/Asuncion\" | \"America/Caracas\" | \"America/Argentina/Buenos_Aires\" | \"America/Halifax\" | \"Atlantic/Bermuda\" | \"America/Thule\" | \"America/Sao_Paulo\" | \"Antarctica/Palmer\" | \"America/Punta_Arenas\" | \"America/Santiago\" | \"Atlantic/Stanley\" | \"America/Cayenne\" | \"America/Paramaribo\" | \"America/Montevideo\" | \"America/St_Johns\" | \"America/Noronha\" | \"Atlantic/South_Georgia\" | \"America/Miquelon\" | \"Atlantic/Cape_Verde\" | \"America/Scoresbysund\" | \"America/Nuuk\" | \"Atlantic/Azores\" | \"Etc/UTC\" | \"Africa/Abidjan\" | \"Africa/Bamako\" | \"Africa/Bissau\" | \"Africa/Conakry\" | \"Africa/Dakar\" | \"America/Danmarkshavn\" | \"Africa/Freetown\" | \"Atlantic/St_Helena\" | \"Africa/Accra\" | \"Africa/Lome\" | \"Africa/Monrovia\" | \"Africa/Nouakchott\" | \"Africa/Ouagadougou\" | \"Atlantic/Reykjavik\" | \"Africa/Sao_Tome\" | \"Africa/Banjul\" | \"Africa/Casablanca\" | \"Africa/El_Aaiun\" | \"Africa/Algiers\" | \"Africa/Tunis\" | \"Europe/Isle_of_Man\" | \"Europe/Dublin\" | \"Europe/London\" | \"Europe/Jersey\" | \"Europe/Guernsey\" | \"Africa/Bangui\" | \"Africa/Malabo\" | \"Africa/Brazzaville\" | \"Africa/Porto-Novo\" | \"Africa/Douala\" | \"Africa/Kinshasa\" | \"Africa/Lagos\" | \"Africa/Libreville\" | \"Africa/Luanda\" | \"Africa/Ndjamena\" | \"Africa/Niamey\" | \"Atlantic/Canary\" | \"Europe/Lisbon\" | \"Atlantic/Faroe\" | \"Africa/Bujumbura\" | \"Africa/Gaborone\" | \"Africa/Harare\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Kigali\" | \"Africa/Blantyre\" | \"Africa/Lubumbashi\" | \"Africa/Lusaka\" | \"Africa/Maputo\" | \"Africa/Windhoek\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Bratislava\" | \"Europe/Brussels\" | \"Europe/Budapest\" | \"Europe/Copenhagen\" | \"Europe/Gibraltar\" | \"Europe/Ljubljana\" | \"Arctic/Longyearbyen\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Monaco\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Podgorica\" | \"Europe/Prague\" | \"Europe/Rome\" | \"Europe/San_Marino\" | \"Europe/Malta\" | \"Europe/Sarajevo\" | \"Europe/Skopje\" | \"Europe/Stockholm\" | \"Europe/Tirane\" | \"Europe/Vaduz\" | \"Europe/Vatican\" | \"Europe/Vienna\" | \"Europe/Warsaw\" | \"Europe/Zagreb\" | \"Europe/Zurich\" | \"Africa/Cairo\" | \"Asia/Hebron\" | \"Europe/Kaliningrad\" | \"Africa/Tripoli\" | \"Antarctica/Troll\" | \"Africa/Johannesburg\" | \"Africa/Mbabane\" | \"Africa/Maseru\" | \"Asia/Kuwait\" | \"Asia/Bahrain\" | \"Asia/Baghdad\" | \"Asia/Qatar\" | \"Asia/Riyadh\" | \"Asia/Aden\" | \"Asia/Amman\" | \"Asia/Damascus\" | \"Africa/Addis_Ababa\" | \"Indian/Antananarivo\" | \"Africa/Asmara\" | \"Africa/Dar_es_Salaam\" | \"Africa/Djibouti\" | \"Africa/Kampala\" | \"Indian/Mayotte\" | \"Africa/Mogadishu\" | \"Indian/Comoro\" | \"Africa/Nairobi\" | \"Europe/Athens\" | \"Asia/Beirut\" | \"Europe/Bucharest\" | \"Europe/Chisinau\" | \"Europe/Helsinki\" | \"Europe/Kyiv\" | \"Europe/Mariehamn\" | \"Asia/Nicosia\" | \"Europe/Riga\" | \"Europe/Sofia\" | \"Europe/Tallinn\" | \"Europe/Vilnius\" | \"Asia/Jerusalem\" | \"Europe/Minsk\" | \"Europe/Moscow\" | \"Europe/Simferopol\" | \"Antarctica/Syowa\" | \"Europe/Istanbul\" | \"Asia/Tehran\" | \"Asia/Yerevan\" | \"Asia/Baku\" | \"Asia/Tbilisi\" | \"Asia/Dubai\" | \"Asia/Muscat\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"Europe/Samara\" | \"Indian/Mahe\" | \"Asia/Kabul\" | \"Asia/Almaty\" | \"Indian/Kerguelen\" | \"Indian/Maldives\" | \"Antarctica/Mawson\" | \"Asia/Karachi\" | \"Asia/Dushanbe\" | \"Asia/Ashgabat\" | \"Asia/Tashkent\" | \"Antarctica/Vostok\" | \"Asia/Aqtobe\" | \"Asia/Yekaterinburg\" | \"Asia/Colombo\" | \"Asia/Kolkata\" | \"Asia/Kathmandu\" | \"Asia/Dhaka\" | \"Asia/Thimphu\" | \"Asia/Urumqi\" | \"Indian/Chagos\" | \"Asia/Bishkek\" | \"Asia/Omsk\" | \"Indian/Cocos\" | \"Asia/Yangon\" | \"Indian/Christmas\" | \"Antarctica/Davis\" | \"Asia/Hovd\" | \"Asia/Bangkok\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Phnom_Penh\" | \"Asia/Vientiane\" | \"Asia/Novosibirsk\" | \"Asia/Jakarta\" | \"Australia/Perth\" | \"Asia/Brunei\" | \"Antarctica/Casey\" | \"Asia/Makassar\" | \"Asia/Macau\" | \"Asia/Shanghai\" | \"Asia/Hong_Kong\" | \"Asia/Irkutsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Manila\" | \"Asia/Singapore\" | \"Asia/Taipei\" | \"Asia/Ulaanbaatar\" | \"Australia/Eucla\" | \"Asia/Dili\" | \"Asia/Jayapura\" | \"Asia/Tokyo\" | \"Asia/Pyongyang\" | \"Asia/Seoul\" | \"Pacific/Palau\" | \"Asia/Chita\" | \"Australia/Darwin\" | \"Australia/Brisbane\" | \"Pacific/Guam\" | \"Pacific/Saipan\" | \"Pacific/Chuuk\" | \"Antarctica/DumontDUrville\" | \"Pacific/Port_Moresby\" | \"Asia/Vladivostok\" | \"Australia/Adelaide\" | \"Australia/Sydney\" | \"Pacific/Bougainville\" | \"Pacific/Kosrae\" | \"Australia/Lord_Howe\" | \"Pacific/Noumea\" | \"Asia/Sakhalin\" | \"Pacific/Guadalcanal\" | \"Pacific/Efate\" | \"Pacific/Fiji\" | \"Pacific/Tarawa\" | \"Pacific/Majuro\" | \"Pacific/Nauru\" | \"Pacific/Norfolk\" | \"Asia/Kamchatka\" | \"Pacific/Funafuti\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Antarctica/McMurdo\" | \"Pacific/Kanton\" | \"Pacific/Fakaofo\" | \"Pacific/Tongatapu\" | \"Pacific/Chatham\" | \"Pacific/Kiritimati\";\n /**\n * @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.\n * @example [\n * \"card\",\n * \"direct_debit\"\n * ]\n */\n available_payment_methods?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * @description Default payment method type used to pay subscriptions and one-off invoices.\n * @example card\n * @enum {string|null}\n */\n payment_method_type?: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n /**\n * @description ID of the default payment method of the customer. Only applies to card and direct debit.\n * @example pm_UTclbc1US8GzCe\n */\n payment_method_id?: string | null;\n bank_account?: components[\"schemas\"][\"UpdateBankAccount\"] & (({\n /**\n * @description Bank name.\n * @example Fake bank\n */\n bank_name?: string | null;\n } & ({\n /** @enum {string} */\n format: \"iban_bic_swift\";\n iban: string;\n bic_swift: string | null;\n } | {\n /** @enum {string} */\n format: \"sort_code_account_number\";\n sort_code: string;\n account_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_routing_number\";\n account_number: string;\n routing_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_bic_swift\";\n account_number: string;\n bic_swift: string;\n })) | null);\n /**\n * @description Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.\n * @example 30\n */\n custom_payment_delay?: number | null;\n /** @description Parent organization ID to which the client is attached. */\n organisation_id?: string | null;\n /**\n * @description\n * How customer invoices are issued from the parent organisation.\n *\n * - `none`: Invoices will keep being issued from this customer.\n * - `every_invoice`: Customer invoices will be issued from the organisation individually.\n * - `concat`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).\n *\n * @enum {string|null}\n */\n organisation_invoicing?: \"none\" | \"every_invoice\" | \"concat\" | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n /** @description Indicates if invoice reminders are enabled for the customer. */\n invoice_reminders_enabled?: boolean | (\"true\" | \"false\");\n };\n Organisation: {\n /**\n * @description Organisation ID.\n * @example cus_0noDeAEU22FgA4\n */\n id: string;\n /**\n * @description Organisation legal name.\n * @example Acme Group\n */\n name: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /**\n * @description Frequency on which the invoices are grouped and emitted from the organisation. Only applies to `concat` invoice configuration on children customers.\n * @example month\n * @enum {string|null}\n */\n invoice_schedule: \"month\" | \"quarter\" | \"year\" | null;\n next_invoice_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description List of the organization's child customer IDs.\n * @example [\n * \"cus_Typ0px2W0aiEtl\"\n * ]\n */\n child_customer_ids: string[];\n };\n PatchOrganisation: {\n /**\n * @description Organisation legal name.\n * @example Acme Group\n */\n name?: string;\n currency?: components[\"schemas\"][\"Currency\"];\n country?: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description Frequency on which the invoices are grouped and emitted from the organisation. Only applies to `concat` invoice configuration on children customers.\n * @example month\n * @enum {string}\n */\n invoice_schedule?: \"month\" | \"quarter\" | \"year\";\n next_invoice_at?: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedPaymentMethod: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of PaymentMethod. */\n data: (components[\"schemas\"][\"PaymentMethod\"] & (components[\"schemas\"][\"PaymentMethodCard\"] | components[\"schemas\"][\"PaymentMethodDirectDebit\"]))[];\n };\n CreateComponentToken: {\n /** @description Customer ID */\n customer_id: string;\n };\n PaginatedInvoicingEntity: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of InvoicingEntity. */\n data: {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n }[];\n };\n /** @description Mapping invoicing entity ID/accounting settings. */\n ProductAccounting: {\n [key: string]: {\n /**\n * @description Custom tax rate ID.\n * @example taxr_YfiSnLIYORD9VN\n */\n tax_rate_id: string | null;\n /**\n * @description Code used to reconcile the product with the external accounting tool. Usually, it corresponds to the product ID in the accounting software.\n * @example PROD-23\n */\n product_code: string | null;\n /**\n * @description Code used to assign related invoices line items to a General Ledger account in your external accounting tool.\n * @example GL-001\n */\n account_code: string | null;\n };\n };\n ProductSimple: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"flat_fee\";\n /**\n * @description Enable the product to be billed at any time as a one-time payment.\n * @example true\n */\n is_available_on_demand: boolean;\n /**\n * @description Enable the product to be added as part of a subscription.\n * @example true\n */\n is_available_on_subscription: boolean;\n } | {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"seat\";\n } | {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"dynamic\";\n } | {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"credit\";\n /** @description Threshold indicating a low level of credits. */\n low_credits_threshold: number | null;\n };\n PaginatedProduct: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Product. */\n data: components[\"schemas\"][\"ProductSimple\"][];\n };\n PriceFee: {\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"fee\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n };\n ProductFee: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"flat_fee\";\n /**\n * @description Enable the product to be billed at any time as a one-time payment.\n * @example true\n */\n is_available_on_demand: boolean;\n /**\n * @description Enable the product to be added as part of a subscription.\n * @example true\n */\n is_available_on_subscription: boolean;\n price_configurations: {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"fee\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n }[];\n };\n PriceVolume: {\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"volume\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n /** @description From limit. */\n from: number;\n /** @description To limit. */\n to: number | null;\n /**\n * @description\n * Logic used to compute the amount when usage on the tier is incomplete.\n *\n * - `pro_rata`: The amount is computed using the pro rata of the tier's consumption.\n * - `pay_in_full`: The amount corresponds to the full payment of the tier.\n * - `do_not_charge`: The tier is not charged and ignored.\n *\n * @default pro_rata\n * @enum {string|null}\n */\n on_tier_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n };\n PricePackaged: {\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n /** @description From limit. */\n from: number;\n /** @description To limit. */\n to: number | null;\n /**\n * @description\n * Logic used to compute the amount when usage reaches an incomplete bucket (the bucket size corresponds to the `unitCount`).\n *\n * - `pro_rata`: The amount is computed using the pro rata of the bucket's consumption.\n * - `pay_in_full`: The amount corresponds to the full payment of the bucket.\n * - `do_not_charge`: The bucket is not charged and ignored.\n *\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n };\n PriceBulk: {\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n /** @description To limit. */\n to: number | null;\n /**\n * @description\n * Logic used to compute the amount when usage on the tier is incomplete.\n *\n * - `pro_rata`: The amount is computed using the pro rata of the tier's consumption.\n * - `pay_in_full`: The amount corresponds to the full payment of the tier.\n * - `do_not_charge`: The tier is not charged and ignored.\n *\n * @default pro_rata\n * @enum {string|null}\n */\n on_tier_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n };\n ProductSeat: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"seat\";\n price_configurations: ({\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"volume\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceVolume\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PricePackaged\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBulk\"][];\n })[];\n };\n PriceBps: {\n /** @enum {string} */\n type: \"bps\";\n /** @description Price ID. */\n id?: string;\n /** @description From limit. */\n from: number;\n /** @description To limit. */\n to: number | null;\n /** @description Percentage applied on each unit to compute the usage. */\n percentage: number;\n per_unit_cap: components[\"schemas\"][\"Amount\"] & (number | null);\n per_unit_floor: components[\"schemas\"][\"Amount\"] & (number | null);\n per_unit_fee: components[\"schemas\"][\"Amount\"] & (number | null);\n };\n /**\n * @description Configuration of the rules used to filter eligible events.\n * @example {\n * \"conditional\": \"and\",\n * \"fields\": [\n * {\n * \"property\": \"card_type\",\n * \"operator\": \"equals\",\n * \"value\": \"visa\"\n * },\n * {\n * \"property\": \"kind\",\n * \"operator\": \"equals\",\n * \"value\": \"credit_card\"\n * }\n * ]\n * }\n */\n MeteringFilterConfiguration: {\n /** @enum {string} */\n conditional: \"and\" | \"or\";\n fields: ({\n property: string;\n } & ({\n /** @enum {string} */\n operator: \"isNull\" | \"isNotNull\";\n } | {\n /** @enum {string} */\n operator: \"in\" | \"notIn\";\n value: string;\n } | {\n /** @enum {string} */\n operator: \"gte\" | \"gt\" | \"lt\" | \"lte\";\n value: number;\n } | {\n /** @enum {string} */\n operator: \"equals\" | \"notEqual\";\n value: string | number | boolean;\n }))[];\n };\n MeteringFilter: {\n /**\n * @description Name of the metering filter.\n * @example VISA credit cards\n */\n name: string;\n configuration: components[\"schemas\"][\"MeteringFilterConfiguration\"];\n } | null;\n ProductDynamic: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"dynamic\";\n price_configurations: (({\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"volume\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceVolume\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PricePackaged\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBulk\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bps\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBps\"][];\n }) & {\n metering_filter: components[\"schemas\"][\"MeteringFilter\"];\n })[];\n };\n ProductCredit: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"credit\";\n /** @description Threshold indicating a low level of credits. */\n low_credits_threshold: number | null;\n price_configurations: {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bundle\";\n allow_on_portal: boolean;\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceBulk\"] & {\n /** @enum {string} */\n type: \"bundle\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n })[];\n }[];\n };\n Product: components[\"schemas\"][\"ProductFee\"] | components[\"schemas\"][\"ProductSeat\"] | components[\"schemas\"][\"ProductDynamic\"] | components[\"schemas\"][\"ProductCredit\"];\n CreateProduct: {\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description.\n * @example Product internal description\n */\n description?: string;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates?: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description?: string;\n /** @description Product name and description translations. */\n translations?: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @default true */\n is_available_on_demand: boolean;\n /** @default true */\n is_available_on_subscription: boolean;\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting?: components[\"schemas\"][\"ProductAccounting\"];\n /** @enum {string} */\n type: \"flat_fee\";\n price_configurations: {\n currency: components[\"schemas\"][\"Currency\"];\n country?: components[\"schemas\"][\"Country\"] & string;\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id?: string;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval?: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /** @enum {string} */\n type: \"fee\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n }[];\n };\n PriceConfiguration: {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"fee\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"volume\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceVolume\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PricePackaged\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBulk\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bps\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBps\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bundle\";\n allow_on_portal: boolean;\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceBulk\"] & {\n /** @enum {string} */\n type: \"bundle\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n })[];\n };\n PlanSimple: {\n /**\n * @description Plan ID.\n * @example plan_zHmjoDea4ZRmQV\n */\n id: string;\n /**\n * @description Plan name.\n * @example Starter\n */\n name: string;\n /**\n * @description Plan description.\n * @example Starter pack\n */\n description: string | null;\n /**\n * @description Interval used to represent the commitment period of the plan.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Strategy used to trigger the start of the subscription contract.\n * @example start_date\n * @enum {string}\n */\n contract_start_strategy: \"start_date\" | \"immediately\" | \"manual\" | \"manual_with_latest\" | \"quote_signature\" | \"checkout\";\n contract_start: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Strategy used to trigger the end of the subscription contract.\n * @example duration\n * @enum {string}\n */\n contract_end_strategy: \"duration\" | \"manual\" | \"end_date\";\n contract_end: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Duration of the initial contract for the created subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n contract_duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\" | \"forever\";\n count: number | null;\n } | null;\n /**\n * @description Indicates if the subscription to the plan should automatically renew.\n * @example true\n */\n renew_automatically: boolean;\n /**\n * @description Interval to renew thr subscription for if `renew_automatically` is enabled.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number | null;\n } | null;\n /**\n * @description Interval used to represent the trial period of the plan.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n trial_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n };\n PaginatedPlan: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Plan. */\n data: components[\"schemas\"][\"PlanSimple\"][];\n };\n Plan: {\n /**\n * @description Plan ID.\n * @example plan_zHmjoDea4ZRmQV\n */\n id: string;\n /**\n * @description Plan name.\n * @example Starter\n */\n name: string;\n /**\n * @description Plan description.\n * @example Starter pack\n */\n description: string | null;\n /**\n * @description Interval used to represent the commitment period of the plan.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Strategy used to trigger the start of the subscription contract.\n * @example start_date\n * @enum {string}\n */\n contract_start_strategy: \"start_date\" | \"immediately\" | \"manual\" | \"manual_with_latest\" | \"quote_signature\" | \"checkout\";\n contract_start: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Strategy used to trigger the end of the subscription contract.\n * @example duration\n * @enum {string}\n */\n contract_end_strategy: \"duration\" | \"manual\" | \"end_date\";\n contract_end: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Duration of the initial contract for the created subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n contract_duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\" | \"forever\";\n count: number | null;\n } | null;\n /**\n * @description Indicates if the subscription to the plan should automatically renew.\n * @example true\n */\n renew_automatically: boolean;\n /**\n * @description Interval to renew thr subscription for if `renew_automatically` is enabled.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number | null;\n } | null;\n /**\n * @description Interval used to represent the trial period of the plan.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n trial_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n products: ({\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"flat_fee\";\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n } | {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"seat\";\n /**\n * @description Name of the unit.\n * @example user\n */\n unit_name: string | null;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"])[];\n } | {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"dynamic\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Minimum of units committed. If usage is less than this number, then this value will be used.\n * @example 2000\n */\n min_committed_count: number | null;\n /** @description 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. */\n min_amount: number | null;\n /** @description 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. */\n max_amount: number | null;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n *\n * @enum {string|null}\n */\n metering_interval_type: \"subscription_commitment\" | \"payment_interval\" | \"full_database\" | \"phase_duration\" | null;\n /** @description 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. */\n bill_usage_difference: boolean;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: ((components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"] | components[\"schemas\"][\"PriceBps\"]) & {\n metering_filter: components[\"schemas\"][\"MeteringFilter\"];\n })[];\n } | {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"credit\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Number of product units.\n * @example 2\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n })[];\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n };\n QuoteFile: {\n /** @description Quote file ID. */\n id: string;\n /** @description Quote file name. */\n name: string;\n /** @description Quote file MIME type. */\n mimetype: string;\n };\n QuoteDraft: {\n /**\n * @description Quote ID.\n * @example quo_hXQCd5y8P3GYXa\n */\n id: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id: string;\n /**\n * @description ID of the quote template.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Quote sequential number.\n * @example 327\n */\n number: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments: string | null;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms: string | null;\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner.\n * @example joe@acme.com\n */\n owner_email: string | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details: boolean;\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids: string[];\n /**\n * @description List of documents attached to the quote.\n * @example [\n * {\n * \"id\": \"quof_5GYXy8P3QCdaXh\",\n * \"name\": \"General Conditions of Sale\",\n * \"mimetype\": \"application/pdf\"\n * }\n * ]\n */\n attachments: components[\"schemas\"][\"QuoteFile\"][];\n signed_file: components[\"schemas\"][\"QuoteFile\"] ;\n /**\n * Format: uri\n * @description URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.\n * @example https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa\n */\n url: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example draft\n * @enum {string}\n */\n status: \"draft\";\n amount: components[\"schemas\"][\"Amount\"] & (number | null);\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n } & ({\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"subscription_update\";\n /**\n * @description 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.\n * @example sub_B6ClkdqNqVNBgY\n */\n subscription_id: string | null;\n /**\n * @description 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.\n * @example [\n * \"sub_0z39oqdhKl0PXb\"\n * ]\n */\n child_subscription_ids: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription: boolean;\n } | {\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example one_off\n * @enum {string}\n */\n type: \"one_off\";\n /**\n * @description 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.\n * @example inv_0ADWB0lzH52RFt\n */\n invoice_id: string | null;\n });\n QuoteComplete: {\n /**\n * @description Quote ID.\n * @example quo_hXQCd5y8P3GYXa\n */\n id: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id: string;\n /**\n * @description ID of the quote template.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Quote sequential number.\n * @example 327\n */\n number: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments: string | null;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms: string | null;\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner.\n * @example joe@acme.com\n */\n owner_email: string | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details: boolean;\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids: string[];\n /**\n * @description List of documents attached to the quote.\n * @example [\n * {\n * \"id\": \"quof_5GYXy8P3QCdaXh\",\n * \"name\": \"General Conditions of Sale\",\n * \"mimetype\": \"application/pdf\"\n * }\n * ]\n */\n attachments: components[\"schemas\"][\"QuoteFile\"][];\n signed_file: components[\"schemas\"][\"QuoteFile\"] ;\n /**\n * Format: uri\n * @description URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.\n * @example https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa\n */\n url: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & unknown;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"subscription_update\";\n /**\n * @description 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.\n * @example sub_B6ClkdqNqVNBgY\n */\n subscription_id: string;\n /**\n * @description 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.\n * @example [\n * \"sub_0z39oqdhKl0PXb\"\n * ]\n */\n child_subscription_ids: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription: boolean;\n } | {\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example one_off\n * @enum {string}\n */\n type: \"one_off\";\n /**\n * @description 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.\n * @example inv_0ADWB0lzH52RFt\n */\n invoice_id: string;\n }) & ({\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example pending_approval\n * @enum {string}\n */\n status: \"pending_approval\" | \"changes_requested\";\n } | {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example pending_signature\n * @enum {string}\n */\n status: \"approved\" | \"pending_signature\";\n approved_at: components[\"schemas\"][\"DateTime\"] & string;\n } | {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example signed\n * @enum {string}\n */\n status: \"signed\";\n approved_at: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Quote signature. Only applies to the `signed` quote.\n * @example {\n * \"mode\": \"basic\",\n * \"signerName\": \"Acme\"\n * }\n */\n signature: {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example basic\n * @enum {string}\n */\n mode: \"basic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example electronic\n * @enum {string}\n */\n mode: \"electronic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example external\n * @enum {string}\n */\n mode: \"external\";\n };\n signed_at: components[\"schemas\"][\"DateTime\"] & string;\n });\n QuoteVoided: {\n /**\n * @description Quote ID.\n * @example quo_hXQCd5y8P3GYXa\n */\n id: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id: string;\n /**\n * @description ID of the quote template.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Quote sequential number.\n * @example 327\n */\n number: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments: string | null;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms: string | null;\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner.\n * @example joe@acme.com\n */\n owner_email: string | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details: boolean;\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids: string[];\n /**\n * @description List of documents attached to the quote.\n * @example [\n * {\n * \"id\": \"quof_5GYXy8P3QCdaXh\",\n * \"name\": \"General Conditions of Sale\",\n * \"mimetype\": \"application/pdf\"\n * }\n * ]\n */\n attachments: components[\"schemas\"][\"QuoteFile\"][];\n signed_file: components[\"schemas\"][\"QuoteFile\"] ;\n /**\n * Format: uri\n * @description URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.\n * @example https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa\n */\n url: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example voided\n * @enum {string}\n */\n status: \"voided\";\n /**\n * @description Quote voiding reason. Only applies to the `voided` quote.\n * @example The customer is ultimately not interested.\n */\n void_reason: string;\n voided_at: components[\"schemas\"][\"DateTime\"] & string;\n amount: components[\"schemas\"][\"Amount\"] & (number | null);\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n approved_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Quote signature. Only applies to the `signed` quote.\n * @example {\n * \"mode\": \"basic\",\n * \"signerName\": \"Acme\"\n * }\n */\n signature: ({\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example basic\n * @enum {string}\n */\n mode: \"basic\";\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example electronic\n * @enum {string}\n */\n mode: \"electronic\";\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example external\n * @enum {string}\n */\n mode: \"external\";\n }) | ({\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example basic\n * @enum {string}\n */\n mode: \"basic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example electronic\n * @enum {string}\n */\n mode: \"electronic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example external\n * @enum {string}\n */\n mode: \"external\";\n }) | null;\n signed_at: components[\"schemas\"][\"DateTime\"] & unknown;\n } & ({\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"subscription_update\";\n /**\n * @description 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.\n * @example sub_B6ClkdqNqVNBgY\n */\n subscription_id: string | null;\n /**\n * @description 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.\n * @example [\n * \"sub_0z39oqdhKl0PXb\"\n * ]\n */\n child_subscription_ids: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription: boolean;\n } | {\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example one_off\n * @enum {string}\n */\n type: \"one_off\";\n /**\n * @description 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.\n * @example inv_0ADWB0lzH52RFt\n */\n invoice_id: string | null;\n });\n Quote: components[\"schemas\"][\"QuoteDraft\"] | components[\"schemas\"][\"QuoteComplete\"] | components[\"schemas\"][\"QuoteVoided\"];\n CreateQuote: {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n *\n * @example draft\n * @enum {string}\n */\n status?: \"draft\" | \"approved\" | \"pending_signature\";\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.\n * @example joe@acme.com\n */\n owner_email?: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id?: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments?: string;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms?: string;\n /**\n * @description Estimated contract value. If not specified, automatically computed from the subscription configuration.\n * @example 20000\n */\n amount?: number | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details?: boolean | (\"true\" | \"false\");\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids?: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription?: boolean | (\"true\" | \"false\");\n } & ({\n /**\n * @description ID of the quote template. If not specified, a subscription configuration must be defined.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string;\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription?: {\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n trial_ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Delay first invoice to the end of the trial period.\n * @default false\n */\n trial_delay_first_invoice: boolean | (\"true\" | \"false\");\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n } | {\n expires_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription: {\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n trial_ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Delay first invoice to the end of the trial period.\n * @default false\n */\n trial_delay_first_invoice: boolean | (\"true\" | \"false\");\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n });\n PaginatedQuote: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Quote. */\n data: components[\"schemas\"][\"Quote\"][];\n };\n SendQuote: {\n /**\n * Format: email\n * @description Email address to which the quote will be sent for signature.\n * @example finance@acme.com\n */\n email: string;\n /**\n * @description Custom message used in the email content.\n * @example Please find attached our proposed quotation.\n */\n message?: string;\n };\n VoidQuote: {\n /**\n * @description Quote voiding reason.\n * @example The customer is ultimately not interested.\n */\n reason: string;\n };\n CreateSubscriptionUpdate: ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n type: \"add_product\" | \"add_item\";\n payload: {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"fee\";\n prices: {\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n }[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"seat\";\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n })[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"dynamic\";\n min_amount?: unknown;\n max_amount?: unknown;\n committed_count?: unknown;\n /** @enum {string|null} */\n usage_interval_type?: \"subscription_commitment\" | \"item_payment_interval\" | \"full_database\" | \"phase_duration\" | \"subscription_duration\" | \"custom\" | null;\n usage_interval_count?: number | null;\n /** @enum {string|null} */\n usage_interval_period?: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\" | null;\n usage_interval_period_start?: string | null;\n only_bill_usage_difference?: boolean | null;\n last_usage_billed?: unknown;\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"add_coupon\";\n payload: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /** @description Coupon expiration date. Only applies to the `custom` coupon frequency. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n expires_at?: string;\n /** @description Coupon first application date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n apply_at?: string;\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids?: string[];\n /**\n * @deprecated\n * @description Deprecated field, please use `product_ids`.\n */\n billing_item_ids?: string[];\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"remove_coupon\";\n payload: {\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n type: \"remove_product\" | \"remove_item\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"update_count\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n count: number;\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"update_prices\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n prices: ({\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n } | {\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"packaged\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n });\n CreateSubscriptionUpdates: {\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n updates: ({\n type: \"add_product\" | \"add_item\";\n payload: {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"fee\";\n prices: {\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n }[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"seat\";\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n })[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"dynamic\";\n min_amount?: unknown;\n max_amount?: unknown;\n committed_count?: unknown;\n /** @enum {string|null} */\n usage_interval_type?: \"subscription_commitment\" | \"item_payment_interval\" | \"full_database\" | \"phase_duration\" | \"subscription_duration\" | \"custom\" | null;\n usage_interval_count?: number | null;\n /** @enum {string|null} */\n usage_interval_period?: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\" | null;\n usage_interval_period_start?: string | null;\n only_bill_usage_difference?: boolean | null;\n last_usage_billed?: unknown;\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n } | {\n type: \"remove_product\" | \"remove_item\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n };\n } | {\n /** @enum {string} */\n type: \"add_coupon\";\n payload: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /** @description Coupon expiration date. Only applies to the `custom` coupon frequency. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n expires_at?: string;\n /** @description Coupon first application date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n apply_at?: string;\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids?: string[];\n /**\n * @deprecated\n * @description Deprecated field, please use `product_ids`.\n */\n billing_item_ids?: string[];\n };\n } | {\n /** @enum {string} */\n type: \"remove_coupon\";\n payload: {\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n };\n } | {\n /** @enum {string} */\n type: \"update_count\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n count: number;\n };\n } | {\n /** @enum {string} */\n type: \"update_prices\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n prices: ({\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n } | {\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"packaged\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n })[];\n };\n Subscription: {\n /**\n * @description Subscription ID.\n * @example sub_B6ClkdqNqVNBgY\n */\n id: string;\n currency: components[\"schemas\"][\"Currency\"];\n /**\n * @description\n * Subscription status.\n *\n * - `draft`: The subscription is being created, this status is only used in the subscription assignation flow of the UI version of Hyperline.\n * - `pending`: The subscription has been created and won't be charged until it is activated.\n * - `active`: The subscription is running and will be invoiced at the next payment date.\n * - `paused`: The subscription's payment collection is paused.\n * - `cancelled`: The subscription has been canceled from an active state.\n * - `voided`: The subscription has been voided directly from the pending state.\n * - `errored`: We attempted 4 times (3 retries) and failed to charge a subscription's invoice, see [Handling payment errors](https://docs.hyperline.co/docs/payments/payment-errors). We consider the subscription as inactive (as the customer failed to pay you) meaning that we won't invoice the customer in the future nor collect payment. You can choose to reactivate it manually.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"cancelled\" | \"draft\" | \"errored\" | \"paused\" | \"pending\" | \"voided\";\n /** @description Reference to the purchase order. */\n purchase_order: string | null;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n plan_id: string | null;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id: string;\n /** @description ID of the checkout session. */\n checkout_session_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee: number | null;\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the subscription should automatically renew.\n * @example true\n */\n renew_automatically: boolean;\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Strategy used to activate the subscription.\n *\n * - `start_date`: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.\n * - `manually`: The subscription requires activation through a manual action.\n * - `checkout`: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.\n * - `quote`: The subscription will be activated depending on the configuration and the signature of the related quote.\n *\n * @example checkout\n * @enum {string|null}\n */\n activation_strategy: \"start_date\" | \"manually\" | \"checkout\" | \"quote\" | \"contract_start_date\" | null;\n starts_at: components[\"schemas\"][\"DateTime\"] & string;\n contract_start: components[\"schemas\"][\"DateTime\"] & string;\n contract_end: components[\"schemas\"][\"DateTime\"] & unknown;\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n paused_at: components[\"schemas\"][\"DateTime\"] & unknown;\n reactivate_at: components[\"schemas\"][\"DateTime\"] & unknown;\n cancel_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string|null}\n */\n cancellation_strategy: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\" | null;\n cancellation_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n estimated_arr: components[\"schemas\"][\"Amount\"] & (number | null);\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n renews_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description ID of the current subscription phase. */\n current_phase_id: string | null;\n trial_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n SubscriptionProductFee: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"flat_fee\";\n /**\n * @description Number of product units.\n * @example 1\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n };\n SubscriptionProductCredit: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"credit\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Number of product units.\n * @example 2\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n };\n SubscriptionProductSeat: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"seat\";\n /**\n * @description Name of the unit.\n * @example user\n */\n unit_name: string | null;\n /**\n * @description Number of product units.\n * @example 2\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"])[];\n };\n SubscriptionProductDynamic: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"dynamic\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Minimum of units committed. If usage is less than this number, then this value will be used.\n * @example 2000\n */\n min_committed_count: number | null;\n /** @description 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. */\n min_amount: number | null;\n /** @description 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. */\n max_amount: number | null;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n *\n * @enum {string|null}\n */\n metering_interval_type: \"subscription_commitment\" | \"payment_interval\" | \"full_database\" | \"phase_duration\" | null;\n /** @description 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. */\n bill_usage_difference: boolean;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: ((components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"] | components[\"schemas\"][\"PriceBps\"]) & {\n metering_filter: components[\"schemas\"][\"MeteringFilter\"];\n })[];\n };\n /** @description Checkout session of the subscription. */\n CheckoutSession: {\n /**\n * @description Checkout session ID.\n * @example che_hEUPdVG7IgjpW1\n */\n id: string;\n /**\n * @description Checkout session current status.\n * @example opened\n * @enum {string}\n */\n status: \"opened\" | \"completed\" | \"cancelled\" | \"errored\";\n /**\n * @description Types of payment method available on the checkout session.\n * @example [\n * \"card\"\n * ]\n */\n available_payment_methods: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * Format: uri\n * @description URL to which the user is automatically redirected after the completion of the checkout.\n * @example https://app.hyperline.co/callback/checkout\n */\n redirect_url: string | null;\n send_to: {\n /**\n * Format: email\n * @description Email address to which we'll automatically send a message with the checkout link.\n * @example josh@alpeak.com\n */\n email: string;\n /** @description Custom message to include in the email send. If not provided, we will use a generic one. */\n message: string | null;\n } | null;\n /**\n * Format: uri\n * @description URL to access the checkout session. Only defined if the status is `opened`.\n * @example https://billing.hyperline.co/checkout/che_hEUPdVG7IgjpW1\n */\n url: string;\n } | null;\n SubscriptionDetails: components[\"schemas\"][\"Subscription\"] & {\n /** @description Products that make up the subscription. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons to be applied to the prices of subscription products. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n /** @description Phases of the subscription. */\n phases: {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n }[];\n quote: {\n /**\n * @description ID of the quote from which the subscription was created.\n * @example quo_38YwqvItBH3d8a\n */\n id: string;\n /**\n * @description Status of the quote from which the subscription was created.\n * @example signed\n * @enum {string}\n */\n status: \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"voided\" | \"signed\";\n } | null;\n plan: {\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n id: string;\n /**\n * @description Name of the plan used to create the subscription.\n * @example My example plan\n */\n name: string;\n } | null;\n checkout_session: components[\"schemas\"][\"CheckoutSession\"];\n /**\n * @description Payment method type used to pay the subscription.\n * @enum {string|null}\n */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n payment_method: components[\"schemas\"][\"PaymentMethod\"] & unknown;\n /** @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent */\n generate_draft_invoices: boolean;\n };\n CancelSubscription: {\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Indicates if the cancel should refund the customer using a pro rata strategy. */\n pro_rata?: boolean;\n };\n CreateSubscription: {\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n trial_ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Delay first invoice to the end of the trial period.\n * @default false\n */\n trial_delay_first_invoice: boolean | (\"true\" | \"false\");\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & ({\n /**\n * @description\n * Strategy used to activate the subscription.\n *\n * - `start_date`: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.\n * - `manually`: The subscription requires activation through a manual action.\n * - `checkout`: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.\n * - `quote`: The subscription will be activated depending on the configuration and the signature of the related quote.\n *\n * @example checkout\n * @enum {string}\n */\n activation_strategy: \"start_date\" | \"manually\" | \"checkout\";\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n } | {\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n }) & {\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n plan_id?: string;\n /**\n * @description\n * Payment method strategy used to bill the subscription. By default, the current payment method of the customer will be used.\n *\n * - `new`: Ask the customer for a new payment method. The customer can fill in their payment method either on the subscription's checkout session or on their portal page.\n * - `current`: Use the current default payment method of the customer.\n * - `external`: Manage the payments of the subscription outside of Hyperline.\n *\n * @example current\n * @enum {string}\n */\n payment_method_strategy?: \"current\" | \"external\" | \"new\";\n /** @description Set the allowed types of payment methods for the customer. Only applies to the `new` payment method strategy. */\n available_payment_method_types?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /** @description [On demand] Will split the subscription into 2 phases, one will contain 'once' products and the other the recurring ones. Call `next-phase` endpoint to transition between the 2 phases. */\n create_setup_phase?: boolean | (\"true\" | \"false\");\n checkout_session?: {\n send_to?: {\n /**\n * Format: email\n * @description Email address to which we'll automatically send a message with the checkout link.\n */\n email: string;\n /** @description Custom message to include in the email send. If not provided, we will use a generic one. */\n message?: string;\n };\n /**\n * Format: uri\n * @description URL to which the user is automatically redirected after the completion of the checkout.\n */\n redirect_url?: string;\n };\n };\n PaginatedSubscription: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Subscription. */\n data: components[\"schemas\"][\"Subscription\"][];\n };\n LiveBilling: {\n total_amount: number;\n total_discount: number;\n fixed_amount: number;\n billing_items: {\n id: string | null;\n total_amount: number;\n original_amount: number;\n discount_amount: number | null;\n item_name: string;\n tiers: {\n from: number;\n to: number | null;\n amount: number;\n total_amount: number;\n count: number;\n }[];\n }[];\n coupons: {\n id: string | null;\n name: string | null;\n discount_amount: number;\n item_ids: string[];\n }[];\n };\n PaginatedSubscriptionPhase: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of SubscriptionPhase. */\n data: {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n }[];\n };\n TaxRate: {\n /**\n * @description Tax rate ID.\n * @example taxr_YfiSnLIYORD9VN\n */\n id: string;\n /**\n * @description Name of the tax rate.\n * @example VAT\n */\n name: string;\n /**\n * @description Internal description of the tax rate.\n * @example Standard VAT\n */\n description: string | null;\n /**\n * @description Tax rate code identifier.\n * @example STAND_VAT\n */\n code: string;\n /**\n * @description The percentage rate of the tax.\n * @example 20\n */\n rate: number;\n /**\n * @description ID of the invoicing entity to which the tax rate is attached.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id: string;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedTaxRate: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of TaxRate. */\n data: components[\"schemas\"][\"TaxRate\"][];\n };\n App: {\n /** @description App ID */\n id: string;\n /** @description App name */\n name: string;\n /** @description App description */\n description: string | null;\n /** @description App logo URL */\n logo_uri: string | null;\n /** @description List of URLs whitelisted to use as a callback after authentication. */\n callbacks: string[];\n /** @description OAuth client ID */\n client_id: string;\n };\n CreateApp: {\n /** @description App name */\n name: string;\n /** @description App description */\n description?: string;\n /**\n * Format: uri\n * @description App logo URL\n */\n logo_uri?: string;\n /** @description List of URLs whitelisted to use as a callback after authentication. */\n callbacks: string[];\n };\n UpdateApp: {\n /** @description App name */\n name: string;\n /** @description App description */\n description: string | null;\n /**\n * Format: uri\n * @description App logo URL\n */\n logo_uri: string | null;\n /** @description List of URLs whitelisted to use as a callback after authentication. */\n callbacks: string[];\n };\n WalletSettings: {\n /**\n * @description Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in `active` state and with money.\n * @example true\n */\n enabled: boolean;\n /**\n * @description Allow top up for free amounts on wallets.\n * @example true\n */\n allow_free_credits: boolean;\n /**\n * @description Allow wallet top up on customer's portal.\n * @example false\n */\n allow_topup_on_portal: boolean;\n /**\n * @description Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.\n * @example []\n */\n product_ids: string[];\n updated_at: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n UpdateWalletSettings: {\n /**\n * @description Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in `active` state and with money.\n * @example true\n */\n enabled?: boolean;\n /**\n * @description Allow top up for free amounts on wallets.\n * @example true\n */\n allow_free_credits?: boolean;\n /**\n * @description Allow wallet top up on customer's portal.\n * @example false\n */\n allow_topup_on_portal?: boolean;\n /**\n * @description Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.\n * @example []\n */\n product_ids?: string[];\n };\n Wallet: {\n /**\n * @description Wallet ID.\n * @example wal_PPpxP5d3uvgiTT\n */\n id: string;\n /**\n * @description Wallet customer ID.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description Wallet state.\n * @example active\n * @enum {string}\n */\n state: \"active\" | \"paused\";\n currency: components[\"schemas\"][\"Currency\"];\n /** @description Wallet actual balance. Expressed in currency's smallest unit. */\n balance: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n };\n /** @description Wallet projected balance. Automatically computed by Hyperline depending on the customer's active subscriptions and future payments. Expressed in currency's smallest unit. */\n projected_balance: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n };\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example true\n * @enum {boolean}\n */\n is_auto_load_enabled: true;\n /**\n * @description Indicates if the auto-load is free or paid.\n * @example paid\n * @enum {string}\n */\n auto_load_type: \"free\" | \"paid\";\n auto_load_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Interval indicating how often the wallet is auto-loaded.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n auto_load_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n auto_load_next_date: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Indicates if the wallet amount must be reset before auto-load.\n * @example false\n */\n auto_load_reset: boolean;\n } | {\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example false\n * @enum {boolean}\n */\n is_auto_load_enabled: false;\n });\n CreateWallet: {\n /**\n * @description Wallet customer ID.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n } & ({\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example true\n * @enum {boolean}\n */\n is_auto_load_enabled: true;\n /**\n * @description Indicates if the auto-load is free or paid.\n * @example paid\n * @enum {string}\n */\n auto_load_type: \"free\" | \"paid\";\n auto_load_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Interval indicating how often the wallet is auto-loaded.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n auto_load_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n auto_load_next_date: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Indicates if the wallet amount must be reset before auto-load.\n * @example false\n */\n auto_load_reset: boolean;\n } | {\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example false\n * @enum {boolean}\n */\n is_auto_load_enabled?: false;\n });\n UpdateWallet: {\n /**\n * @description Wallet state.\n * @example active\n * @enum {string}\n */\n state?: \"active\" | \"paused\";\n } & ({\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example true\n * @enum {boolean}\n */\n is_auto_load_enabled: true;\n /**\n * @description Indicates if the auto-load is free or paid.\n * @example paid\n * @enum {string}\n */\n auto_load_type: \"free\" | \"paid\";\n auto_load_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Interval indicating how often the wallet is auto-loaded.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n auto_load_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n auto_load_next_date: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Indicates if the wallet amount must be reset before auto-load.\n * @example false\n */\n auto_load_reset: boolean;\n } | {\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example false\n * @enum {boolean}\n */\n is_auto_load_enabled?: false;\n });\n LoadWallet: {\n amount?: components[\"schemas\"][\"Amount\"] & unknown;\n amount_free?: components[\"schemas\"][\"Amount\"] & unknown;\n };\n WalletTransaction: {\n /**\n * @description Wallet transaction ID.\n * @example walt_FCihRDLYhKpSpL\n */\n id: string;\n /**\n * @description Wallet transaction type.\n * @example credit_paid\n * @enum {string}\n */\n type: \"credit_free\" | \"credit_paid\" | \"debit\";\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Generated invoice ID for the transaction. Only applies for `credit_paid` and `debit`. */\n invoice_id: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedWalletTransaction: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of WalletTransaction. */\n data: components[\"schemas\"][\"WalletTransaction\"][];\n };\n WebhookEndpoint: {\n /**\n * @description Webhook endpoint ID.\n * @example ep_1srOrx2ZWZBpBUvZwXKQmoEYga2\n */\n id: string;\n /**\n * @description Webhook endpoint description.\n * @example Production webhook endpoint\n */\n description: string;\n /**\n * Format: uri\n * @description Webhook endpoint URL.\n * @example https://example.com/webhook\n */\n url: string;\n /** @description Webhook rate limit (per second). */\n rate_limit: number | null;\n /**\n * @description Webhook event types filter. If not defined, all event messages will be sent.\n * @example [\n * \"customer.created\",\n * \"customer.updated\"\n * ]\n */\n event_types: (\"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\")[] | null;\n /**\n * Format: date-time\n * @description Webhook creation date.\n * @example 2024-01-20T16:04:11Z\n */\n created_at: string;\n };\n PaginatedWebhookEndpoint: {\n meta: {\n iterator: string | null;\n };\n data: components[\"schemas\"][\"WebhookEndpoint\"][];\n };\n WebhookMessage: {\n /**\n * @description Webhook message ID.\n * @example msg_1srOrx2ZWZBpBUvZwXKQmoEYga2\n */\n id: string;\n /**\n * @description Unique ID corresponding to the event occurrence in the Hyperline system.\n * @example evt_9avP4zLks7L1yh\n */\n event_id: string;\n /** @description Webhook message payload. */\n payload: {\n /**\n * @description Event type.\n * @enum {string}\n */\n event_type: \"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\";\n /** @description Depends on the type of event, see the [event catalog](https://app.hyperline.co/app/settings/webhooks) for more details. */\n data: Record<string, never>;\n } | \"EXPUNGED\";\n /**\n * Format: date-time\n * @description Date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-01-20T16:04:11Z\n */\n sent_at: string;\n };\n PaginatedWebhookMessage: {\n meta: {\n iterator: string | null;\n };\n data: components[\"schemas\"][\"WebhookMessage\"][];\n };\n };\n responses: never;\n parameters: never;\n requestBodies: never;\n headers: never;\n pathItems: never;\n}\nexport type $defs = Record<string, never>;\nexport interface operations {\n getInvoices: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n id?: string;\n id__not?: string;\n id__isNull?: string;\n id__isNotNull?: string;\n id__equals?: string;\n id__contains?: string;\n id__startsWith?: string;\n id__endWith?: string;\n customerId?: string;\n customerId__not?: string;\n customerId__isNull?: string;\n customerId__isNotNull?: string;\n customerId__equals?: string;\n customerId__contains?: string;\n customerId__startsWith?: string;\n customerId__endWith?: string;\n customerName?: string;\n customerName__not?: string;\n customerName__isNull?: string;\n customerName__isNotNull?: string;\n customerName__equals?: string;\n customerName__contains?: string;\n customerName__startsWith?: string;\n customerName__endWith?: string;\n invoiceNumber?: string;\n invoiceNumber__not?: string;\n invoiceNumber__isNull?: string;\n invoiceNumber__isNotNull?: string;\n invoiceNumber__equals?: string;\n invoiceNumber__contains?: string;\n invoiceNumber__startsWith?: string;\n invoiceNumber__endWith?: string;\n dueDate?: string;\n dueDate__not?: string;\n dueDate__isNull?: string;\n dueDate__isNotNull?: string;\n dueDate__equals?: string;\n dueDate__lt?: string;\n dueDate__lte?: string;\n dueDate__gt?: string;\n dueDate__gte?: string;\n emissionDate?: string;\n emissionDate__not?: string;\n emissionDate__isNull?: string;\n emissionDate__isNotNull?: string;\n emissionDate__equals?: string;\n emissionDate__lt?: string;\n emissionDate__lte?: string;\n emissionDate__gt?: string;\n emissionDate__gte?: string;\n periodStart?: string;\n periodStart__not?: string;\n periodStart__isNull?: string;\n periodStart__isNotNull?: string;\n periodStart__equals?: string;\n periodStart__lt?: string;\n periodStart__lte?: string;\n periodStart__gt?: string;\n periodStart__gte?: string;\n periodEnd?: string;\n periodEnd__not?: string;\n periodEnd__isNull?: string;\n periodEnd__isNotNull?: string;\n periodEnd__equals?: string;\n periodEnd__lt?: string;\n periodEnd__lte?: string;\n periodEnd__gt?: string;\n periodEnd__gte?: string;\n updatedAt?: string;\n updatedAt__not?: string;\n updatedAt__isNull?: string;\n updatedAt__isNotNull?: string;\n updatedAt__equals?: string;\n updatedAt__lt?: string;\n updatedAt__lte?: string;\n updatedAt__gt?: string;\n updatedAt__gte?: string;\n settledAt?: string;\n settledAt__not?: string;\n settledAt__isNull?: string;\n settledAt__isNotNull?: string;\n settledAt__equals?: string;\n settledAt__lt?: string;\n settledAt__lte?: string;\n settledAt__gt?: string;\n settledAt__gte?: string;\n subscriptionId?: string;\n subscriptionId__not?: string;\n subscriptionId__isNull?: string;\n subscriptionId__isNotNull?: string;\n subscriptionId__equals?: string;\n subscriptionId__contains?: string;\n subscriptionId__startsWith?: string;\n subscriptionId__endWith?: string;\n invoicingEntityId?: string;\n invoicingEntityId__not?: string;\n invoicingEntityId__isNull?: string;\n invoicingEntityId__isNotNull?: string;\n invoicingEntityId__equals?: string;\n invoicingEntityId__contains?: string;\n invoicingEntityId__startsWith?: string;\n invoicingEntityId__endWith?: string;\n status?: (\"all\" | \"open\" | \"grace_period\" | \"to_pay\" | \"to_reconcile\" | \"error\" | \"paid\" | \"partially_paid\" | \"outstanding\" | \"refunded\" | \"document\" | \"late\" | \"draft\" | \"voided\" | \"closed\") | string;\n status__in?: (\"all\" | \"open\" | \"grace_period\" | \"to_pay\" | \"to_reconcile\" | \"error\" | \"paid\" | \"partially_paid\" | \"outstanding\" | \"refunded\" | \"document\" | \"late\" | \"draft\" | \"voided\" | \"closed\") | string;\n type?: (\"invoice\" | \"refund\" | \"document\") | string;\n type__in?: (\"invoice\" | \"refund\" | \"document\") | string;\n paymentMethod?: (\"card\" | \"transfer\" | \"external\" | \"missing\" | \"direct_debit\" | \"direct_debit_sepa\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"wallet\") | string;\n paymentMethod__in?: (\"card\" | \"transfer\" | \"external\" | \"missing\" | \"direct_debit\" | \"direct_debit_sepa\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"wallet\") | string;\n search?: string;\n category?: (\"refund\" | \"subscription\" | \"otp\") | string;\n category__in?: (\"refund\" | \"subscription\" | \"otp\") | string;\n customer_external_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedInvoice\"];\n };\n };\n };\n };\n createInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create invoice payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateInvoice\"];\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n createInvoices: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create invoices payload */\n requestBody?: {\n content: {\n \"application/json\": (components[\"schemas\"][\"CreateInvoice\"] & {\n /**\n * @description A unique identifier for the invoices in the batch\n * @example invoice-123\n */\n batch_invoice_id: string;\n })[];\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n successes: (components[\"schemas\"][\"Invoice\"] & {\n transactions: ({\n /**\n * @description Transaction ID.\n * @example tra_2QdJDDUej969ev\n */\n id: string;\n /**\n * @description\n * Transaction type.\n *\n * - `subscription`: The transaction is related to a subscription payment.\n * - `one_time`: The transaction is related to a one-time payment.\n * - `refund`: The transaction is related to a refund payment.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"one_time\" | \"refund\";\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description ID of the customer linked to the transaction.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the transaction on the payment provider (Stripe, Mollie, GoCardless, ...) side.\n * @example pi_xxxxxxxxxx\n */\n provider_id: string | null;\n process_at: components[\"schemas\"][\"DateTime\"] & string;\n refunded_at: components[\"schemas\"][\"DateTime\"] & unknown;\n last_refreshed_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Fee applied by the Payment Service Provider. Only supported for Stripe. */\n provider_fee: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n exchange_rate: number | null;\n } | null;\n /** @description Chargeback details related to the transaction. */\n chargeback: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n last_chargeback_at: components[\"schemas\"][\"DateTime\"] & string;\n } | null;\n } & ({\n /** @enum {string} */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\";\n payment_method: components[\"schemas\"][\"PaymentMethod\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"transfer\" | \"transfer_automated\";\n bank_account: components[\"schemas\"][\"BankAccount\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"wallet\";\n /** @example wal_PPpxP5d3uvgiTT */\n wallet_id: string;\n } | {\n /** @enum {string} */\n payment_method_type: \"external\";\n }) & ({\n /**\n * @description\n * Transaction status.\n *\n * - `scheduled`: The transaction is scheduled to be processed in the future.\n * - `to_process`: The transaction is waiting to be processed by our system.\n * - `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n * - `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n * - `cancelled`: The transaction has been cancelled and won't be processed again.\n *\n * @example settled\n * @enum {string}\n */\n status: \"scheduled\" | \"to_process\" | \"pending\" | \"settled\" | \"cancelled\";\n } | {\n /**\n * @description\n * Transaction status.\n *\n * - `failed`: The transaction failed.\n *\n * @example failed\n * @enum {string}\n */\n status: \"failed\";\n /**\n * @description\n * Transaction error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n * - `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n * - `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @enum {string|null}\n */\n error_type: \"authentication_required\" | \"declined\" | \"fraud\" | \"payment_method_authorization_error\" | \"payment_method_declined\" | \"payment_method_expired\" | \"payment_method_invalid\" | \"payment_method_not_supported\" | \"processing_error\" | \"provider_error\" | \"unknown\" | null;\n /** @description Details of the error. */\n error_message: string | null;\n }))[];\n coupons: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n discount_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n /** @description Percentage to apply as a discount on the amount (excluding taxes) of a product. */\n discount_percent: number | null;\n /**\n * @description IDs of the line items to which the coupon applies.\n * @example [\n * \"ili_0FACNpeoEFkGu3\"\n * ]\n */\n line_item_ids: string[];\n }[];\n } & {\n /**\n * @description A unique identifier for the invoices in the batch\n * @example invoice-123\n */\n batch_invoice_id: string;\n })[];\n errors: {\n error?: unknown;\n batch_invoice_id: string;\n }[];\n };\n };\n };\n };\n };\n validateInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n chargeInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Payment method used to execute the payment. This payment method will override any previously set method on the invoice.\n * @example pm_1xMpj5bwRqN7LM\n */\n payment_method_id?: string;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n voidInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Indicates if an email for the generated credit note should be sent to the customer.\n * @default true\n */\n send_email?: boolean;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n getInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n updateInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update invoice payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateInvoice\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n uploadPdfToInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"multipart/form-data\": {\n file: components[\"schemas\"][\"File\"];\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": Record<string, never>;\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n downloadInvoice: {\n parameters: {\n query?: {\n lang?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n locale?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Download an invoice PDF file */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/pdf\": unknown;\n };\n };\n /** @description Invoice or file not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n createInvoiceTransaction: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Create invoice transaction payload */\n requestBody?: {\n content: {\n \"application/json\": {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n process_at: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description Payment method used to execute the transaction. Only applies to scheduled transactions with a process_at date in the future.\n * @example pm_1xMpj5bwRqN7LM\n */\n payment_method_id: string;\n } | {\n /** @enum {string} */\n payment_method_type: \"transfer\";\n /**\n * @description Bank account linked to the transaction.\n * @example bac_KJyPrMA1toAqRG\n */\n bank_account_id?: string;\n } | {\n /** @enum {string} */\n payment_method_type?: \"external\";\n });\n };\n };\n responses: {\n /** @description The invoice with the newly created transaction */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteInvoiceTransaction: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n transactionId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getAnalytics: {\n parameters: {\n query?: {\n invoicing_entity_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n revenue_last_30_days: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Churn of the last 30 days. Churn corresponds to the number of customers who churned divided by the number of active customers. A churned customer is one who had a subscription but no longer has an active one. */\n churn_30_days: number;\n churned_revenue_30_days: components[\"schemas\"][\"Amount\"] & unknown;\n arr: components[\"schemas\"][\"Amount\"] & unknown;\n mrr: components[\"schemas\"][\"Amount\"] & unknown;\n pending_arr: components[\"schemas\"][\"Amount\"] & unknown;\n active_arr: components[\"schemas\"][\"Amount\"] & unknown;\n arr_in_discounts: components[\"schemas\"][\"Amount\"] & unknown;\n fixed_arr: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of customers with an assigned subscriptions. */\n active_customers: number;\n /** @description Average Revenue Per Account (customer). */\n arpa: number;\n };\n };\n };\n };\n };\n getCompanies: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCompany\"];\n };\n };\n };\n };\n createCompany: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Company name.\n * @example Acme\n */\n name: string;\n address: components[\"schemas\"][\"Address\"] ;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Company ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Company name.\n * @example Acme\n */\n name: string;\n /** @description Logo URL of the default invoicing entity. */\n logo_url: string | null;\n /** @description Favicon URL of the default invoicing entity. */\n favicon_url: string | null;\n address: components[\"schemas\"][\"Address\"] ;\n };\n };\n };\n };\n };\n getCoupons: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCoupon\"];\n };\n };\n };\n };\n createCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create coupon payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCoupon\"];\n };\n };\n responses: {\n /** @description The newly created coupon */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Coupon\"];\n };\n };\n };\n };\n getCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Coupon\"] & {\n deletedAt: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n };\n };\n /** @description Coupon not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateCoupon\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Coupon\"];\n };\n };\n /** @description Coupon not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer deleted */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n /** @description Coupon not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getCustomProperties: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCustomProperty\"];\n };\n };\n };\n };\n createCustomProperty: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n name: string;\n /** @enum {string} */\n type: \"date\" | \"boolean\" | \"number\" | \"text\" | \"select\";\n slug: string;\n entities: (\"customer\" | \"product\" | \"plan\" | \"quote\" | \"subscription\")[];\n /** @default false */\n api_only?: boolean | null;\n authorized_values?: string[] | null;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomProperty\"];\n };\n };\n };\n };\n updateCustomProperty: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n name: string;\n /** @enum {string} */\n type: \"date\" | \"boolean\" | \"number\" | \"text\" | \"select\";\n slug: string;\n entities: (\"customer\" | \"product\" | \"plan\" | \"quote\" | \"subscription\")[];\n /** @default false */\n api_only?: boolean | null;\n authorized_values?: string[] | null;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomProperty\"];\n };\n };\n };\n };\n deleteCustomProperty: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n listCustomerCredits: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCredit\"];\n };\n };\n };\n };\n createCreditForProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Create credit payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCredit\"];\n };\n };\n responses: {\n /** @description Credit created */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Credit\"];\n };\n };\n };\n };\n getOneCreditForCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Credit\"];\n };\n };\n };\n };\n listCreditTransactionsForCustomer: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n id?: string | null;\n type?: string | null;\n invoice_id?: string | null;\n created_at?: string | null;\n };\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCreditTransaction\"];\n };\n };\n };\n };\n purchaseCredits: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n /** @description Credit purchase payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCreditPurchase\"];\n };\n };\n responses: {\n /** @description Invoice ID and balance after purchase */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n invoice_id: string;\n new_credit_balance: number;\n };\n };\n };\n };\n };\n usageCredits: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n /** @description Credit topup payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCreditTopup\"];\n };\n };\n responses: {\n /** @description The created credit transaction */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CreditTransaction\"];\n };\n };\n };\n };\n createUsageEntry: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n /** @description Credit usage entry payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCreditUsage\"];\n };\n };\n responses: {\n /** @description The created credit transaction */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CreditTransaction\"];\n };\n };\n };\n };\n getCustomers: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n id?: string;\n id__not?: string;\n id__isNull?: string;\n id__isNotNull?: string;\n id__equals?: string;\n id__contains?: string;\n id__startsWith?: string;\n id__endWith?: string;\n name?: string;\n name__not?: string;\n name__isNull?: string;\n name__isNotNull?: string;\n name__equals?: string;\n name__contains?: string;\n name__startsWith?: string;\n name__endWith?: string;\n type?: string;\n type__not?: string;\n type__isNull?: string;\n type__isNotNull?: string;\n type__equals?: string;\n type__contains?: string;\n type__startsWith?: string;\n type__endWith?: string;\n status?: (\"all\" | \"active\" | \"inactive\" | \"imported\" | \"archived\") | string;\n status__in?: (\"all\" | \"active\" | \"inactive\" | \"imported\" | \"archived\") | string;\n currency?: string;\n currency__not?: string;\n currency__isNull?: string;\n currency__isNotNull?: string;\n currency__equals?: string;\n currency__contains?: string;\n currency__startsWith?: string;\n currency__endWith?: string;\n country?: string;\n country__not?: string;\n country__isNull?: string;\n country__isNotNull?: string;\n country__equals?: string;\n country__contains?: string;\n country__startsWith?: string;\n country__endWith?: string;\n vat_number?: string;\n vat_number__not?: string;\n vat_number__isNull?: string;\n vat_number__isNotNull?: string;\n vat_number__equals?: string;\n vat_number__contains?: string;\n vat_number__startsWith?: string;\n vat_number__endWith?: string;\n external_id?: string;\n external_id__not?: string;\n external_id__isNull?: string;\n external_id__isNotNull?: string;\n external_id__equals?: string;\n external_id__contains?: string;\n external_id__startsWith?: string;\n external_id__endWith?: string;\n billing_email?: string;\n billing_email__not?: string;\n billing_email__isNull?: string;\n billing_email__isNotNull?: string;\n billing_email__equals?: string;\n billing_email__contains?: string;\n billing_email__startsWith?: string;\n billing_email__endWith?: string;\n search?: string;\n subscription_status?: (\"active\" | \"pending\" | \"cancelled\" | \"paused\" | \"trialing\" | \"errored\" | \"draft\" | \"none\") | string;\n subscription_status__in?: (\"active\" | \"pending\" | \"cancelled\" | \"paused\" | \"trialing\" | \"errored\" | \"draft\" | \"none\") | string;\n invoicing_entity_id?: string;\n invoicing_entity_id__not?: string;\n invoicing_entity_id__isNull?: string;\n invoicing_entity_id__isNotNull?: string;\n invoicing_entity_id__equals?: string;\n invoicing_entity_id__contains?: string;\n invoicing_entity_id__startsWith?: string;\n invoicing_entity_id__endWith?: string;\n custom_properties?: string;\n created_at?: string;\n created_at__not?: string;\n created_at__isNull?: string;\n created_at__isNotNull?: string;\n created_at__equals?: string;\n created_at__lt?: string;\n created_at__lte?: string;\n created_at__gt?: string;\n created_at__gte?: string;\n updated_at?: string;\n updated_at__not?: string;\n updated_at__isNull?: string;\n updated_at__isNotNull?: string;\n updated_at__equals?: string;\n updated_at__lt?: string;\n updated_at__lte?: string;\n updated_at__gt?: string;\n updated_at__gte?: string;\n payment_method_type?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"external\" | \"missing\") | string;\n payment_method_type__in?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"external\" | \"missing\") | string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCustomer\"];\n };\n };\n };\n };\n createCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create customer payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCustomer\"];\n };\n };\n responses: {\n /** @description The newly created customer */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomerDetails\"];\n };\n };\n };\n };\n getCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomerDetails\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateCustomer\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomerDetails\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer deleted */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getCustomerPortalUrl: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n url: string;\n };\n };\n };\n };\n };\n archiveCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer archived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Customer\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n unarchiveCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer unarchived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Customer\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n bulkUpdateCustomersProviders: {\n parameters: {\n query?: {\n sync?: boolean | (\"true\" | \"false\");\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Customer ID.\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @description Provider name.\n * @enum {string}\n */\n provider_name: \"mollie\" | \"stripe\" | \"gocardless\" | \"airwallex\" | \"hubspot\" | \"salesforce\";\n /** @description Provider ID. Required if multiple instances of the same provider are connected in Hyperline. */\n provider_id?: string;\n /** @description ID of the customer on the provider side. Using a null value will reset the previously saved ID. */\n provider_account_id: string | null;\n }[];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /** @description Number of record successfully updated. */\n successful: number;\n /** @description Number of record expected to be updated. */\n expected: number;\n /** @description Customer IDs that were successfully updated. */\n updated: string[];\n };\n };\n };\n };\n };\n getCustomerTaxRates: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Tax rate scheme.\n *\n * - `exempt`: The customer is exempt from tax.\n * - `standard`: The customer is subject to standard tax.\n * - `reverse_charge`: The customer is subject to reverse charge tax.\n * - `manual`: The customer tax rate is manually set.\n * - `not_eligible`: The customer is not eligible for tax.\n *\n * @enum {string}\n */\n scheme: \"exempt\" | \"standard\" | \"reverse_charge\" | \"manual\" | \"not_eligible\";\n /** @description Tax rate percentage. */\n rate: number;\n }[];\n };\n };\n };\n };\n getOrganisation: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Organisation\"];\n };\n };\n /** @description Organisation not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n patchOrganisation: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"PatchOrganisation\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Organisation\"];\n };\n };\n /** @description Organisation not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n listCustomerPaymentMethods: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedPaymentMethod\"];\n };\n };\n };\n };\n getCustomerPaymentMethod: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n paymentMethodId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaymentMethod\"] & (components[\"schemas\"][\"PaymentMethodCard\"] | components[\"schemas\"][\"PaymentMethodDirectDebit\"]);\n };\n };\n };\n };\n deleteCustomerPaymentMethod: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n paymentMethodId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n createComponentToken: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create component token payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateComponentToken\"];\n };\n };\n responses: {\n /** @description The newly created token */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n token: string;\n /** @enum {string} */\n token_type: \"bearer\";\n };\n };\n };\n };\n };\n getInvoicingEntities: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedInvoicingEntity\"];\n };\n };\n };\n };\n createInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default?: boolean;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone?: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id?: string | null;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email?: string | null;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1?: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2?: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code?: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state?: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city?: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n accounting_currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern?: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern?: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern?: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number?: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number?: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number?: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay?: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration?: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay?: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay?: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees?: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer?: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer?: string | null;\n /**\n * @description The footer text to be used in quotes.\n * @example Thank you for your business.\n */\n quote_footer?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url?: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color?: string | null;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n };\n };\n };\n };\n };\n getInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n };\n };\n };\n };\n };\n updateInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name?: string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id?: string | null;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email?: string | null;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone?: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default?: boolean;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1?: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2?: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code?: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state?: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city?: string | null;\n country?: components[\"schemas\"][\"Country\"] & string;\n currency?: components[\"schemas\"][\"Currency\"] & unknown;\n accounting_currency?: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern?: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern?: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern?: string;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay?: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration?: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay?: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay?: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees?: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer?: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url?: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color?: string | null;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n };\n };\n };\n };\n };\n deleteInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n getUserInfo: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description User given name.\n * @example John\n */\n given_name: string | null;\n /**\n * @description User family name.\n * @example Doe\n */\n family_name: string | null;\n /**\n * @description User full name.\n * @example John Doe\n */\n name: string | null;\n /**\n * Format: uri\n * @description User picture URL.\n * @example https://...\n */\n picture: string | null;\n /**\n * Format: email\n * @description User email.\n * @example john@doe.com\n */\n email: string;\n /**\n * @description Indicates if the user email is verified.\n * @example true\n */\n email_verified: boolean;\n };\n };\n };\n };\n };\n authorize: {\n parameters: {\n query: {\n client_id: string;\n audience?: string;\n scope?: string;\n response_type: \"code\";\n redirect_uri: string;\n state: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 302: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n generateTokens: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /** @description Application's client ID. */\n client_id: string;\n /** @description Application's client secret. */\n client_secret: string;\n } & ({\n /**\n * @description To exchange an auth code for an app access token, use `authorization_code`.\n * @enum {string}\n */\n grant_type: \"authorization_code\";\n /** @description The auth code received when creating the authorization. */\n code: string;\n /** @description Must match the value set at the `GET /authorize` endpoint. */\n redirect_uri: string;\n } | {\n /**\n * @description To renew an app access token with a refresh token, use `refresh_token`.\n * @enum {string}\n */\n grant_type: \"refresh_token\";\n /** @description The refresh token received when creating the authorization. */\n refresh_token: string;\n });\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /** @description Access token with which you will be able to access the Hyperline API on the organisation's behalf. */\n access_token: string;\n /** @description Refresh token with which you will be able to retrieve a new access token on this endpoint. The refresh token does not expire. */\n refresh_token?: string;\n /** @description The number of seconds left before the app access token expires. Be sure to renew your app access token before this reaches zero. */\n expires_in: number;\n /** @enum {string} */\n token_type: \"bearer\";\n };\n };\n };\n };\n };\n revokeToken: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /** @description Application's client ID. */\n client_id: string;\n /** @description Application's client secret. */\n client_secret: string;\n /** @description The refresh token to revoke. */\n token: string;\n };\n };\n };\n responses: {\n /** @description Token revoked */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n createPayment: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create payment payload */\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description\n * Payment type.\n *\n * - `one_time`: One-time payment, generating one-off invoice.\n *\n * @example one_time\n * @enum {string}\n */\n type: \"one_time\";\n /**\n * @description ID of the customer.\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @deprecated\n * @description Deprecated, please use `products`.\n */\n items?: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name. Allow to override the value from the catalog.\n * @example Product name\n */\n name?: string;\n amount?: components[\"schemas\"][\"Amount\"] & unknown;\n }[];\n /** @description Products composing the related invoice. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name. Allow to override the value from the catalog.\n * @example Product name\n */\n name?: string;\n amount?: components[\"schemas\"][\"Amount\"] & unknown;\n }[];\n /** @description Purchase order added on the generated invoice. */\n purchase_order?: string;\n /** @description Custom note added on the generated invoice. */\n custom_note?: string;\n } & ({\n /**\n * @description\n * Charging method.\n *\n * - `immediately`: Customer's payment method will be charged directly to pay the invoice.\n * - `checkout`: Dedicated checkout page will be created for the customer to pay the invoice.\n *\n * @enum {string}\n */\n charging_method: \"immediately\";\n /**\n * @description Type of payment method to use to pay the invoice. If not specified, the payment_method_id or the default customer payment method is used.\n * @enum {string}\n */\n payment_method_type?: \"transfer\" | \"external\";\n /**\n * @description ID of the payment method to use to pay the invoice. Ignored if payment_method_type is specified.\n * @example pm_1ryTrMj4TTAT1N\n */\n payment_method_id?: string;\n } | {\n /**\n * @description\n * Charging method.\n *\n * - `immediately`: Customer's payment method will be charged directly to pay the invoice.\n * - `checkout`: Dedicated checkout page will be created for the customer to pay the invoice.\n *\n * @enum {string}\n */\n charging_method: \"checkout\";\n available_payment_methods: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /** @description Only applies to `checkout` charging method. */\n checkout_session?: {\n /** @description Details to send email to the payer receiving the checkout. */\n send_to?: {\n /** Format: email */\n email: string;\n customMessage?: string;\n };\n /**\n * Format: uri\n * @description URL to which the user is automatically redirected after the completion of the checkout.\n */\n redirect_url?: string;\n };\n });\n };\n };\n responses: {\n /** @description The reference to the created invoice and optionally the checkout */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /** @description Created invoice ID. */\n invoice_id: string;\n /** @description Payment checkout session. */\n checkout?: {\n /** @description Checkout session ID. */\n id: string;\n /** @description URL to which the user is automatically redirected after the completion of the checkout. */\n url: string;\n };\n };\n };\n };\n };\n };\n getProducts: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n price_book_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedProduct\"];\n };\n };\n };\n };\n createProduct: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create product payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateProduct\"];\n };\n };\n responses: {\n /** @description The newly created product */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n };\n };\n getProduct: {\n parameters: {\n query?: {\n price_book_id?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n };\n };\n updateProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update product payload */\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description.\n * @example Product internal description\n */\n description?: string | null;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description?: string | null;\n /** @description Product name and description translations. */\n translations?: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n is_available_on_demand?: boolean;\n is_available_on_subscription?: boolean;\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting?: components[\"schemas\"][\"ProductAccounting\"];\n };\n };\n };\n responses: {\n /** @description The newly created product */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n /** @description Product not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n archiveProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Product archived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n /** @description Product not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n unarchiveProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Product unarchived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n /** @description Product not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updatePrices: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Prices payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"PriceFee\"][];\n };\n };\n responses: {\n /** @description The updated price configuration */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PriceConfiguration\"];\n };\n };\n };\n };\n getPlans: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedPlan\"];\n };\n };\n };\n };\n getPlan: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Plan\"];\n };\n };\n };\n };\n getQuotes: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n status?: (\"all\" | \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"signed\" | \"voided\") | string;\n status__in?: (\"all\" | \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"signed\" | \"voided\") | string;\n customer_id?: string;\n customer_id__not?: string;\n customer_id__isNull?: string;\n customer_id__isNotNull?: string;\n customer_id__equals?: string;\n customer_id__contains?: string;\n customer_id__startsWith?: string;\n customer_id__endWith?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedQuote\"];\n };\n };\n };\n };\n createQuote: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateQuote\"];\n \"multipart/form-data\": {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n *\n * @example draft\n * @enum {string}\n */\n status?: \"draft\" | \"approved\" | \"pending_signature\";\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.\n * @example joe@acme.com\n */\n owner_email?: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id?: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments?: string;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms?: string;\n /**\n * @description Estimated contract value. If not specified, automatically computed from the subscription configuration.\n * @example 20000\n */\n amount?: number | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details?: boolean | (\"true\" | \"false\");\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids?: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription?: boolean | (\"true\" | \"false\");\n } & ({\n /**\n * @description ID of the quote template. If not specified, a subscription configuration must be defined.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string;\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription?: {\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices?: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically?: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n trial_ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Delay first invoice to the end of the trial period.\n * @default false\n */\n trial_delay_first_invoice?: boolean | (\"true\" | \"false\");\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment?: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n } | {\n expires_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription: {\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices?: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically?: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n trial_ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Delay first invoice to the end of the trial period.\n * @default false\n */\n trial_delay_first_invoice?: boolean | (\"true\" | \"false\");\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment?: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n }) & {\n attachments: components[\"schemas\"][\"File\"][];\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n getQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n /** @description Quote not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n downloadQuote: {\n parameters: {\n query?: {\n locale?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/pdf\": unknown;\n };\n };\n /** @description Quote not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n sendQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"SendQuote\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n signQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"multipart/form-data\": {\n signed_quote: components[\"schemas\"][\"File\"];\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n voidQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"VoidQuote\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n downloadQuoteFile: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n quoteId: string;\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/pdf\": unknown;\n };\n };\n /** @description Quote or file not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n refreshSubscriptions: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n createSubscriptionUpdate: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateSubscriptionUpdate\"];\n };\n };\n responses: {\n /** @description Subscription update created */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n id: string;\n };\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n createSubscriptionUpdates: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateSubscriptionUpdates\"];\n };\n };\n responses: {\n /** @description Subscription updates created */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n id: string;\n }[];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n cancelSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CancelSubscription\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n reinstateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n pauseSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n reactivate_at?: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n activateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n reactivateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getSubscriptions: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n status?: (\"all\" | \"inactive\" | \"active\" | \"errored\" | \"cancelled\" | \"paused\" | \"pending\" | \"draft\" | \"voided\" | \"archived\") | string;\n status__in?: (\"all\" | \"inactive\" | \"active\" | \"errored\" | \"cancelled\" | \"paused\" | \"pending\" | \"draft\" | \"voided\" | \"archived\") | string;\n currency?: string;\n currency__not?: string;\n currency__isNull?: string;\n currency__isNotNull?: string;\n currency__equals?: string;\n currency__contains?: string;\n currency__startsWith?: string;\n currency__endWith?: string;\n plan_id?: string;\n plan_id__not?: string;\n plan_id__isNull?: string;\n plan_id__isNotNull?: string;\n plan_id__equals?: string;\n plan_id__contains?: string;\n plan_id__startsWith?: string;\n plan_id__endWith?: string;\n original_quote_id?: string;\n original_quote_id__not?: string;\n original_quote_id__isNull?: string;\n original_quote_id__isNotNull?: string;\n original_quote_id__equals?: string;\n original_quote_id__contains?: string;\n original_quote_id__startsWith?: string;\n original_quote_id__endWith?: string;\n customer_id?: string;\n customer_id__not?: string;\n customer_id__isNull?: string;\n customer_id__isNotNull?: string;\n customer_id__equals?: string;\n customer_id__contains?: string;\n customer_id__startsWith?: string;\n customer_id__endWith?: string;\n invoicing_entity_id?: string;\n invoicing_entity_id__not?: string;\n invoicing_entity_id__isNull?: string;\n invoicing_entity_id__isNotNull?: string;\n invoicing_entity_id__equals?: string;\n invoicing_entity_id__contains?: string;\n invoicing_entity_id__startsWith?: string;\n invoicing_entity_id__endWith?: string;\n customer_external_id?: string;\n updated_at?: string;\n updated_at__not?: string;\n updated_at__isNull?: string;\n updated_at__isNotNull?: string;\n updated_at__equals?: string;\n updated_at__lt?: string;\n updated_at__lte?: string;\n updated_at__gt?: string;\n updated_at__gte?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedSubscription\"];\n };\n };\n };\n };\n createSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description\n * Create subscription payload.\n *\n * At least a `plan_id`, a set of `products` or `phases` must be specified in addition to the required fields.\n * */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateSubscription\"];\n };\n };\n responses: {\n /** @description The newly created subscription */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getSubscription: {\n parameters: {\n query?: {\n include_live_billing?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Subscription\"] & {\n /** @description Products that make up the subscription. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons to be applied to the prices of subscription products. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n /** @description Phases of the subscription. */\n phases: {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n }[];\n quote: {\n /**\n * @description ID of the quote from which the subscription was created.\n * @example quo_38YwqvItBH3d8a\n */\n id: string;\n /**\n * @description Status of the quote from which the subscription was created.\n * @example signed\n * @enum {string}\n */\n status: \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"voided\" | \"signed\";\n } | null;\n plan: {\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n id: string;\n /**\n * @description Name of the plan used to create the subscription.\n * @example My example plan\n */\n name: string;\n } | null;\n checkout_session: components[\"schemas\"][\"CheckoutSession\"];\n /**\n * @description Payment method type used to pay the subscription.\n * @enum {string|null}\n */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n payment_method: components[\"schemas\"][\"PaymentMethod\"] & unknown;\n /** @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent */\n generate_draft_invoices: boolean;\n } & {\n live_billing?: components[\"schemas\"][\"LiveBilling\"];\n };\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description\n * Update subscription payload.\n *\n * Dates fields can only be updated before a subscription is active. Other fields can be updated at any time.\n * */\n requestBody?: {\n content: {\n \"application/json\": {\n /** @description Reference to the purchase order. */\n purchase_order?: string | null;\n /** @description Minimum fee applied to each invoice outside of one time payments. */\n minimum_invoice_fee?: number | null;\n /** @description Only tax will be charged on this subscription. */\n tax_only?: boolean | (\"true\" | \"false\");\n /** @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent */\n generate_draft_invoices?: boolean | (\"true\" | \"false\");\n /** @description Generate non-legal documents instead of invoices. */\n generate_document?: boolean | (\"true\" | \"false\");\n /** @description If `generate_document` is turned on, allows you to give a name to your document. */\n document_name?: string | null;\n /** @description If `generate_document` is turned on, will add VAT to document. */\n add_vat_to_document?: boolean | (\"true\" | \"false\");\n /** @description Subscription will be invoiced but not charged (invoices/documents will be settled directly). */\n do_not_charge_subscription?: boolean | (\"true\" | \"false\");\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & unknown;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n trial_ends_at?: components[\"schemas\"][\"DateTime\"] & unknown;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n };\n };\n };\n responses: {\n /** @description The updated subscription */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getSubscriptionPhases: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedSubscriptionPhase\"];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getSubscriptionPhase: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n phaseId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n };\n };\n /** @description Subscription or phase not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n refreshSeatProductsOnSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Subscription update ID.\n * @example supd_MkTDgpM6ej6f8l\n */\n id: string;\n /**\n * @description\n * Indicates when the subscription should be updated.\n *\n * - `immediately`: The subscription will be updated immediately.\n * - `next_period`: The subscription will be updated at the end of the current billing period.\n * - `custom`: The subscription will be updated at a custom date.\n *\n * @enum {string}\n */\n application_schedule: \"immediately\" | \"next_period\" | \"custom\";\n /**\n * @description Date when the subscription should be updated. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-11-30T18:24:34.496Z\n */\n apply_at: string;\n /**\n * @description\n * Indicates when the subscription should be billed.\n *\n * - `immediately`: The subscription will be billed immediately.\n * - `next_invoice`: The subscription will be billed at the next invoice.\n * - `custom`: The subscription will be billed at a custom date.\n *\n * @enum {string}\n */\n payment_schedule: \"immediately\" | \"next_invoice\" | \"custom\";\n /**\n * @description\n * Indicates how the products price should be calculated.\n *\n * - `pro_rata`: The price will be calculated proportionally to the time elapsed since the last billing period.\n * - `pay_in_full`: The price will be calculated for the entire billing period.\n * - `do_not_charge`: The price will not be calculated.\n *\n * @enum {string}\n */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n /** @description Amount to adjust the subscription price. */\n adjustment_amount: number | null;\n /**\n * @description Subscription ID.\n * @example sub_7aWtG7Gb_fwGno\n */\n subscription_id: string;\n /**\n * @description Product ID.\n * @example itm_G6nU9iSC7eoDsk\n */\n product_id: string;\n /**\n * @description Previous count.\n * @example 2\n */\n previous_count: number;\n /**\n * @description New count.\n * @example 7\n */\n new_count: number;\n /** @description The next refresh date. Exists if your seat item is configured to be refreshed periodically. */\n next_refresh_date?: string | null;\n }[];\n };\n };\n };\n };\n transitionSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n transition_date?: components[\"schemas\"][\"DateTime\"] & string;\n };\n };\n };\n responses: {\n /** @description The updated subscription */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getTaxRates: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n invoicing_entity_id?: string;\n invoicing_entity_id__not?: string;\n invoicing_entity_id__isNull?: string;\n invoicing_entity_id__isNotNull?: string;\n invoicing_entity_id__equals?: string;\n invoicing_entity_id__contains?: string;\n invoicing_entity_id__startsWith?: string;\n invoicing_entity_id__endWith?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedTaxRate\"];\n };\n };\n };\n };\n getTaxRate: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"TaxRate\"];\n };\n };\n /** @description Tax rate not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getApps: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"App\"][];\n };\n };\n };\n };\n createApp: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create app payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateApp\"];\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"App\"] & {\n /** @description OAuth client secret */\n client_secret: string;\n };\n };\n };\n };\n };\n updateApp: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update app payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateApp\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"App\"];\n };\n };\n };\n };\n deleteApp: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description App deleted */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n getWalletSettings: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WalletSettings\"];\n };\n };\n };\n };\n updateWalletSettings: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Update wallet settings payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateWalletSettings\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WalletSettings\"];\n };\n };\n };\n };\n getWallets: {\n parameters: {\n query?: {\n customer_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"][];\n };\n };\n };\n };\n createWallet: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create wallet payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateWallet\"];\n };\n };\n responses: {\n /** @description The newly created wallet */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n };\n };\n getWallet: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n /** @description Wallet not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateWallet: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update wallet payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateWallet\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n /** @description Wallet not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n loadWallet: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Load wallet payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"LoadWallet\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n /** @description Wallet not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getWalletTransactions: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Paginated list of wallet transactions */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedWalletTransaction\"];\n };\n };\n };\n };\n getWebhookEndpoints: {\n parameters: {\n query?: {\n limit?: number;\n iterator?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedWebhookEndpoint\"];\n };\n };\n };\n };\n createWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Webhook endpoint description.\n * @example Production webhook endpoint\n */\n description?: string;\n /**\n * Format: uri\n * @description Webhook endpoint URL.\n * @example https://example.com/webhook\n */\n url: string;\n /** @description Webhook endpoint verification secret (base64 encoded random bytes). If not defined, a secret is automatically generated and only accessible in the UI. */\n secret?: string;\n /** @description Webhook rate limit (per second). */\n rate_limit?: number;\n /**\n * @description Webhook event types filter. If not defined, all event messages will be sent.\n * @example [\n * \"customer.created\",\n * \"customer.updated\"\n * ]\n */\n event_types?: (\"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\")[];\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WebhookEndpoint\"];\n };\n };\n };\n };\n getWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WebhookEndpoint\"];\n };\n };\n };\n };\n updateWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Webhook endpoint description.\n * @example Production webhook endpoint\n */\n description?: string;\n /**\n * Format: uri\n * @description Webhook endpoint URL.\n * @example https://example.com/webhook\n */\n url: string;\n /** @description Webhook rate limit (per second). */\n rate_limit?: number;\n /**\n * @description Webhook event types filter. If not defined, all event messages will be sent.\n * @example [\n * \"customer.created\",\n * \"customer.updated\"\n * ]\n */\n event_types?: (\"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\")[];\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WebhookEndpoint\"];\n };\n };\n };\n };\n deleteWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n getWebhookMessages: {\n parameters: {\n query?: {\n before?: string | null;\n after?: string | null;\n event_types?: \"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\";\n limit?: number;\n iterator?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedWebhookMessage\"];\n };\n };\n };\n };\n}\n"]}
1
+ {"version":3,"file":"_types.generated.js","sourceRoot":"src/","sources":["_types.generated.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file was auto-generated by openapi-typescript.\n * Do not make direct changes to the file.\n */\n\nexport interface paths {\n \"/v1/invoices\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoices\n * @description Retrieve all existing invoices. By default, invoices with status `open` are not included.\n */\n get: operations[\"getInvoices\"];\n put?: never;\n /**\n * Create invoice\n * @description Create a new invoice.\n */\n post: operations[\"createInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/batch\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create invoices\n * @description Create new invoices in batch (max 50 items).\n */\n post: operations[\"createInvoices\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/validate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Validate draft invoice\n * @description Send a draft invoice for payment, set the status to `to_pay` and its number. This is not reversible.\n */\n post: operations[\"validateInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/charge\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Charge invoice\n * @description Manually trigger the payment of the invoice.\n */\n post: operations[\"chargeInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/void\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Void invoice\n * @description Void an invoice in a `to_pay` status. This action generates a corresponding credit note.\n */\n post: operations[\"voidInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoice\n * @description Retrieve the details of an existing invoice.\n */\n get: operations[\"getInvoice\"];\n put?: never;\n post?: never;\n /**\n * Delete invoice\n * @description Delete an invoice in `draft` status or imported from an external source. For other statuses, the `POST /v1/invoices/{id}/void` endpoint must be used.\n */\n delete: operations[\"deleteInvoice\"];\n options?: never;\n head?: never;\n /**\n * Update invoice\n * @description Update an invoice in draft or grace_period status.\n */\n patch: operations[\"updateInvoice\"];\n trace?: never;\n };\n \"/v1/invoices/{id}/upload\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Upload PDF to invoice\n * @description Upload a PDF file to an existing invoice.\n */\n post: operations[\"uploadPdfToInvoice\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/download\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Download invoice\n * @description Download the PDF of an existing invoice.\n */\n get: operations[\"downloadInvoice\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/transactions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create transaction\n * @description Create a transaction linked to an existing invoice. This may update the invoice status to paid/partially paid.\n */\n post: operations[\"createInvoiceTransaction\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoices/{id}/transactions/{transactionId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n post?: never;\n /**\n * Delete transaction\n * @description Delete a transaction linked to an existing invoice. Only applies to scheduled transaction.\n */\n delete: operations[\"deleteInvoiceTransaction\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/analytics\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get analytics\n * @description Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).\n */\n get: operations[\"getAnalytics\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/companies\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get companies\n * @description Retrieve all companies that the authentication token has access to.\n */\n get: operations[\"getCompanies\"];\n put?: never;\n /**\n * Create company\n * @description Create a new company to which the authentication token will have access to.\n */\n post: operations[\"createCompany\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/coupons\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get coupons\n * @description Retrieve all existing coupons.\n */\n get: operations[\"getCoupons\"];\n put?: never;\n /**\n * Create coupon\n * @description Create a new coupon.\n */\n post: operations[\"createCoupon\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/coupons/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get coupon\n * @description Retrieve the details of an existing coupon.\n */\n get: operations[\"getCoupon\"];\n /**\n * Update coupon\n * @description Update the details of an existing coupon.\n */\n put: operations[\"updateCoupon\"];\n post?: never;\n /**\n * Delete coupon\n * @description Delete an existing coupon.\n */\n delete: operations[\"deleteCoupon\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/custom-properties\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get custom properties\n * @description Retrieve all custom properties previously created.\n */\n get: operations[\"getCustomProperties\"];\n put?: never;\n /**\n * Create custom property\n * @description Create a new custom property.\n */\n post: operations[\"createCustomProperty\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/custom-properties/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Update custom property\n * @description Update an existing custom property.\n */\n put: operations[\"updateCustomProperty\"];\n post?: never;\n /**\n * Delete custom property\n * @description Delete an existing custom property.\n */\n delete: operations[\"deleteCustomProperty\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get credit products\n * @description List all credits products attached to a customer.\n */\n get: operations[\"listCustomerCredits\"];\n put?: never;\n /**\n * Create credit product\n * @description Create a credit entity for a given product with an optional balance for a customer.\n */\n post: operations[\"createCreditForProduct\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get credit product\n * @description Retrieve the details of an existing credit product for a customer.\n */\n get: operations[\"getOneCreditForCustomer\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/transactions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get credit transactions\n * @description Retrieve all credit transactions associated with a credit product for a specific customer.\n */\n get: operations[\"listCreditTransactionsForCustomer\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/purchase\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Purchase credits\n * @description Purchase a number of credits. This action will generate an invoice and charge the customer. Can take a few seconds to complete.\n */\n post: operations[\"purchaseCredits\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/topup\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Topup credits\n * @description Topup a number of free credits. This action will not charge the customer.\n */\n post: operations[\"usageCredits\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/credits/{productId}/usage\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create credits usage\n * @description Create a usage entry for a credit product. This will impact the balance of the customer by `usage_retained`.\n */\n post: operations[\"createUsageEntry\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customers\n * @description Retrieve all existing customers.\n */\n get: operations[\"getCustomers\"];\n put?: never;\n /**\n * Create customer\n * @description Create a new customer.\n */\n post: operations[\"createCustomer\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customer\n * @description Retrieve the details of an existing customer.\n */\n get: operations[\"getCustomer\"];\n /**\n * Update customer\n * @description Update the details of an existing customer.\n */\n put: operations[\"updateCustomer\"];\n post?: never;\n /**\n * Delete customer\n * @description Delete an existing customer. The customer must be archived prior to the deletion.\n */\n delete: operations[\"deleteCustomer\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/portal\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customer portal\n * @description Retrieve the URL of the customer portal.\n */\n get: operations[\"getCustomerPortalUrl\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/archive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Archive customer\n * @description Archive an existing customer.\n */\n put: operations[\"archiveCustomer\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/unarchive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Unarchive customer\n * @description Unarchive an archived customer.\n */\n put: operations[\"unarchiveCustomer\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/providers-bulk-update\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Bulk update providers/customers mapping\n * @description Bulk update providers/customers mapping, make sure to check the query response to see if all customers were updated.\n */\n post: operations[\"bulkUpdateCustomersProviders\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/taxes/rates\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get customer tax rates\n * @description Retrieve the eligible tax rates for a customer.\n */\n get: operations[\"getCustomerTaxRates\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/organisations/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get organisation\n * @description Retrieve the details of an existing organisation.\n */\n get: operations[\"getOrganisation\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n /**\n * Patch organisation\n * @description Update the details of an existing organisation.\n */\n patch: operations[\"patchOrganisation\"];\n trace?: never;\n };\n \"/v1/customers/{id}/payment-methods\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get payment methods\n * @description List all payment methods attached to a customer.\n */\n get: operations[\"listCustomerPaymentMethods\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/customers/{id}/payment-methods/{paymentMethodId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get payment method\n * @description Retrieve the details of an existing customer payment method.\n */\n get: operations[\"getCustomerPaymentMethod\"];\n put?: never;\n post?: never;\n /**\n * Delete payment method\n * @description Delete an existing customer payment method.\n */\n delete: operations[\"deleteCustomerPaymentMethod\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/integrations/components/token\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create component token\n * @description Create a new token for embedded components.\n */\n post: operations[\"createComponentToken\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoicing-entities\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoicing entities\n * @description Retrieve all invoicing entities for your current client.\n */\n get: operations[\"getInvoicingEntities\"];\n put?: never;\n /**\n * Create invoicing entity\n * @description Create a new invoicing entity to send invoices from.\n */\n post: operations[\"createInvoicingEntity\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/invoicing-entities/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get invoicing entity\n * @description Retrieve a specific invoicing entity.\n */\n get: operations[\"getInvoicingEntity\"];\n /**\n * Update invoicing entity\n * @description Update an existing invoicing entity.\n */\n put: operations[\"updateInvoicingEntity\"];\n post?: never;\n /**\n * Delete invoicing entity\n * @description Soft deletes an invoicing entity. This action won't delete the associated invoices.\n */\n delete: operations[\"deleteInvoicingEntity\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/userinfo\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get user info\n * @description Returns the user information associated with an access token.\n */\n get: operations[\"getUserInfo\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/authorize\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Authorize\n * @description Redirects the user to the Hyperline's login page, and grants authorization to your integration.\n */\n get: operations[\"authorize\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/tokens\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Generate tokens\n * @description Exchange an auth code received at the authorize endpoint for an actual access token, or refresh it.\n */\n post: operations[\"generateTokens\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/oauth/revoke\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Revoke token\n * @description Revoke a refresh token. Once revoked the token can not be used anymore.\n */\n post: operations[\"revokeToken\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/payments\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create payment\n * @description Initiate a new payment (limited to one-time): generate an invoice and charge it directly or with a checkout session\n */\n post: operations[\"createPayment\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get products\n * @description Retrieve all existing products.\n */\n get: operations[\"getProducts\"];\n put?: never;\n /**\n * Create product\n * @description Create a new product.\n */\n post: operations[\"createProduct\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get product\n * @description Retrieve the details of an existing product.\n */\n get: operations[\"getProduct\"];\n /**\n * Update product\n * @description Update the details of an existing product.\n */\n put: operations[\"updateProduct\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products/{id}/archive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Archive product\n * @description Archive an existing product.\n */\n put: operations[\"archiveProduct\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/products/{id}/unarchive\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Unarchive product\n * @description Unarchive an archived product.\n */\n put: operations[\"unarchiveProduct\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/price-configurations/{id}/prices\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Update prices\n * @description Update prices of an existing price configuration.\n */\n put: operations[\"updatePrices\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/plans\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get plans\n * @description Retrieve all existing plans.\n */\n get: operations[\"getPlans\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/plans/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get plan\n * @description Retrieve the details of an existing plan.\n */\n get: operations[\"getPlan\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get quotes\n * @description Retrieve all existing quotes.\n */\n get: operations[\"getQuotes\"];\n put?: never;\n /**\n * Create quote\n * @description Create a new quote.\n */\n post: operations[\"createQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get quote\n * @description Retrieve the details of an existing quote.\n */\n get: operations[\"getQuote\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/download\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Download quote\n * @description Download an existing quote.\n */\n get: operations[\"downloadQuote\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/send\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Send quote\n * @description Send an existing quote by email for signature.\n */\n post: operations[\"sendQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/sign\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Sign quote\n * @description Manually mark the quote as signed externally. Built-in Hyperline signature flow won't be used.\n */\n post: operations[\"signQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{id}/void\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Void quote\n * @description Void an existing quote.\n */\n post: operations[\"voidQuote\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/quotes/{quoteId}/files/{id}/download\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Download quote file\n * @description Download a file (attachment or manually signed file) attached to an existing quote.\n */\n get: operations[\"downloadQuoteFile\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/refresh\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Refresh subscriptions\n * @description Triggers refresh of subscriptions usage data and related open invoices. This action is used when the automatic billing update upon ingestion option is disabled for the account.\n */\n post: operations[\"refreshSubscriptions\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/update\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create subscription update\n * @description Create an update to apply on an existing subscription.\n */\n post: operations[\"createSubscriptionUpdate\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/update-many\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Create subscription updates\n * @description Create multiple updates to apply at once to an existing subscription.\n */\n post: operations[\"createSubscriptionUpdates\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/cancel\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Cancel subscription\n * @description Cancel an existing subscription.\n */\n post: operations[\"cancelSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/reinstate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Reinstate subscription\n * @description Reinstate an existing subscription scheduled for cancellation.\n */\n post: operations[\"reinstateSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/pause\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Pause subscription\n * @description Pause a subscription.\n */\n post: operations[\"pauseSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/activate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Activate subscription\n * @description Manually start a subscription for the first time.\n */\n post: operations[\"activateSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/subscriptions/{id}/reactivate\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Reactivate subscription\n * @description Reactivate a paused subscription.\n */\n post: operations[\"reactivateSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscriptions\n * @description Retrieve all existing subscriptions. By default, draft, voided, and cancelled subscriptions are not included.\n */\n get: operations[\"getSubscriptions\"];\n put?: never;\n /**\n * Create subscription\n * @description Create a new subscription from a plan or manually with products.\n */\n post: operations[\"createSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscription\n * @description Retrieve the details of an existing subscription.\n */\n get: operations[\"getSubscription\"];\n /**\n * Update subscription\n * @description Update parameters for a subscription.\n */\n put: operations[\"updateSubscription\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/phases\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscription phases\n * @description Retrieve the details of the phases for an existing subscription.\n */\n get: operations[\"getSubscriptionPhases\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/phases/{phaseId}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get subscription phase\n * @description Retrieve the details of a phase for an existing subscription.\n */\n get: operations[\"getSubscriptionPhase\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/refresh-seat-products\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Refresh seat products\n * @description Triggers 'count' updates on connected seat products within the subscription. This action will use the dataloader query to retrieve and update the number of units for each seat product.\n */\n post: operations[\"refreshSeatProductsOnSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v2/subscriptions/{id}/next-phase\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Transition subscription to next phase\n * @description Update a subscription and transition it to the next available phase.\n */\n post: operations[\"transitionSubscription\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/taxes/rates\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get tax rates\n * @description Retrieve all existing custom tax rates.\n */\n get: operations[\"getTaxRates\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/taxes/rates/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get tax rate\n * @description Retrieve the details of an existing custom tax rate.\n */\n get: operations[\"getTaxRate\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/apps\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get apps\n * @description Retrieve all existing third-party apps.\n */\n get: operations[\"getApps\"];\n put?: never;\n /**\n * Create app\n * @description Create a new third-party app.\n */\n post: operations[\"createApp\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/apps/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n /**\n * Update app\n * @description Update an existing third-party app.\n */\n put: operations[\"updateApp\"];\n post?: never;\n /**\n * Delete app\n * @description Delete an existing third-party app.\n */\n delete: operations[\"deleteApp\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/settings\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallet settings\n * @description Retrieve the global settings of the wallets.\n */\n get: operations[\"getWalletSettings\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n /**\n * Update wallet settings\n * @description Update the global settings of the wallets.\n */\n patch: operations[\"updateWalletSettings\"];\n trace?: never;\n };\n \"/v1/wallets\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallets\n * @description Retrieve all existing wallets.\n */\n get: operations[\"getWallets\"];\n put?: never;\n /**\n * Create wallet\n * @description Create a new wallet.\n */\n post: operations[\"createWallet\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallet\n * @description Retrieve the details of an existing wallet.\n */\n get: operations[\"getWallet\"];\n /**\n * Update wallet\n * @description Update the details of an existing wallet.\n */\n put: operations[\"updateWallet\"];\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/{id}/load\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n get?: never;\n put?: never;\n /**\n * Load wallet\n * @description Load credits on an existing wallet. The related customer must have an active payment method.\n */\n post: operations[\"loadWallet\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/wallets/{id}/transactions\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get wallet transactions\n * @description Retrieve all transactions of an existing wallet.\n */\n get: operations[\"getWalletTransactions\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/webhooks/endpoints\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get webhook endpoints\n * @description Retrieve all webhook endpoints.\n */\n get: operations[\"getWebhookEndpoints\"];\n put?: never;\n /**\n * Create webhook endpoint\n * @description Create a new webhook endpoint.\n */\n post: operations[\"createWebhookEndpoint\"];\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/webhooks/endpoints/{id}\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get webhook endpoint\n * @description Retrieve an existing webhook endpoint.\n */\n get: operations[\"getWebhookEndpoint\"];\n /**\n * Update webhook endpoint\n * @description Update an existing webhook endpoint.\n */\n put: operations[\"updateWebhookEndpoint\"];\n post?: never;\n /**\n * Delete webhook endpoint\n * @description Delete an existing webhook endpoint.\n */\n delete: operations[\"deleteWebhookEndpoint\"];\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n \"/v1/webhooks/messages\": {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /**\n * Get webhook messages\n * @description\n * Retrieve all webhook messages sent.\n *\n * Please note that, by default, this endpoint is limited to retrieving 90 days' worth of data relative to now. Messages that date back more than 90 days are still accessible, but their payloads are expunged.\n * If an iterator is provided, the endpoint retrieves data spanning 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the before or after parameter as appropriate.\n *\n */\n get: operations[\"getWebhookMessages\"];\n put?: never;\n post?: never;\n delete?: never;\n options?: never;\n head?: never;\n patch?: never;\n trace?: never;\n };\n}\nexport type webhooks = Record<string, never>;\nexport interface components {\n schemas: {\n /**\n * @description Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).\n * @example EUR\n * @enum {string}\n */\n Currency: \"EUR\" | \"AED\" | \"AFN\" | \"XCD\" | \"ALL\" | \"AMD\" | \"AOA\" | \"ARS\" | \"USD\" | \"AUD\" | \"AWG\" | \"AZN\" | \"BAM\" | \"BBD\" | \"BDT\" | \"XOF\" | \"BGN\" | \"BHD\" | \"BIF\" | \"BMD\" | \"BND\" | \"BOB\" | \"BRL\" | \"BSD\" | \"BTN\" | \"NOK\" | \"BWP\" | \"BYR\" | \"BZD\" | \"CAD\" | \"CDF\" | \"XAF\" | \"CHF\" | \"NZD\" | \"CLP\" | \"CNY\" | \"COP\" | \"CRC\" | \"CUP\" | \"CVE\" | \"ANG\" | \"CZK\" | \"DJF\" | \"DKK\" | \"DOP\" | \"DZD\" | \"EGP\" | \"MAD\" | \"ERN\" | \"ETB\" | \"FJD\" | \"FKP\" | \"GBP\" | \"GEL\" | \"GHS\" | \"GIP\" | \"GMD\" | \"GNF\" | \"GTQ\" | \"GYD\" | \"HKD\" | \"HNL\" | \"HRK\" | \"HTG\" | \"HUF\" | \"IDR\" | \"ILS\" | \"INR\" | \"IQD\" | \"IRR\" | \"ISK\" | \"JMD\" | \"JOD\" | \"JPY\" | \"KES\" | \"KGS\" | \"KHR\" | \"KMF\" | \"KPW\" | \"KRW\" | \"KWD\" | \"KYD\" | \"KZT\" | \"LAK\" | \"LBP\" | \"LKR\" | \"LRD\" | \"LSL\" | \"LYD\" | \"MDL\" | \"MGA\" | \"MKD\" | \"MMK\" | \"MNT\" | \"MOP\" | \"MRO\" | \"MUR\" | \"MVR\" | \"MWK\" | \"MXN\" | \"MYR\" | \"MZN\" | \"NAD\" | \"XPF\" | \"NGN\" | \"NIO\" | \"NPR\" | \"OMR\" | \"PAB\" | \"PEN\" | \"PGK\" | \"PHP\" | \"PKR\" | \"PLN\" | \"PYG\" | \"QAR\" | \"RON\" | \"RSD\" | \"RUB\" | \"RWF\" | \"SAR\" | \"SBD\" | \"SCR\" | \"SDG\" | \"SEK\" | \"SGD\" | \"SHP\" | \"SLL\" | \"SOS\" | \"SRD\" | \"SSP\" | \"STD\" | \"SYP\" | \"SZL\" | \"THB\" | \"TJS\" | \"TMT\" | \"TND\" | \"TOP\" | \"TRY\" | \"TTD\" | \"TWD\" | \"TZS\" | \"UAH\" | \"UGX\" | \"UYU\" | \"UZS\" | \"VEF\" | \"VND\" | \"VUV\" | \"WST\" | \"YER\" | \"ZAR\" | \"ZMW\" | \"ZWL\";\n /**\n * @description Sum of the amount and taxes amount of all products on the invoice. Expressed in the currency's smallest unit.\n * @example 24000\n */\n Amount: number;\n /**\n * Format: date-time\n * @description Date of the conversion of the amount.\n * @example 2024-10-13T02:00:00.000Z\n */\n DateTime: string | null;\n /**\n * @description Two-letter country code in ISO format. See [ISO 3166 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\n * @example FR\n * @enum {string|null}\n */\n Country: \"AD\" | \"AE\" | \"AF\" | \"AG\" | \"AI\" | \"AL\" | \"AM\" | \"AO\" | \"AQ\" | \"AR\" | \"AS\" | \"AT\" | \"AU\" | \"AW\" | \"AX\" | \"AZ\" | \"BA\" | \"BB\" | \"BD\" | \"BE\" | \"BF\" | \"BG\" | \"BH\" | \"BI\" | \"BJ\" | \"BL\" | \"BM\" | \"BN\" | \"BO\" | \"BQ\" | \"BR\" | \"BS\" | \"BT\" | \"BV\" | \"BW\" | \"BY\" | \"BZ\" | \"CA\" | \"CC\" | \"CD\" | \"CF\" | \"CG\" | \"CH\" | \"CI\" | \"CK\" | \"CL\" | \"CM\" | \"CN\" | \"CO\" | \"CR\" | \"CU\" | \"CV\" | \"CW\" | \"CX\" | \"CY\" | \"CZ\" | \"DE\" | \"DJ\" | \"DK\" | \"DM\" | \"DO\" | \"DZ\" | \"EC\" | \"EE\" | \"EG\" | \"EH\" | \"ER\" | \"ES\" | \"ET\" | \"FI\" | \"FJ\" | \"FK\" | \"FM\" | \"FO\" | \"FR\" | \"GA\" | \"GB\" | \"GD\" | \"GE\" | \"GF\" | \"GG\" | \"GH\" | \"GI\" | \"GL\" | \"GM\" | \"GN\" | \"GP\" | \"GQ\" | \"GR\" | \"GS\" | \"GT\" | \"GU\" | \"GW\" | \"GY\" | \"HK\" | \"HM\" | \"HN\" | \"HR\" | \"HT\" | \"HU\" | \"IC\" | \"ID\" | \"IE\" | \"IL\" | \"IM\" | \"IN\" | \"IO\" | \"IQ\" | \"IR\" | \"IS\" | \"IT\" | \"JE\" | \"JM\" | \"JO\" | \"JP\" | \"KE\" | \"KG\" | \"KH\" | \"KI\" | \"KM\" | \"KN\" | \"KP\" | \"KR\" | \"KW\" | \"KY\" | \"KZ\" | \"LA\" | \"LB\" | \"LC\" | \"LI\" | \"LK\" | \"LR\" | \"LS\" | \"LT\" | \"LU\" | \"LV\" | \"LY\" | \"MA\" | \"MC\" | \"MD\" | \"ME\" | \"MF\" | \"MG\" | \"MH\" | \"MK\" | \"ML\" | \"MM\" | \"MN\" | \"MO\" | \"MP\" | \"MQ\" | \"MR\" | \"MS\" | \"MT\" | \"MU\" | \"MV\" | \"MW\" | \"MX\" | \"MY\" | \"MZ\" | \"NA\" | \"NC\" | \"NE\" | \"NF\" | \"NG\" | \"NI\" | \"NL\" | \"NO\" | \"NP\" | \"NR\" | \"NU\" | \"NZ\" | \"OM\" | \"PA\" | \"PE\" | \"PF\" | \"PG\" | \"PH\" | \"PK\" | \"PL\" | \"PM\" | \"PN\" | \"PR\" | \"PS\" | \"PT\" | \"PT-20\" | \"PT-30\" | \"PW\" | \"PY\" | \"QA\" | \"RE\" | \"RO\" | \"RS\" | \"RU\" | \"RW\" | \"SA\" | \"SB\" | \"SC\" | \"SD\" | \"SE\" | \"SG\" | \"SH\" | \"SI\" | \"SJ\" | \"SK\" | \"SL\" | \"SM\" | \"SN\" | \"SO\" | \"SR\" | \"SS\" | \"ST\" | \"SV\" | \"SX\" | \"SY\" | \"SZ\" | \"TC\" | \"TD\" | \"TF\" | \"TG\" | \"TH\" | \"TJ\" | \"TK\" | \"TL\" | \"TM\" | \"TN\" | \"TO\" | \"TR\" | \"TT\" | \"TV\" | \"TW\" | \"TZ\" | \"UA\" | \"UG\" | \"UM\" | \"US\" | \"UY\" | \"UZ\" | \"VA\" | \"VC\" | \"VE\" | \"VG\" | \"VI\" | \"VN\" | \"VU\" | \"WF\" | \"WS\" | \"XK\" | \"YE\" | \"YT\" | \"ZA\" | \"ZM\" | \"ZW\" | null;\n /** @description Customer billing address. */\n Address: {\n /**\n * @description Address name.\n * @example Acme\n */\n name?: string | null;\n /**\n * @description Address first line.\n * @example 5 rue de Paradis\n */\n line1?: string | null;\n /** @description Address second line (optional). */\n line2?: string | null;\n /**\n * @description Address city.\n * @example Paris\n */\n city?: string | null;\n /**\n * @description Address ZIP code.\n * @example 75010\n */\n zip?: string | null;\n /** @description Address state (only for US country). */\n state?: string | null;\n country?: components[\"schemas\"][\"Country\"];\n } | null;\n InvoiceLineItem: {\n /**\n * @description Invoice line item ID.\n * @example ili_0FACNpeoEFkGu3\n */\n id: string;\n /**\n * @description Name of the line item, corresponding to the related product.\n * @example Platform access\n */\n name: string;\n /**\n * @description Product ID related to the invoice line item.\n * @example itm_KbLcWt2qm5p1S2\n */\n product_id: string | null;\n /**\n * @description Product type related to the invoice line item.\n * @example flat_fee\n * @enum {string|null}\n */\n product_type: \"flat_fee\" | \"seat\" | \"dynamic\" | \"credit\" | null;\n /**\n * @description Count of units of the product related to the invoice line item.\n * @example 1\n */\n units_count: number;\n unit_amount: components[\"schemas\"][\"Amount\"] & unknown;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n amount_excluding_tax: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Tax rate of the invoice line item.\n * @example 20\n */\n tax_rate: number;\n /** @description Custom tax rate ID applied to the invoice line item. */\n tax_rate_id: string | null;\n tax_amount: components[\"schemas\"][\"Amount\"] & unknown;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Percentage applied to compute the discounted part of the invoice line amount. Only if coupons applied are percentage based. */\n discount_percent: number | null;\n period_starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n Invoice: {\n /**\n * @description Invoice ID.\n * @example inv_1eTaiytfA0i2Va\n */\n id: string;\n /**\n * @description Invoice number. Generated by Hyperline using the sequential numbering and format defined in your settings.\n * @example INV-35\n */\n number: string;\n /**\n * @description Type of the invoice.\n *\n * - `invoice`: Legal invoice to be paid by your customer.\n * - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.\n * - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.\n *\n * @example invoice\n * @enum {string}\n */\n type: \"invoice\" | \"credit_note\" | \"document\" | \"child_invoice_ref\" | \"child_creditnote_ref\";\n /** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */\n document_name: string | null;\n /**\n * @description Current invoice status.\n *\n * - `draft`: Invoice is in draft mode (not finalized yet).\n * - `open`: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).\n * - `grace_period`: Invoice is in a review period after being issued for the billing period and before becoming due for payment.\n * - `to_pay`: Invoice is awaiting payment.\n * - `partially_paid`: Invoice is partially paid.\n * - `paid`: Invoice is fully paid.\n * - `voided`: Invoice has been voided and is no longer valid.\n * - `closed`: Invoice was not issued and has been discarded.\n * - `error`: Invoice failed to be paid.\n * - `archived`: A previous version of an invoice.\n * - `charged_on_parent`: Invoice is charged on the parent customer.\n * - `pending_parent_concat`: Invoice is pending invoices concatenation on the parent customer to be grouped.\n *\n * @example paid\n * @enum {string}\n */\n status: \"draft\" | \"open\" | \"to_pay\" | \"grace_period\" | \"partially_paid\" | \"paid\" | \"voided\" | \"closed\" | \"error\" | \"missing_info\" | \"archived\" | \"charged_on_parent\" | \"pending_parent_concat\";\n /**\n * @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.\n * @example V0KAHOU6J3\n */\n reference: string | null;\n /**\n * @description Reference to the purchase order linked to the invoice.\n * @example PO-12345\n */\n purchase_order: string | null;\n /** @description ID of the original invoice this credit note is linked to (only used for credit note). */\n original_invoice_id: string | null;\n /** @description Number of the original invoice this credit note is linked to (only used for credit note). */\n original_invoice_number: string | null;\n currency: components[\"schemas\"][\"Currency\"];\n total_amount: components[\"schemas\"][\"Amount\"];\n amount_due: components[\"schemas\"][\"Amount\"] & unknown;\n amount_paid: components[\"schemas\"][\"Amount\"] & unknown;\n amount_fixed: components[\"schemas\"][\"Amount\"] & unknown;\n amount_excluding_tax: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Tax amount of the invoice. Expressed in the currency's smallest unit.\n * @example 20\n */\n tax_rate: number;\n tax_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Tax scheme of the invoice.\n *\n * - `standard`: Tax rate is resolved depending on local tax regulations.\n * - `exempt`: No tax rate applied because the customer country doesn't require it.\n * - `reverse_charge`: No tax rate applied because the customer is eligible to EU reverse charge.\n * - `manual`: Tax rate has been manually specified when creating the invoice.\n * - `not_eligible`: Tax collection is disabled for the invoice.\n *\n * @example standard\n * @enum {string}\n */\n tax_scheme: \"exempt\" | \"standard\" | \"reverse_charge\" | \"manual\" | \"not_eligible\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Conversion rate used between the invoice currency and your accounting currency.\n * @example 1\n */\n conversion_rate: number | null;\n converted_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n converted_at: components[\"schemas\"][\"DateTime\"];\n /**\n * @description ID of the payment method used to pay the invoice.\n * @example pm_1ryTrMj4TTAT1N\n */\n payment_method_id: string | null;\n /**\n * @description Custom note added to the invoice.\n * @example Thank you for your purchase!\n */\n custom_note: string | null;\n customer: {\n /**\n * @description Customer ID.\n * @example cus_Typ0px2W0aiEtl\n */\n id: string;\n /**\n * @description Customer name.\n * @example Acme\n */\n name: string;\n /**\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n email: string | null;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id: string | null;\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number: string | null;\n address: components[\"schemas\"][\"Address\"];\n };\n seller: {\n /**\n * @description ID of the invoicing entity attached to the invoice.\n * @example ive_47484fjdhy5\n */\n id: string;\n /**\n * @description Name of the invoicing entity\n * @example Name of the invoicing entity\n */\n name: string;\n /**\n * @description Tax identifier / VAT number of the invoicing entity\n * @example FR5878986578\n */\n tax_id: string | null;\n address: components[\"schemas\"][\"Address\"] & unknown;\n };\n /**\n * @description ID of the subscription related to the invoice.\n * @example sub_amiaWZ3lzDIWaoT\n */\n subscription_id: string | null;\n period_starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n emitted_at: components[\"schemas\"][\"DateTime\"] & string;\n due_at: components[\"schemas\"][\"DateTime\"] & string;\n refunded_at: components[\"schemas\"][\"DateTime\"] & unknown;\n grace_period_ended_at: components[\"schemas\"][\"DateTime\"] & unknown;\n settled_at: components[\"schemas\"][\"DateTime\"] & unknown;\n updated_at: components[\"schemas\"][\"DateTime\"] & unknown;\n line_items: components[\"schemas\"][\"InvoiceLineItem\"][];\n };\n PaginatedInvoice: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Invoice. */\n data: components[\"schemas\"][\"Invoice\"][];\n };\n PaymentMethodCard: {\n /**\n * @description Payment method ID.\n * @example pm_1xMpj5bwRqN7LM\n */\n id: string;\n } & ({\n /**\n * @description\n * Payment method status.\n *\n * - `active`: The payment method is ready to be used.\n * - `pending`: The payment method is pending activation or being validated.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"pending\";\n } | {\n /**\n * @description\n * Payment method status.\n *\n * - `errored`: The payment method has failed and can no longer be used.\n *\n * @example errored\n * @enum {string}\n */\n status: \"errored\";\n /**\n * @description\n * Payment method error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @example expired\n * @enum {string}\n */\n error_type: \"authentication_required\" | \"authorization_error\" | \"declined\" | \"expired\" | \"fraud\" | \"invalid\" | \"not_supported\" | \"unknown\";\n }) & {\n /**\n * @description\n * Payment method type.\n *\n * - `card`: Credit or debit card\n * - `direct_debit_sepa`: SEPA Direct Debit\n * - `direct_debit_ach`: ACH Direct Debit with an US bank account\n * - `direct_debit_bacs`: Bacs Direct Debit with an UK bank account\n *\n * @example card\n * @enum {string}\n */\n type: \"card\";\n /**\n * @description Last four digits of the card.\n * @example 2718\n */\n last_4_digits: number | null;\n /**\n * @description Expiration date of the card using YYYY-MM format.\n * @example 2026-11\n */\n expiration_date: string | null;\n /** @description Brand of the card. */\n brand: string | null;\n };\n PaymentMethodDirectDebit: {\n /**\n * @description Payment method ID.\n * @example pm_1xMpj5bwRqN7LM\n */\n id: string;\n } & ({\n /**\n * @description\n * Payment method status.\n *\n * - `active`: The payment method is ready to be used.\n * - `pending`: The payment method is pending activation or being validated.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"pending\";\n } | {\n /**\n * @description\n * Payment method status.\n *\n * - `errored`: The payment method has failed and can no longer be used.\n *\n * @example errored\n * @enum {string}\n */\n status: \"errored\";\n /**\n * @description\n * Payment method error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `fraud`: The payment provider suspected the payment method was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @example expired\n * @enum {string}\n */\n error_type: \"authentication_required\" | \"authorization_error\" | \"declined\" | \"expired\" | \"fraud\" | \"invalid\" | \"not_supported\" | \"unknown\";\n }) & {\n /**\n * @description\n * Payment method type.\n *\n * - `card`: Credit or debit card\n * - `direct_debit_sepa`: SEPA Direct Debit\n * - `direct_debit_ach`: ACH Direct Debit with an US bank account\n * - `direct_debit_bacs`: Bacs Direct Debit with an UK bank account\n *\n * @example direct_debit\n * @enum {string}\n */\n type: \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\";\n /**\n * @description Last characters of the account number.\n * @example 6789\n */\n account_number_ending: string | null;\n };\n PaymentMethod: components[\"schemas\"][\"PaymentMethodCard\"] | components[\"schemas\"][\"PaymentMethodDirectDebit\"] | null;\n BankAccount: ({\n /**\n * @description Bank account ID.\n * @example bac_KJyPrMA1toAqRG\n */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description Bank name.\n * @example Fake bank\n */\n bank_name: string | null;\n } & ({\n /** @enum {string} */\n format: \"iban_bic_swift\";\n iban: string;\n bic_swift: string | null;\n } | {\n /** @enum {string} */\n format: \"sort_code_account_number\";\n sort_code: string;\n account_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_routing_number\";\n account_number: string;\n routing_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_bic_swift\";\n account_number: string;\n bic_swift: string;\n })) | null;\n InvoiceDetails: components[\"schemas\"][\"Invoice\"] & {\n transactions: ({\n /**\n * @description Transaction ID.\n * @example tra_2QdJDDUej969ev\n */\n id: string;\n /**\n * @description\n * Transaction type.\n *\n * - `subscription`: The transaction is related to a subscription payment.\n * - `one_time`: The transaction is related to a one-time payment.\n * - `refund`: The transaction is related to a refund payment.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"one_time\" | \"refund\";\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description ID of the customer linked to the transaction.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the transaction on the payment provider (Stripe, Mollie, GoCardless, ...) side.\n * @example pi_xxxxxxxxxx\n */\n provider_id: string | null;\n process_at: components[\"schemas\"][\"DateTime\"] & string;\n refunded_at: components[\"schemas\"][\"DateTime\"] & unknown;\n last_refreshed_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Fee applied by the Payment Service Provider. Only supported for Stripe. */\n provider_fee: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n exchange_rate: number | null;\n } | null;\n /** @description Chargeback details related to the transaction. */\n chargeback: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n last_chargeback_at: components[\"schemas\"][\"DateTime\"] & string;\n } | null;\n } & ({\n /** @enum {string} */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\";\n payment_method: components[\"schemas\"][\"PaymentMethod\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"transfer\" | \"transfer_automated\";\n bank_account: components[\"schemas\"][\"BankAccount\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"wallet\";\n /** @example wal_PPpxP5d3uvgiTT */\n wallet_id: string;\n } | {\n /** @enum {string} */\n payment_method_type: \"external\";\n }) & ({\n /**\n * @description\n * Transaction status.\n *\n * - `scheduled`: The transaction is scheduled to be processed in the future.\n * - `to_process`: The transaction is waiting to be processed by our system.\n * - `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n * - `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n * - `cancelled`: The transaction has been cancelled and won't be processed again.\n *\n * @example settled\n * @enum {string}\n */\n status: \"scheduled\" | \"to_process\" | \"pending\" | \"settled\" | \"cancelled\";\n } | {\n /**\n * @description\n * Transaction status.\n *\n * - `failed`: The transaction failed.\n *\n * @example failed\n * @enum {string}\n */\n status: \"failed\";\n /**\n * @description\n * Transaction error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n * - `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n * - `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @enum {string|null}\n */\n error_type: \"authentication_required\" | \"declined\" | \"fraud\" | \"payment_method_authorization_error\" | \"payment_method_declined\" | \"payment_method_expired\" | \"payment_method_invalid\" | \"payment_method_not_supported\" | \"processing_error\" | \"provider_error\" | \"unknown\" | null;\n /** @description Details of the error. */\n error_message: string | null;\n }))[];\n coupons: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n discount_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n /** @description Percentage to apply as a discount on the amount (excluding taxes) of a product. */\n discount_percent: number | null;\n /**\n * @description IDs of the line items to which the coupon applies.\n * @example [\n * \"ili_0FACNpeoEFkGu3\"\n * ]\n */\n line_item_ids: string[];\n }[];\n };\n CreateInvoiceLineItem: {\n /**\n * @description Description of the line item as it will appear on the invoice. Default to the product description.\n * @example Access fee for the period of November 2024\n */\n description?: string;\n /**\n * @description Count of units of the product related to the invoice line item.\n * @default 1\n * @example 1\n */\n units_count: number;\n /**\n * @description Tax rate of the invoice line item.\n * @example 20\n */\n tax_rate?: number;\n period_start?: components[\"schemas\"][\"DateTime\"] & string;\n period_end?: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description Product ID related to the invoice line item.\n * @example itm_KbLcWt2qm5p1S2\n */\n product_id?: string;\n /**\n * @description Name of the line item as it will appear on the invoice. Default to the product name.\n * @example Platform access\n */\n name: string;\n unit_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /**\n * @description Product ID related to the invoice line item.\n * @example itm_KbLcWt2qm5p1S2\n */\n product_id: string;\n /**\n * @description Name of the line item as it will appear on the invoice. Default to the product name.\n * @example Platform access\n */\n name?: string;\n unit_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n });\n CreateInvoice: {\n /**\n * @description Customer ID.\n * @example inv_1eTaiytfA0i2Va\n */\n customer_id: string;\n currency?: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description Current invoice status.\n *\n * - `draft`: Invoice is in draft mode (not finalized yet).\n * - `open`: Invoice for the current billing period, which will be issued at the end of the period (used for invoices with usage-based data).\n * - `grace_period`: Invoice is in a review period after being issued for the billing period and before becoming due for payment.\n * - `to_pay`: Invoice is awaiting payment.\n * - `partially_paid`: Invoice is partially paid.\n * - `paid`: Invoice is fully paid.\n * - `voided`: Invoice has been voided and is no longer valid.\n * - `closed`: Invoice was not issued and has been discarded.\n * - `error`: Invoice failed to be paid.\n * - `archived`: A previous version of an invoice.\n * - `charged_on_parent`: Invoice is charged on the parent customer.\n * - `pending_parent_concat`: Invoice is pending invoices concatenation on the parent customer to be grouped.\n *\n * @default paid\n * @example paid\n * @enum {string}\n */\n status: \"to_pay\" | \"paid\" | \"draft\";\n /**\n * @description ID of the invoicing entity attached to the invoice.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id?: string;\n /**\n * @description Invoice number. If specified, the invoice will be considered as imported from an external source and the number will not be generated by Hyperline. You are responsible for avoiding duplicates and ensuring it does not impact the numbering sequence in Hyperline.\n * @example INV-35\n */\n number?: string;\n /**\n * @description Type of the invoice.\n *\n * - `invoice`: Legal invoice to be paid by your customer.\n * - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.\n * - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.\n *\n * @example invoice\n * @enum {string}\n */\n type?: \"invoice\" | \"credit_note\" | \"document\";\n /** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */\n document_name?: string;\n /**\n * @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.\n * @example V0KAHOU6J3\n */\n reference?: string;\n /**\n * @description Reference to the purchase order linked to the invoice.\n * @example PO-12345\n */\n purchase_order?: string;\n /**\n * @description Custom note added to the invoice.\n * @example Thank you for your purchase!\n */\n custom_note?: string;\n /**\n * @description Tax rate of the invoice.\n * @example 20\n */\n tax_rate?: number;\n /**\n * @description Tax scheme of the invoice.\n *\n * - `auto`: Tax is automatically computed and applied.\n * - `not_eligible`: Tax collection is disabled for the invoice.\n *\n * @default auto\n * @example auto\n * @enum {string}\n */\n tax_scheme: \"auto\" | \"not_eligible\";\n /**\n * @description\n * Payment method strategy used to charge the invoice. Only applies to `to_pay` status.\n *\n * - `current`: Use the current default payment method of the customer.\n * - `external`: Manage the payment of the invoice outside of Hyperline.\n *\n * @example external\n * @enum {string}\n */\n payment_method_strategy?: \"current\" | \"external\";\n /**\n * @description ID of the payment method used to pay the invoice.\n * @example pm_1ryTrMj4TTAT1N\n */\n payment_method_id?: string;\n emitted_at?: components[\"schemas\"][\"DateTime\"] & string;\n due_at?: components[\"schemas\"][\"DateTime\"] & string;\n settled_at?: components[\"schemas\"][\"DateTime\"] & string;\n line_items: components[\"schemas\"][\"CreateInvoiceLineItem\"][];\n };\n UpdateInvoice: {\n /**\n * @description Type of the invoice.\n *\n * - `invoice`: Legal invoice to be paid by your customer.\n * - `credit_note`: Legal credit note cancelling an invoice and refunding your customer.\n * - `document`: Custom document with no legal value. Can be generated from a subscription to meet specific needs.\n *\n * @example invoice\n * @enum {string}\n */\n type?: \"invoice\" | \"credit_note\" | \"document\";\n /** @description If the invoice is of type `document` you can give it a custom name (displayed on the final PDF). */\n document_name?: string | null;\n /**\n * @description Unique identifier generated by Hyperline to ease reconciliation with payment. Useful for bank transfer.\n * @example V0KAHOU6J3\n */\n reference?: string | null;\n /**\n * @description Reference to the purchase order linked to the invoice.\n * @example PO-12345\n */\n purchase_order?: string | null;\n /**\n * @description Custom note added to the invoice.\n * @example Thank you for your purchase!\n */\n custom_note?: string | null;\n /**\n * @description Tax scheme of the invoice.\n *\n * - `auto`: Tax is automatically computed and applied.\n * - `not_eligible`: Tax collection is disabled for the invoice.\n *\n * @default auto\n * @example auto\n * @enum {string}\n */\n tax_scheme: \"auto\" | \"not_eligible\";\n line_items?: components[\"schemas\"][\"CreateInvoiceLineItem\"][];\n };\n /** @description A file in binary format. Accepted MIME types: application/pdf. Max size: 5000000 bytes. */\n File: unknown;\n PaginatedCompany: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Company. */\n data: {\n /**\n * @description Company ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Company name.\n * @example Acme\n */\n name: string;\n /** @description Logo URL of the default invoicing entity. */\n logo_url: string | null;\n /** @description Favicon URL of the default invoicing entity. */\n favicon_url: string | null;\n address: components[\"schemas\"][\"Address\"] ;\n }[];\n };\n Coupon: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n };\n PaginatedCoupon: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Coupon. */\n data: components[\"schemas\"][\"Coupon\"][];\n };\n CreateCoupon: {\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description?: string | null;\n expiration_date?: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit?: number | null;\n } & ({\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n } | {\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n });\n UpdateCoupon: {\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string;\n /** @description Coupon description. */\n description?: string | null;\n expiration_date?: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit?: number | null;\n } & ({\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n } | {\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n });\n CustomProperty: {\n /**\n * @description Custom property ID.\n * @example cfi_efnjehRH304\n */\n id: string;\n /**\n * @description Custom property name.\n * @example Test custom property\n */\n name: string;\n /**\n * @description Custom property unique slug.\n * @example test_custom_property\n */\n slug: string;\n /**\n * @description Custom property type.\n * @enum {string}\n */\n type: \"date\" | \"boolean\" | \"number\" | \"text\" | \"select\";\n /** @description Entities on which the custom property is available. */\n entities: (\"customer\" | \"product\" | \"plan\" | \"quote\" | \"subscription\")[];\n /** @description If the custom property is of type `select` this is the list of available values. */\n authorized_values: string[] | null;\n /**\n * @description If true the custom property will not be displayed in the interface.\n * @default false\n */\n api_only: boolean;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedCustomProperty: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of CustomProperty. */\n data: components[\"schemas\"][\"CustomProperty\"][];\n };\n Credit: {\n /**\n * @description Credit product ID.\n * @example itm_3kXODDF42QXtnL\n */\n product_id: string;\n /**\n * @description Current credit balance.\n * @example 2000\n */\n current_balance: number;\n /**\n * @description Customer ID related to the credit\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @description Credit name\n * @example Credit name\n */\n name: string;\n /**\n * @description Value indicating a low threshold.\n * @example 10\n */\n low_count_threshold: number | null;\n /**\n * @description Credit last refresh date.\n * @example 2024-11-23T09:00:01.860Z\n */\n last_refreshed_at: string;\n /**\n * @description Credit creation date.\n * @example 2024-10-12T07:00:01.860Z\n */\n created_at: string;\n /**\n * @description Credit last edition date.\n * @example 2024-10-13T10:00:01.860Z\n */\n updated_at: string;\n };\n PaginatedCredit: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Credit. */\n data: components[\"schemas\"][\"Credit\"][];\n };\n CreditTransaction: {\n /**\n * @description Credit transaction ID.\n * @example cdt_BPZ19obsBS2qyo\n */\n id: string;\n /**\n * @description ID of the product related to the transaction.\n * @example itm_3kXODDF42QXtnL\n */\n product_id: string | null;\n /**\n * @description Price details related to the transaction.\n * @example {\n * \"id\": \"pri_0Jv8EbMDOGsHcn\",\n * \"amount\": 20000,\n * \"pack_size\": 120\n * }\n */\n price: {\n id: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n pack_size: number;\n } | null;\n /**\n * @description ID of the customer related to the transaction.\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @description ID of the payment method related to the transaction.\n * @example pm_1xMpj5bwRqN7LM\n */\n payment_method_id: string | null;\n /**\n * @description ID of the invoice related to the transaction.\n * @example inv_1eTaiytfA0i2Va\n */\n invoice_id: string | null;\n /** @description ID of the event related to the credit consumption. */\n event_id: string | null;\n /**\n * @description Type of credit transaction.\n * @example topup\n * @enum {string}\n */\n type: \"topup\" | \"usage\";\n /**\n * @description Type of credit transaction.\n * @example api\n * @enum {string}\n */\n source: \"app\" | \"portal\" | \"api\";\n amount_excluding_tax: components[\"schemas\"][\"Amount\"] & (number | null);\n /**\n * @description Value of credits related to the transaction.\n * @example 32\n */\n credit_count: number;\n /**\n * @description Credit balance after the transaction.\n * @example 2000\n */\n balance_after: number;\n /**\n * @description Credit transaction creation date.\n * @example 2024-10-13T07:00:01.860Z\n */\n created_at: string;\n /**\n * @description Credit transaction last edition date.\n * @example 2024-10-13T07:00:01.860Z\n */\n updated_at: string;\n };\n PaginatedCreditTransaction: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of CreditTransaction. */\n data: components[\"schemas\"][\"CreditTransaction\"][];\n };\n CreateCredit: {\n /**\n * @description Credit product ID.\n * @example itm_3kXODDF42QXtnL\n */\n product_id: string;\n /**\n * @description Current credit balance.\n * @example 2000\n */\n current_balance?: number | null;\n /**\n * @description Credit name\n * @example Credit name\n */\n name: string | null;\n /**\n * @description Value indicating a low threshold.\n * @example 10\n */\n low_count_threshold: number | null;\n };\n CreateCreditPurchase: {\n /**\n * @description Value indicating a number of credits to add. If `price_id` is defined, this value must correspond to a full credit pack for the price.\n * @example 32\n */\n credit_count: number;\n amount_excluding_tax?: components[\"schemas\"][\"Amount\"] & (number | null);\n /** @description Price ID used to add credits. The price must be of type `bundle`. Either `amount_excluding_tax` or `price_id` must be defined. */\n price_id?: string | null;\n };\n CreateCreditTopup: {\n /**\n * @description Value indicating a number of credits to add. If `price_id` is defined, this value must correspond to a full credit pack for the price.\n * @example 32\n */\n credit_count: number;\n };\n CreateCreditUsage: {\n /**\n * @description Value indicating the number of credits consumed.\n * @example 41\n */\n usage_retained: number;\n /** @description Event ID corresponding to the credit consumption. */\n event_id?: string | null;\n };\n Customer: {\n /**\n * @description Customer ID.\n * @example cus_Typ0px2W0aiEtl\n */\n id: string;\n /**\n * @description Customer name.\n * @example Acme\n */\n name: string;\n /**\n * @description\n * Customer type.\n *\n * - `corporate`: The customer is a business entity.\n * - `person`: The customer is a natural person.\n * - `automatically_created`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.\n *\n * @example corporate\n * @enum {string|null}\n */\n type: \"corporate\" | \"person\" | \"automatically_created\" | null;\n /**\n * @description Customer status.\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number: string | null;\n /**\n * @description Indicates customer's tax ID validity.\n * @example true\n */\n vat_number_valid: boolean;\n /** @description Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements. */\n vat_rate_custom: number | null;\n /**\n * @description Language used for invoices, emails, and hosted pages.\n * @example fr\n * @enum {string|null}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\" | null;\n /**\n * @description Customer timezone.\n * @example Europe/Paris\n * @enum {string|null}\n */\n timezone: \"Pacific/Niue\" | \"Pacific/Midway\" | \"Pacific/Pago_Pago\" | \"Pacific/Rarotonga\" | \"Pacific/Honolulu\" | \"Pacific/Tahiti\" | \"Pacific/Marquesas\" | \"Pacific/Gambier\" | \"America/Adak\" | \"America/Anchorage\" | \"Pacific/Pitcairn\" | \"America/Hermosillo\" | \"America/Phoenix\" | \"America/Los_Angeles\" | \"America/Tijuana\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Belize\" | \"America/Guatemala\" | \"America/Managua\" | \"America/Mexico_City\" | \"America/Costa_Rica\" | \"America/El_Salvador\" | \"America/Regina\" | \"America/Tegucigalpa\" | \"Pacific/Easter\" | \"Pacific/Galapagos\" | \"America/Edmonton\" | \"America/Ciudad_Juarez\" | \"America/Denver\" | \"America/Rio_Branco\" | \"America/Chicago\" | \"America/Matamoros\" | \"America/Winnipeg\" | \"America/Bogota\" | \"America/Atikokan\" | \"America/Cancun\" | \"America/Cayman\" | \"America/Jamaica\" | \"America/Panama\" | \"America/Guayaquil\" | \"America/Lima\" | \"America/Manaus\" | \"America/St_Kitts\" | \"America/Blanc-Sablon\" | \"America/Montserrat\" | \"America/Barbados\" | \"America/St_Lucia\" | \"America/Port_of_Spain\" | \"America/Martinique\" | \"America/St_Barthelemy\" | \"America/St_Vincent\" | \"America/Kralendijk\" | \"America/Guadeloupe\" | \"America/Marigot\" | \"America/Aruba\" | \"America/Lower_Princes\" | \"America/Tortola\" | \"America/Dominica\" | \"America/St_Thomas\" | \"America/Grenada\" | \"America/Antigua\" | \"America/Puerto_Rico\" | \"America/Santo_Domingo\" | \"America/Anguilla\" | \"America/Curacao\" | \"America/La_Paz\" | \"America/Santiago\" | \"America/Havana\" | \"America/Grand_Turk\" | \"America/Nassau\" | \"America/New_York\" | \"America/Port-au-Prince\" | \"America/Toronto\" | \"America/Guyana\" | \"America/Asuncion\" | \"America/Caracas\" | \"America/Argentina/Buenos_Aires\" | \"America/Halifax\" | \"Atlantic/Bermuda\" | \"America/Thule\" | \"America/Sao_Paulo\" | \"Antarctica/Palmer\" | \"America/Punta_Arenas\" | \"Atlantic/Stanley\" | \"America/Cayenne\" | \"America/Paramaribo\" | \"America/Montevideo\" | \"America/St_Johns\" | \"America/Noronha\" | \"Atlantic/South_Georgia\" | \"America/Miquelon\" | \"Atlantic/Cape_Verde\" | \"America/Scoresbysund\" | \"America/Nuuk\" | \"Atlantic/Azores\" | \"Etc/UTC\" | \"Africa/Abidjan\" | \"Africa/Bamako\" | \"Africa/Bissau\" | \"Africa/Conakry\" | \"Africa/Dakar\" | \"America/Danmarkshavn\" | \"Africa/Freetown\" | \"Atlantic/St_Helena\" | \"Africa/Accra\" | \"Africa/Lome\" | \"Africa/Monrovia\" | \"Africa/Nouakchott\" | \"Africa/Ouagadougou\" | \"Atlantic/Reykjavik\" | \"Africa/Sao_Tome\" | \"Africa/Banjul\" | \"Africa/Algiers\" | \"Africa/Tunis\" | \"Europe/Isle_of_Man\" | \"Europe/Dublin\" | \"Europe/London\" | \"Europe/Jersey\" | \"Europe/Guernsey\" | \"Africa/Bangui\" | \"Africa/Malabo\" | \"Africa/Brazzaville\" | \"Africa/Porto-Novo\" | \"Africa/Douala\" | \"Africa/Kinshasa\" | \"Africa/Lagos\" | \"Africa/Libreville\" | \"Africa/Luanda\" | \"Africa/Ndjamena\" | \"Africa/Niamey\" | \"Africa/Casablanca\" | \"Africa/El_Aaiun\" | \"Atlantic/Canary\" | \"Europe/Lisbon\" | \"Atlantic/Faroe\" | \"Africa/Bujumbura\" | \"Africa/Gaborone\" | \"Africa/Harare\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Kigali\" | \"Africa/Blantyre\" | \"Africa/Lubumbashi\" | \"Africa/Lusaka\" | \"Africa/Maputo\" | \"Africa/Windhoek\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Bratislava\" | \"Europe/Brussels\" | \"Europe/Budapest\" | \"Europe/Copenhagen\" | \"Europe/Gibraltar\" | \"Europe/Ljubljana\" | \"Arctic/Longyearbyen\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Monaco\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Podgorica\" | \"Europe/Prague\" | \"Europe/Rome\" | \"Europe/San_Marino\" | \"Europe/Malta\" | \"Europe/Sarajevo\" | \"Europe/Skopje\" | \"Europe/Stockholm\" | \"Europe/Tirane\" | \"Europe/Vaduz\" | \"Europe/Vatican\" | \"Europe/Vienna\" | \"Europe/Warsaw\" | \"Europe/Zagreb\" | \"Europe/Zurich\" | \"Europe/Kaliningrad\" | \"Africa/Tripoli\" | \"Antarctica/Troll\" | \"Africa/Johannesburg\" | \"Africa/Mbabane\" | \"Africa/Maseru\" | \"Asia/Kuwait\" | \"Asia/Bahrain\" | \"Asia/Baghdad\" | \"Asia/Qatar\" | \"Asia/Riyadh\" | \"Asia/Aden\" | \"Asia/Amman\" | \"Asia/Damascus\" | \"Africa/Addis_Ababa\" | \"Indian/Antananarivo\" | \"Africa/Asmara\" | \"Africa/Dar_es_Salaam\" | \"Africa/Djibouti\" | \"Africa/Kampala\" | \"Indian/Mayotte\" | \"Africa/Mogadishu\" | \"Indian/Comoro\" | \"Africa/Nairobi\" | \"Europe/Athens\" | \"Asia/Beirut\" | \"Europe/Bucharest\" | \"Africa/Cairo\" | \"Europe/Chisinau\" | \"Asia/Hebron\" | \"Europe/Helsinki\" | \"Europe/Kyiv\" | \"Europe/Mariehamn\" | \"Asia/Nicosia\" | \"Europe/Riga\" | \"Europe/Sofia\" | \"Europe/Tallinn\" | \"Europe/Vilnius\" | \"Asia/Jerusalem\" | \"Europe/Minsk\" | \"Europe/Moscow\" | \"Europe/Simferopol\" | \"Antarctica/Syowa\" | \"Europe/Istanbul\" | \"Asia/Tehran\" | \"Asia/Yerevan\" | \"Asia/Baku\" | \"Asia/Tbilisi\" | \"Asia/Dubai\" | \"Asia/Muscat\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"Europe/Samara\" | \"Indian/Mahe\" | \"Asia/Kabul\" | \"Asia/Almaty\" | \"Indian/Kerguelen\" | \"Indian/Maldives\" | \"Antarctica/Mawson\" | \"Asia/Karachi\" | \"Asia/Dushanbe\" | \"Asia/Ashgabat\" | \"Asia/Tashkent\" | \"Antarctica/Vostok\" | \"Asia/Aqtobe\" | \"Asia/Yekaterinburg\" | \"Asia/Colombo\" | \"Asia/Kolkata\" | \"Asia/Kathmandu\" | \"Asia/Dhaka\" | \"Asia/Thimphu\" | \"Asia/Urumqi\" | \"Indian/Chagos\" | \"Asia/Bishkek\" | \"Asia/Omsk\" | \"Indian/Cocos\" | \"Asia/Yangon\" | \"Indian/Christmas\" | \"Antarctica/Davis\" | \"Asia/Hovd\" | \"Asia/Bangkok\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Phnom_Penh\" | \"Asia/Vientiane\" | \"Asia/Novosibirsk\" | \"Asia/Jakarta\" | \"Australia/Perth\" | \"Asia/Brunei\" | \"Antarctica/Casey\" | \"Asia/Makassar\" | \"Asia/Macau\" | \"Asia/Shanghai\" | \"Asia/Hong_Kong\" | \"Asia/Irkutsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Manila\" | \"Asia/Singapore\" | \"Asia/Taipei\" | \"Asia/Ulaanbaatar\" | \"Australia/Eucla\" | \"Asia/Dili\" | \"Asia/Jayapura\" | \"Asia/Tokyo\" | \"Asia/Pyongyang\" | \"Asia/Seoul\" | \"Pacific/Palau\" | \"Asia/Chita\" | \"Australia/Adelaide\" | \"Australia/Darwin\" | \"Australia/Brisbane\" | \"Australia/Sydney\" | \"Pacific/Guam\" | \"Pacific/Saipan\" | \"Pacific/Chuuk\" | \"Antarctica/DumontDUrville\" | \"Pacific/Port_Moresby\" | \"Asia/Vladivostok\" | \"Australia/Lord_Howe\" | \"Pacific/Bougainville\" | \"Pacific/Kosrae\" | \"Pacific/Noumea\" | \"Pacific/Norfolk\" | \"Asia/Sakhalin\" | \"Pacific/Guadalcanal\" | \"Pacific/Efate\" | \"Pacific/Fiji\" | \"Pacific/Tarawa\" | \"Pacific/Majuro\" | \"Pacific/Nauru\" | \"Pacific/Auckland\" | \"Antarctica/McMurdo\" | \"Asia/Kamchatka\" | \"Pacific/Funafuti\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"Pacific/Chatham\" | \"Pacific/Apia\" | \"Pacific/Kanton\" | \"Pacific/Fakaofo\" | \"Pacific/Tongatapu\" | \"Pacific/Kiritimati\" | null;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id: string | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n billing_address: components[\"schemas\"][\"Address\"] ;\n /**\n * Format: email\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n billing_email: string | null;\n /**\n * @description Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the `billing_email`; otherwise, they won't be sent to the `billing_email`.\n * @example [\n * \"accounting@acme.com\"\n * ]\n */\n invoice_emails: string[];\n /**\n * @description ID of the invoicing entity this customer will be attached to.\n * @example ive_484dn4U48E\n */\n invoicing_entity_id: string;\n /** @description Indicates if invoice reminders are enabled for the customer. */\n invoice_reminders_enabled: boolean | (\"true\" | \"false\");\n /**\n * @description Default price book ID assigned to the customer.\n * @example prib_613_WbVIZ1329e\n */\n price_book_id: string | null;\n /**\n * @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.\n * @example [\n * \"card\",\n * \"direct_debit\"\n * ]\n */\n available_payment_methods: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * @description Default payment method type used to pay subscriptions and one-off invoices.\n * @example card\n * @enum {string|null}\n */\n current_payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n /**\n * @description ID of the default payment method of the customer. Only applies to card and direct debit.\n * @example pm_UTclbc1US8GzCe\n */\n current_payment_method_id: string | null;\n /**\n * @description Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.\n * @example 30\n */\n custom_payment_delay: number | null;\n subscriptions: {\n /**\n * @description Subscription ID.\n * @example sub_0kIc7jrF7gV00V\n */\n id: string;\n /**\n * @description Status of the subscription.\n * @example active\n * @enum {string}\n */\n status: \"draft\" | \"pending\" | \"trialing\" | \"active\" | \"paused\" | \"errored\" | \"cancelled\" | \"voided\" | \"archived\";\n /**\n * @description Start date of the current period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-10-12T07:00:01.860Z\n */\n current_period_started_at: string | null;\n /**\n * @description End date of the current period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-11-12T07:00:01.860Z\n */\n current_period_ends_at: string | null;\n /**\n * @description Plan ID.\n * @example plan_34hdd843hReh\n */\n plan_id: string | null;\n /**\n * @description Checkout session ID.\n * @example che_949djdj39RJj\n */\n checkout_session_id: string | null;\n }[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n deleted_at: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n PaginatedCustomer: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Customer. */\n data: components[\"schemas\"][\"Customer\"][];\n };\n CustomerDetails: components[\"schemas\"][\"Customer\"] & {\n /**\n * @description Provider/ID mapping of the customer in the related providers. Provider (key) can be gocardless, mollie, stripe, airwallex, hubspot, salesforce, xero, exact-online, pennylane, netsuite.\n * @example {\n * \"stripe\": \"cus_Ol3QIaTstxxxxx\"\n * }\n */\n providers: {\n gocardless?: string;\n mollie?: string;\n stripe?: string;\n airwallex?: string;\n hubspot?: string;\n salesforce?: string;\n xero?: string;\n \"exact-online\"?: string;\n pennylane?: string;\n netsuite?: string;\n };\n current_payment_method: components[\"schemas\"][\"PaymentMethod\"] & unknown;\n bank_account: components[\"schemas\"][\"BankAccount\"] & unknown;\n /** @description Parent organization ID to which the client is attached. */\n organisation_id: string | null;\n /**\n * @description\n * How customer invoices are issued from the parent organisation.\n *\n * - `none`: Invoices will keep being issued from this customer.\n * - `every_invoice`: Customer invoices will be issued from the organisation individually.\n * - `concat`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).\n *\n * @enum {string|null}\n */\n organisation_invoicing: \"none\" | \"every_invoice\" | \"concat\" | null;\n };\n /** @description Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used. */\n UpdateBankAccount: {\n /**\n * @description Bank name.\n * @example Fake bank\n */\n bank_name?: string | null;\n } & ({\n /** @enum {string} */\n format: \"iban_bic_swift\";\n iban: string;\n bic_swift: string | null;\n } | {\n /** @enum {string} */\n format: \"sort_code_account_number\";\n sort_code: string;\n account_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_routing_number\";\n account_number: string;\n routing_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_bic_swift\";\n account_number: string;\n bic_swift: string;\n });\n CreateCustomer: {\n /**\n * @description Customer name.\n * @example Acme\n */\n name?: string;\n /**\n * @description\n * Customer type.\n *\n * - `corporate`: The customer is a business entity.\n * - `person`: The customer is a natural person.\n * - `automatically_created`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.\n *\n * @example corporate\n * @enum {string}\n */\n type?: \"corporate\" | \"person\";\n currency?: components[\"schemas\"][\"Currency\"];\n country?: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number?: string;\n /** @description Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements. */\n vat_rate_custom?: number;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id?: string;\n /** @description ID of the invoicing entity this customer will be attached to. */\n invoicing_entity_id?: string;\n billing_address?: components[\"schemas\"][\"Address\"] ;\n /**\n * Format: email\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n billing_email?: string;\n /**\n * @description Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the `billing_email`; otherwise, they won't be sent to the `billing_email`.\n * @example [\n * \"accounting@acme.com\"\n * ]\n */\n invoice_emails?: string[];\n /**\n * @description Language used for invoices, emails, and hosted pages.\n * @example fr\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Customer timezone.\n * @example Europe/Paris\n * @enum {string}\n */\n timezone?: \"Pacific/Niue\" | \"Pacific/Midway\" | \"Pacific/Pago_Pago\" | \"Pacific/Rarotonga\" | \"Pacific/Honolulu\" | \"Pacific/Tahiti\" | \"Pacific/Marquesas\" | \"Pacific/Gambier\" | \"America/Adak\" | \"America/Anchorage\" | \"Pacific/Pitcairn\" | \"America/Hermosillo\" | \"America/Phoenix\" | \"America/Los_Angeles\" | \"America/Tijuana\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Belize\" | \"America/Guatemala\" | \"America/Managua\" | \"America/Mexico_City\" | \"America/Costa_Rica\" | \"America/El_Salvador\" | \"America/Regina\" | \"America/Tegucigalpa\" | \"Pacific/Easter\" | \"Pacific/Galapagos\" | \"America/Edmonton\" | \"America/Ciudad_Juarez\" | \"America/Denver\" | \"America/Rio_Branco\" | \"America/Chicago\" | \"America/Matamoros\" | \"America/Winnipeg\" | \"America/Bogota\" | \"America/Atikokan\" | \"America/Cancun\" | \"America/Cayman\" | \"America/Jamaica\" | \"America/Panama\" | \"America/Guayaquil\" | \"America/Lima\" | \"America/Manaus\" | \"America/St_Kitts\" | \"America/Blanc-Sablon\" | \"America/Montserrat\" | \"America/Barbados\" | \"America/St_Lucia\" | \"America/Port_of_Spain\" | \"America/Martinique\" | \"America/St_Barthelemy\" | \"America/St_Vincent\" | \"America/Kralendijk\" | \"America/Guadeloupe\" | \"America/Marigot\" | \"America/Aruba\" | \"America/Lower_Princes\" | \"America/Tortola\" | \"America/Dominica\" | \"America/St_Thomas\" | \"America/Grenada\" | \"America/Antigua\" | \"America/Puerto_Rico\" | \"America/Santo_Domingo\" | \"America/Anguilla\" | \"America/Curacao\" | \"America/La_Paz\" | \"America/Santiago\" | \"America/Havana\" | \"America/Grand_Turk\" | \"America/Nassau\" | \"America/New_York\" | \"America/Port-au-Prince\" | \"America/Toronto\" | \"America/Guyana\" | \"America/Asuncion\" | \"America/Caracas\" | \"America/Argentina/Buenos_Aires\" | \"America/Halifax\" | \"Atlantic/Bermuda\" | \"America/Thule\" | \"America/Sao_Paulo\" | \"Antarctica/Palmer\" | \"America/Punta_Arenas\" | \"Atlantic/Stanley\" | \"America/Cayenne\" | \"America/Paramaribo\" | \"America/Montevideo\" | \"America/St_Johns\" | \"America/Noronha\" | \"Atlantic/South_Georgia\" | \"America/Miquelon\" | \"Atlantic/Cape_Verde\" | \"America/Scoresbysund\" | \"America/Nuuk\" | \"Atlantic/Azores\" | \"Etc/UTC\" | \"Africa/Abidjan\" | \"Africa/Bamako\" | \"Africa/Bissau\" | \"Africa/Conakry\" | \"Africa/Dakar\" | \"America/Danmarkshavn\" | \"Africa/Freetown\" | \"Atlantic/St_Helena\" | \"Africa/Accra\" | \"Africa/Lome\" | \"Africa/Monrovia\" | \"Africa/Nouakchott\" | \"Africa/Ouagadougou\" | \"Atlantic/Reykjavik\" | \"Africa/Sao_Tome\" | \"Africa/Banjul\" | \"Africa/Algiers\" | \"Africa/Tunis\" | \"Europe/Isle_of_Man\" | \"Europe/Dublin\" | \"Europe/London\" | \"Europe/Jersey\" | \"Europe/Guernsey\" | \"Africa/Bangui\" | \"Africa/Malabo\" | \"Africa/Brazzaville\" | \"Africa/Porto-Novo\" | \"Africa/Douala\" | \"Africa/Kinshasa\" | \"Africa/Lagos\" | \"Africa/Libreville\" | \"Africa/Luanda\" | \"Africa/Ndjamena\" | \"Africa/Niamey\" | \"Africa/Casablanca\" | \"Africa/El_Aaiun\" | \"Atlantic/Canary\" | \"Europe/Lisbon\" | \"Atlantic/Faroe\" | \"Africa/Bujumbura\" | \"Africa/Gaborone\" | \"Africa/Harare\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Kigali\" | \"Africa/Blantyre\" | \"Africa/Lubumbashi\" | \"Africa/Lusaka\" | \"Africa/Maputo\" | \"Africa/Windhoek\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Bratislava\" | \"Europe/Brussels\" | \"Europe/Budapest\" | \"Europe/Copenhagen\" | \"Europe/Gibraltar\" | \"Europe/Ljubljana\" | \"Arctic/Longyearbyen\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Monaco\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Podgorica\" | \"Europe/Prague\" | \"Europe/Rome\" | \"Europe/San_Marino\" | \"Europe/Malta\" | \"Europe/Sarajevo\" | \"Europe/Skopje\" | \"Europe/Stockholm\" | \"Europe/Tirane\" | \"Europe/Vaduz\" | \"Europe/Vatican\" | \"Europe/Vienna\" | \"Europe/Warsaw\" | \"Europe/Zagreb\" | \"Europe/Zurich\" | \"Europe/Kaliningrad\" | \"Africa/Tripoli\" | \"Antarctica/Troll\" | \"Africa/Johannesburg\" | \"Africa/Mbabane\" | \"Africa/Maseru\" | \"Asia/Kuwait\" | \"Asia/Bahrain\" | \"Asia/Baghdad\" | \"Asia/Qatar\" | \"Asia/Riyadh\" | \"Asia/Aden\" | \"Asia/Amman\" | \"Asia/Damascus\" | \"Africa/Addis_Ababa\" | \"Indian/Antananarivo\" | \"Africa/Asmara\" | \"Africa/Dar_es_Salaam\" | \"Africa/Djibouti\" | \"Africa/Kampala\" | \"Indian/Mayotte\" | \"Africa/Mogadishu\" | \"Indian/Comoro\" | \"Africa/Nairobi\" | \"Europe/Athens\" | \"Asia/Beirut\" | \"Europe/Bucharest\" | \"Africa/Cairo\" | \"Europe/Chisinau\" | \"Asia/Hebron\" | \"Europe/Helsinki\" | \"Europe/Kyiv\" | \"Europe/Mariehamn\" | \"Asia/Nicosia\" | \"Europe/Riga\" | \"Europe/Sofia\" | \"Europe/Tallinn\" | \"Europe/Vilnius\" | \"Asia/Jerusalem\" | \"Europe/Minsk\" | \"Europe/Moscow\" | \"Europe/Simferopol\" | \"Antarctica/Syowa\" | \"Europe/Istanbul\" | \"Asia/Tehran\" | \"Asia/Yerevan\" | \"Asia/Baku\" | \"Asia/Tbilisi\" | \"Asia/Dubai\" | \"Asia/Muscat\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"Europe/Samara\" | \"Indian/Mahe\" | \"Asia/Kabul\" | \"Asia/Almaty\" | \"Indian/Kerguelen\" | \"Indian/Maldives\" | \"Antarctica/Mawson\" | \"Asia/Karachi\" | \"Asia/Dushanbe\" | \"Asia/Ashgabat\" | \"Asia/Tashkent\" | \"Antarctica/Vostok\" | \"Asia/Aqtobe\" | \"Asia/Yekaterinburg\" | \"Asia/Colombo\" | \"Asia/Kolkata\" | \"Asia/Kathmandu\" | \"Asia/Dhaka\" | \"Asia/Thimphu\" | \"Asia/Urumqi\" | \"Indian/Chagos\" | \"Asia/Bishkek\" | \"Asia/Omsk\" | \"Indian/Cocos\" | \"Asia/Yangon\" | \"Indian/Christmas\" | \"Antarctica/Davis\" | \"Asia/Hovd\" | \"Asia/Bangkok\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Phnom_Penh\" | \"Asia/Vientiane\" | \"Asia/Novosibirsk\" | \"Asia/Jakarta\" | \"Australia/Perth\" | \"Asia/Brunei\" | \"Antarctica/Casey\" | \"Asia/Makassar\" | \"Asia/Macau\" | \"Asia/Shanghai\" | \"Asia/Hong_Kong\" | \"Asia/Irkutsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Manila\" | \"Asia/Singapore\" | \"Asia/Taipei\" | \"Asia/Ulaanbaatar\" | \"Australia/Eucla\" | \"Asia/Dili\" | \"Asia/Jayapura\" | \"Asia/Tokyo\" | \"Asia/Pyongyang\" | \"Asia/Seoul\" | \"Pacific/Palau\" | \"Asia/Chita\" | \"Australia/Adelaide\" | \"Australia/Darwin\" | \"Australia/Brisbane\" | \"Australia/Sydney\" | \"Pacific/Guam\" | \"Pacific/Saipan\" | \"Pacific/Chuuk\" | \"Antarctica/DumontDUrville\" | \"Pacific/Port_Moresby\" | \"Asia/Vladivostok\" | \"Australia/Lord_Howe\" | \"Pacific/Bougainville\" | \"Pacific/Kosrae\" | \"Pacific/Noumea\" | \"Pacific/Norfolk\" | \"Asia/Sakhalin\" | \"Pacific/Guadalcanal\" | \"Pacific/Efate\" | \"Pacific/Fiji\" | \"Pacific/Tarawa\" | \"Pacific/Majuro\" | \"Pacific/Nauru\" | \"Pacific/Auckland\" | \"Antarctica/McMurdo\" | \"Asia/Kamchatka\" | \"Pacific/Funafuti\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"Pacific/Chatham\" | \"Pacific/Apia\" | \"Pacific/Kanton\" | \"Pacific/Fakaofo\" | \"Pacific/Tongatapu\" | \"Pacific/Kiritimati\";\n /**\n * @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.\n * @example [\n * \"card\",\n * \"direct_debit\"\n * ]\n */\n available_payment_methods?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * @description Default payment method type used to pay subscriptions and one-off invoices.\n * @example card\n * @enum {string}\n */\n payment_method_type?: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\";\n bank_account?: components[\"schemas\"][\"UpdateBankAccount\"];\n /**\n * @description Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.\n * @example 30\n */\n custom_payment_delay?: number;\n /** @description Parent organization ID to which the client is attached. */\n organisation_id?: string;\n /**\n * @description\n * How customer invoices are issued from the parent organisation.\n *\n * - `none`: Invoices will keep being issued from this customer.\n * - `every_invoice`: Customer invoices will be issued from the organisation individually.\n * - `concat`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).\n *\n * @default none\n * @enum {string}\n */\n organisation_invoicing: \"none\" | \"every_invoice\" | \"concat\";\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n /** @description Indicates if invoice reminders are enabled for the customer. */\n invoice_reminders_enabled?: boolean | (\"true\" | \"false\");\n };\n UpdateCustomer: {\n /**\n * @description Customer name.\n * @example Acme\n */\n name?: string;\n /**\n * @description\n * Customer type.\n *\n * - `corporate`: The customer is a business entity.\n * - `person`: The customer is a natural person.\n * - `automatically_created`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.\n *\n * @example corporate\n * @enum {string|null}\n */\n type?: \"corporate\" | \"person\" | null;\n currency?: components[\"schemas\"][\"Currency\"] & unknown;\n country?: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description Customer tax ID.\n * @example FR123456789\n */\n vat_number?: string | null;\n /** @description Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements. */\n vat_rate_custom?: number | null;\n /** @description ID of the customer in your system. This helps matching your customer with the one on Hyperline. */\n external_id?: string | null;\n /** @description ID of the invoicing entity this customer will be attached to. */\n invoicing_entity_id?: string;\n billing_address?: components[\"schemas\"][\"Address\"];\n /**\n * Format: email\n * @description Email to which all communications will be sent.\n * @example billing@acme.com\n */\n billing_email?: string | null;\n /**\n * @description Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the `billing_email`; otherwise, they won't be sent to the `billing_email`.\n * @example [\n * \"accounting@acme.com\"\n * ]\n */\n invoice_emails?: string[];\n /**\n * @description Language used for invoices, emails, and hosted pages.\n * @example fr\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Customer timezone.\n * @example Europe/Paris\n * @enum {string}\n */\n timezone?: \"Pacific/Niue\" | \"Pacific/Midway\" | \"Pacific/Pago_Pago\" | \"Pacific/Rarotonga\" | \"Pacific/Honolulu\" | \"Pacific/Tahiti\" | \"Pacific/Marquesas\" | \"Pacific/Gambier\" | \"America/Adak\" | \"America/Anchorage\" | \"Pacific/Pitcairn\" | \"America/Hermosillo\" | \"America/Phoenix\" | \"America/Los_Angeles\" | \"America/Tijuana\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Belize\" | \"America/Guatemala\" | \"America/Managua\" | \"America/Mexico_City\" | \"America/Costa_Rica\" | \"America/El_Salvador\" | \"America/Regina\" | \"America/Tegucigalpa\" | \"Pacific/Easter\" | \"Pacific/Galapagos\" | \"America/Edmonton\" | \"America/Ciudad_Juarez\" | \"America/Denver\" | \"America/Rio_Branco\" | \"America/Chicago\" | \"America/Matamoros\" | \"America/Winnipeg\" | \"America/Bogota\" | \"America/Atikokan\" | \"America/Cancun\" | \"America/Cayman\" | \"America/Jamaica\" | \"America/Panama\" | \"America/Guayaquil\" | \"America/Lima\" | \"America/Manaus\" | \"America/St_Kitts\" | \"America/Blanc-Sablon\" | \"America/Montserrat\" | \"America/Barbados\" | \"America/St_Lucia\" | \"America/Port_of_Spain\" | \"America/Martinique\" | \"America/St_Barthelemy\" | \"America/St_Vincent\" | \"America/Kralendijk\" | \"America/Guadeloupe\" | \"America/Marigot\" | \"America/Aruba\" | \"America/Lower_Princes\" | \"America/Tortola\" | \"America/Dominica\" | \"America/St_Thomas\" | \"America/Grenada\" | \"America/Antigua\" | \"America/Puerto_Rico\" | \"America/Santo_Domingo\" | \"America/Anguilla\" | \"America/Curacao\" | \"America/La_Paz\" | \"America/Santiago\" | \"America/Havana\" | \"America/Grand_Turk\" | \"America/Nassau\" | \"America/New_York\" | \"America/Port-au-Prince\" | \"America/Toronto\" | \"America/Guyana\" | \"America/Asuncion\" | \"America/Caracas\" | \"America/Argentina/Buenos_Aires\" | \"America/Halifax\" | \"Atlantic/Bermuda\" | \"America/Thule\" | \"America/Sao_Paulo\" | \"Antarctica/Palmer\" | \"America/Punta_Arenas\" | \"Atlantic/Stanley\" | \"America/Cayenne\" | \"America/Paramaribo\" | \"America/Montevideo\" | \"America/St_Johns\" | \"America/Noronha\" | \"Atlantic/South_Georgia\" | \"America/Miquelon\" | \"Atlantic/Cape_Verde\" | \"America/Scoresbysund\" | \"America/Nuuk\" | \"Atlantic/Azores\" | \"Etc/UTC\" | \"Africa/Abidjan\" | \"Africa/Bamako\" | \"Africa/Bissau\" | \"Africa/Conakry\" | \"Africa/Dakar\" | \"America/Danmarkshavn\" | \"Africa/Freetown\" | \"Atlantic/St_Helena\" | \"Africa/Accra\" | \"Africa/Lome\" | \"Africa/Monrovia\" | \"Africa/Nouakchott\" | \"Africa/Ouagadougou\" | \"Atlantic/Reykjavik\" | \"Africa/Sao_Tome\" | \"Africa/Banjul\" | \"Africa/Algiers\" | \"Africa/Tunis\" | \"Europe/Isle_of_Man\" | \"Europe/Dublin\" | \"Europe/London\" | \"Europe/Jersey\" | \"Europe/Guernsey\" | \"Africa/Bangui\" | \"Africa/Malabo\" | \"Africa/Brazzaville\" | \"Africa/Porto-Novo\" | \"Africa/Douala\" | \"Africa/Kinshasa\" | \"Africa/Lagos\" | \"Africa/Libreville\" | \"Africa/Luanda\" | \"Africa/Ndjamena\" | \"Africa/Niamey\" | \"Africa/Casablanca\" | \"Africa/El_Aaiun\" | \"Atlantic/Canary\" | \"Europe/Lisbon\" | \"Atlantic/Faroe\" | \"Africa/Bujumbura\" | \"Africa/Gaborone\" | \"Africa/Harare\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Kigali\" | \"Africa/Blantyre\" | \"Africa/Lubumbashi\" | \"Africa/Lusaka\" | \"Africa/Maputo\" | \"Africa/Windhoek\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Bratislava\" | \"Europe/Brussels\" | \"Europe/Budapest\" | \"Europe/Copenhagen\" | \"Europe/Gibraltar\" | \"Europe/Ljubljana\" | \"Arctic/Longyearbyen\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Monaco\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Podgorica\" | \"Europe/Prague\" | \"Europe/Rome\" | \"Europe/San_Marino\" | \"Europe/Malta\" | \"Europe/Sarajevo\" | \"Europe/Skopje\" | \"Europe/Stockholm\" | \"Europe/Tirane\" | \"Europe/Vaduz\" | \"Europe/Vatican\" | \"Europe/Vienna\" | \"Europe/Warsaw\" | \"Europe/Zagreb\" | \"Europe/Zurich\" | \"Europe/Kaliningrad\" | \"Africa/Tripoli\" | \"Antarctica/Troll\" | \"Africa/Johannesburg\" | \"Africa/Mbabane\" | \"Africa/Maseru\" | \"Asia/Kuwait\" | \"Asia/Bahrain\" | \"Asia/Baghdad\" | \"Asia/Qatar\" | \"Asia/Riyadh\" | \"Asia/Aden\" | \"Asia/Amman\" | \"Asia/Damascus\" | \"Africa/Addis_Ababa\" | \"Indian/Antananarivo\" | \"Africa/Asmara\" | \"Africa/Dar_es_Salaam\" | \"Africa/Djibouti\" | \"Africa/Kampala\" | \"Indian/Mayotte\" | \"Africa/Mogadishu\" | \"Indian/Comoro\" | \"Africa/Nairobi\" | \"Europe/Athens\" | \"Asia/Beirut\" | \"Europe/Bucharest\" | \"Africa/Cairo\" | \"Europe/Chisinau\" | \"Asia/Hebron\" | \"Europe/Helsinki\" | \"Europe/Kyiv\" | \"Europe/Mariehamn\" | \"Asia/Nicosia\" | \"Europe/Riga\" | \"Europe/Sofia\" | \"Europe/Tallinn\" | \"Europe/Vilnius\" | \"Asia/Jerusalem\" | \"Europe/Minsk\" | \"Europe/Moscow\" | \"Europe/Simferopol\" | \"Antarctica/Syowa\" | \"Europe/Istanbul\" | \"Asia/Tehran\" | \"Asia/Yerevan\" | \"Asia/Baku\" | \"Asia/Tbilisi\" | \"Asia/Dubai\" | \"Asia/Muscat\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"Europe/Samara\" | \"Indian/Mahe\" | \"Asia/Kabul\" | \"Asia/Almaty\" | \"Indian/Kerguelen\" | \"Indian/Maldives\" | \"Antarctica/Mawson\" | \"Asia/Karachi\" | \"Asia/Dushanbe\" | \"Asia/Ashgabat\" | \"Asia/Tashkent\" | \"Antarctica/Vostok\" | \"Asia/Aqtobe\" | \"Asia/Yekaterinburg\" | \"Asia/Colombo\" | \"Asia/Kolkata\" | \"Asia/Kathmandu\" | \"Asia/Dhaka\" | \"Asia/Thimphu\" | \"Asia/Urumqi\" | \"Indian/Chagos\" | \"Asia/Bishkek\" | \"Asia/Omsk\" | \"Indian/Cocos\" | \"Asia/Yangon\" | \"Indian/Christmas\" | \"Antarctica/Davis\" | \"Asia/Hovd\" | \"Asia/Bangkok\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Phnom_Penh\" | \"Asia/Vientiane\" | \"Asia/Novosibirsk\" | \"Asia/Jakarta\" | \"Australia/Perth\" | \"Asia/Brunei\" | \"Antarctica/Casey\" | \"Asia/Makassar\" | \"Asia/Macau\" | \"Asia/Shanghai\" | \"Asia/Hong_Kong\" | \"Asia/Irkutsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Manila\" | \"Asia/Singapore\" | \"Asia/Taipei\" | \"Asia/Ulaanbaatar\" | \"Australia/Eucla\" | \"Asia/Dili\" | \"Asia/Jayapura\" | \"Asia/Tokyo\" | \"Asia/Pyongyang\" | \"Asia/Seoul\" | \"Pacific/Palau\" | \"Asia/Chita\" | \"Australia/Adelaide\" | \"Australia/Darwin\" | \"Australia/Brisbane\" | \"Australia/Sydney\" | \"Pacific/Guam\" | \"Pacific/Saipan\" | \"Pacific/Chuuk\" | \"Antarctica/DumontDUrville\" | \"Pacific/Port_Moresby\" | \"Asia/Vladivostok\" | \"Australia/Lord_Howe\" | \"Pacific/Bougainville\" | \"Pacific/Kosrae\" | \"Pacific/Noumea\" | \"Pacific/Norfolk\" | \"Asia/Sakhalin\" | \"Pacific/Guadalcanal\" | \"Pacific/Efate\" | \"Pacific/Fiji\" | \"Pacific/Tarawa\" | \"Pacific/Majuro\" | \"Pacific/Nauru\" | \"Pacific/Auckland\" | \"Antarctica/McMurdo\" | \"Asia/Kamchatka\" | \"Pacific/Funafuti\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"Pacific/Chatham\" | \"Pacific/Apia\" | \"Pacific/Kanton\" | \"Pacific/Fakaofo\" | \"Pacific/Tongatapu\" | \"Pacific/Kiritimati\";\n /**\n * @description List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.\n * @example [\n * \"card\",\n * \"direct_debit\"\n * ]\n */\n available_payment_methods?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * @description Default payment method type used to pay subscriptions and one-off invoices.\n * @example card\n * @enum {string|null}\n */\n payment_method_type?: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n /**\n * @description ID of the default payment method of the customer. Only applies to card and direct debit.\n * @example pm_UTclbc1US8GzCe\n */\n payment_method_id?: string | null;\n bank_account?: components[\"schemas\"][\"UpdateBankAccount\"] & (({\n /**\n * @description Bank name.\n * @example Fake bank\n */\n bank_name?: string | null;\n } & ({\n /** @enum {string} */\n format: \"iban_bic_swift\";\n iban: string;\n bic_swift: string | null;\n } | {\n /** @enum {string} */\n format: \"sort_code_account_number\";\n sort_code: string;\n account_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_routing_number\";\n account_number: string;\n routing_number: string;\n } | {\n /** @enum {string} */\n format: \"account_number_bic_swift\";\n account_number: string;\n bic_swift: string;\n })) | null);\n /**\n * @description Custom payment delay. If not defined, the default one defined on the related invoicing entity will be used.\n * @example 30\n */\n custom_payment_delay?: number | null;\n /** @description Parent organization ID to which the client is attached. */\n organisation_id?: string | null;\n /**\n * @description\n * How customer invoices are issued from the parent organisation.\n *\n * - `none`: Invoices will keep being issued from this customer.\n * - `every_invoice`: Customer invoices will be issued from the organisation individually.\n * - `concat`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).\n *\n * @enum {string|null}\n */\n organisation_invoicing?: \"none\" | \"every_invoice\" | \"concat\" | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n /** @description Indicates if invoice reminders are enabled for the customer. */\n invoice_reminders_enabled?: boolean | (\"true\" | \"false\");\n };\n Organisation: {\n /**\n * @description Organisation ID.\n * @example cus_0noDeAEU22FgA4\n */\n id: string;\n /**\n * @description Organisation legal name.\n * @example Acme Group\n */\n name: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /**\n * @description Frequency on which the invoices are grouped and emitted from the organisation. Only applies to `concat` invoice configuration on children customers.\n * @example month\n * @enum {string|null}\n */\n invoice_schedule: \"month\" | \"quarter\" | \"year\" | null;\n next_invoice_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description List of the organization's child customer IDs.\n * @example [\n * \"cus_Typ0px2W0aiEtl\"\n * ]\n */\n child_customer_ids: string[];\n };\n PatchOrganisation: {\n /**\n * @description Organisation legal name.\n * @example Acme Group\n */\n name?: string;\n currency?: components[\"schemas\"][\"Currency\"];\n country?: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description Frequency on which the invoices are grouped and emitted from the organisation. Only applies to `concat` invoice configuration on children customers.\n * @example month\n * @enum {string}\n */\n invoice_schedule?: \"month\" | \"quarter\" | \"year\";\n next_invoice_at?: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedPaymentMethod: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of PaymentMethod. */\n data: (components[\"schemas\"][\"PaymentMethod\"] & (components[\"schemas\"][\"PaymentMethodCard\"] | components[\"schemas\"][\"PaymentMethodDirectDebit\"]))[];\n };\n CreateComponentToken: {\n /** @description Customer ID */\n customer_id: string;\n };\n PaginatedInvoicingEntity: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of InvoicingEntity. */\n data: {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n }[];\n };\n /** @description Mapping invoicing entity ID/accounting settings. */\n ProductAccounting: {\n [key: string]: {\n /**\n * @description Custom tax rate ID.\n * @example taxr_YfiSnLIYORD9VN\n */\n tax_rate_id: string | null;\n /**\n * @description Code used to reconcile the product with the external accounting tool. Usually, it corresponds to the product ID in the accounting software.\n * @example PROD-23\n */\n product_code: string | null;\n /**\n * @description Code used to assign related invoices line items to a General Ledger account in your external accounting tool.\n * @example GL-001\n */\n account_code: string | null;\n };\n };\n ProductSimple: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"flat_fee\";\n /**\n * @description Enable the product to be billed at any time as a one-time payment.\n * @example true\n */\n is_available_on_demand: boolean;\n /**\n * @description Enable the product to be added as part of a subscription.\n * @example true\n */\n is_available_on_subscription: boolean;\n } | {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"seat\";\n } | {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"dynamic\";\n } | {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"credit\";\n /** @description Threshold indicating a low level of credits. */\n low_credits_threshold: number | null;\n };\n PaginatedProduct: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Product. */\n data: components[\"schemas\"][\"ProductSimple\"][];\n };\n PriceFee: {\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"fee\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n };\n ProductFee: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"flat_fee\";\n /**\n * @description Enable the product to be billed at any time as a one-time payment.\n * @example true\n */\n is_available_on_demand: boolean;\n /**\n * @description Enable the product to be added as part of a subscription.\n * @example true\n */\n is_available_on_subscription: boolean;\n price_configurations: {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"fee\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n }[];\n };\n PriceVolume: {\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"volume\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n /** @description From limit. */\n from: number;\n /** @description To limit. */\n to: number | null;\n /**\n * @description\n * Logic used to compute the amount when usage on the tier is incomplete.\n *\n * - `pro_rata`: The amount is computed using the pro rata of the tier's consumption.\n * - `pay_in_full`: The amount corresponds to the full payment of the tier.\n * - `do_not_charge`: The tier is not charged and ignored.\n *\n * @default pro_rata\n * @enum {string|null}\n */\n on_tier_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n };\n PricePackaged: {\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n /** @description From limit. */\n from: number;\n /** @description To limit. */\n to: number | null;\n /**\n * @description\n * Logic used to compute the amount when usage reaches an incomplete bucket (the bucket size corresponds to the `unitCount`).\n *\n * - `pro_rata`: The amount is computed using the pro rata of the bucket's consumption.\n * - `pay_in_full`: The amount corresponds to the full payment of the bucket.\n * - `do_not_charge`: The bucket is not charged and ignored.\n *\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n };\n PriceBulk: {\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n /** @description To limit. */\n to: number | null;\n /**\n * @description\n * Logic used to compute the amount when usage on the tier is incomplete.\n *\n * - `pro_rata`: The amount is computed using the pro rata of the tier's consumption.\n * - `pay_in_full`: The amount corresponds to the full payment of the tier.\n * - `do_not_charge`: The tier is not charged and ignored.\n *\n * @default pro_rata\n * @enum {string|null}\n */\n on_tier_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n };\n ProductSeat: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"seat\";\n price_configurations: ({\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"volume\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceVolume\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PricePackaged\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBulk\"][];\n })[];\n };\n PriceBps: {\n /** @enum {string} */\n type: \"bps\";\n /** @description Price ID. */\n id?: string;\n /** @description From limit. */\n from: number;\n /** @description To limit. */\n to: number | null;\n /** @description Percentage applied on each unit to compute the usage. */\n percentage: number;\n per_unit_cap: components[\"schemas\"][\"Amount\"] & (number | null);\n per_unit_floor: components[\"schemas\"][\"Amount\"] & (number | null);\n per_unit_fee: components[\"schemas\"][\"Amount\"] & (number | null);\n };\n /**\n * @description Configuration of the rules used to filter eligible events.\n * @example {\n * \"conditional\": \"and\",\n * \"fields\": [\n * {\n * \"property\": \"card_type\",\n * \"operator\": \"equals\",\n * \"value\": \"visa\"\n * },\n * {\n * \"property\": \"kind\",\n * \"operator\": \"equals\",\n * \"value\": \"credit_card\"\n * }\n * ]\n * }\n */\n MeteringFilterConfiguration: {\n /** @enum {string} */\n conditional: \"and\" | \"or\";\n fields: ({\n property: string;\n } & ({\n /** @enum {string} */\n operator: \"isNull\" | \"isNotNull\";\n } | {\n /** @enum {string} */\n operator: \"in\" | \"notIn\";\n value: string;\n } | {\n /** @enum {string} */\n operator: \"gte\" | \"gt\" | \"lt\" | \"lte\";\n value: number;\n } | {\n /** @enum {string} */\n operator: \"equals\" | \"notEqual\";\n value: string | number | boolean;\n }))[];\n };\n MeteringFilter: {\n /**\n * @description Name of the metering filter.\n * @example VISA credit cards\n */\n name: string;\n configuration: components[\"schemas\"][\"MeteringFilterConfiguration\"];\n } | null;\n ProductDynamic: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"dynamic\";\n price_configurations: (({\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"volume\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceVolume\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PricePackaged\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBulk\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bps\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBps\"][];\n }) & {\n metering_filter: components[\"schemas\"][\"MeteringFilter\"];\n })[];\n };\n ProductCredit: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description\n * Product status.\n *\n * - `active`: The product is active and can be used in new quotes/subscriptions/invoices.\n * - `archived`: The product is archived and can't be used anymore.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"archived\";\n /**\n * @description Product description.\n * @example Product internal description\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description: string | null;\n /** @description Product name and description translations. */\n translations: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting: components[\"schemas\"][\"ProductAccounting\"];\n /**\n * @description Product type.\n * @enum {string}\n */\n type: \"credit\";\n /** @description Threshold indicating a low level of credits. */\n low_credits_threshold: number | null;\n price_configurations: {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bundle\";\n allow_on_portal: boolean;\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceBulk\"] & {\n /** @enum {string} */\n type: \"bundle\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n })[];\n }[];\n };\n Product: components[\"schemas\"][\"ProductFee\"] | components[\"schemas\"][\"ProductSeat\"] | components[\"schemas\"][\"ProductDynamic\"] | components[\"schemas\"][\"ProductCredit\"];\n CreateProduct: {\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description.\n * @example Product internal description\n */\n description?: string;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates?: boolean;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description?: string;\n /** @description Product name and description translations. */\n translations?: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n /** @default true */\n is_available_on_demand: boolean;\n /** @default true */\n is_available_on_subscription: boolean;\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting?: components[\"schemas\"][\"ProductAccounting\"];\n /** @enum {string} */\n type: \"flat_fee\";\n price_configurations: {\n currency: components[\"schemas\"][\"Currency\"];\n country?: components[\"schemas\"][\"Country\"] & string;\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id?: string;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval?: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /** @enum {string} */\n type: \"fee\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n }[];\n };\n PriceConfiguration: {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"fee\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"volume\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceVolume\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"packaged\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PricePackaged\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bulk\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBulk\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bps\";\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceBps\"][];\n } | {\n /** @description Price configuration ID. */\n id: string;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n country: components[\"schemas\"][\"Country\"];\n /** @description ID of the plan on which this price configuration is eligible */\n plan_id: string | null;\n /** @description Billing interval on which the price configuration is eligible. */\n billing_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Commitment interval on which the price configuration is eligible. */\n commitment_interval: {\n /** @enum {string} */\n period: \"all\";\n } | {\n /** @enum {string} */\n period: \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /** @description Last edition date of the price configuration. */\n updated_at: string;\n /** @enum {string} */\n type: \"bundle\";\n allow_on_portal: boolean;\n /** @description Price tiers of the price configuration. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceBulk\"] & {\n /** @enum {string} */\n type: \"bundle\";\n /** @description Price ID. */\n id?: string;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of units considered for the amount. */\n unit_count: number;\n })[];\n };\n PlanSimple: {\n /**\n * @description Plan ID.\n * @example plan_zHmjoDea4ZRmQV\n */\n id: string;\n /**\n * @description Plan name.\n * @example Starter\n */\n name: string;\n /**\n * @description Plan description.\n * @example Starter pack\n */\n description: string | null;\n /**\n * @description Interval used to represent the commitment period of the plan.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Strategy used to trigger the start of the subscription contract.\n * @example start_date\n * @enum {string}\n */\n contract_start_strategy: \"start_date\" | \"immediately\" | \"manual\" | \"manual_with_latest\" | \"quote_signature\" | \"checkout\";\n contract_start: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Strategy used to trigger the end of the subscription contract.\n * @example duration\n * @enum {string}\n */\n contract_end_strategy: \"duration\" | \"manual\" | \"end_date\";\n contract_end: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Duration of the initial contract for the created subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n contract_duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\" | \"forever\";\n count: number | null;\n } | null;\n /**\n * @description Indicates if the subscription to the plan should automatically renew.\n * @example true\n */\n renew_automatically: boolean;\n /**\n * @description Interval to renew thr subscription for if `renew_automatically` is enabled.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number | null;\n } | null;\n };\n PaginatedPlan: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Plan. */\n data: components[\"schemas\"][\"PlanSimple\"][];\n };\n Plan: {\n /**\n * @description Plan ID.\n * @example plan_zHmjoDea4ZRmQV\n */\n id: string;\n /**\n * @description Plan name.\n * @example Starter\n */\n name: string;\n /**\n * @description Plan description.\n * @example Starter pack\n */\n description: string | null;\n /**\n * @description Interval used to represent the commitment period of the plan.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Strategy used to trigger the start of the subscription contract.\n * @example start_date\n * @enum {string}\n */\n contract_start_strategy: \"start_date\" | \"immediately\" | \"manual\" | \"manual_with_latest\" | \"quote_signature\" | \"checkout\";\n contract_start: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Strategy used to trigger the end of the subscription contract.\n * @example duration\n * @enum {string}\n */\n contract_end_strategy: \"duration\" | \"manual\" | \"end_date\";\n contract_end: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Duration of the initial contract for the created subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n contract_duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\" | \"forever\";\n count: number | null;\n } | null;\n /**\n * @description Indicates if the subscription to the plan should automatically renew.\n * @example true\n */\n renew_automatically: boolean;\n /**\n * @description Interval to renew thr subscription for if `renew_automatically` is enabled.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number | null;\n } | null;\n products: ({\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"flat_fee\";\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n } | {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"seat\";\n /**\n * @description Name of the unit.\n * @example user\n */\n unit_name: string | null;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"])[];\n } | {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"dynamic\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Minimum of units committed. If usage is less than this number, then this value will be used.\n * @example 2000\n */\n min_committed_count: number | null;\n /** @description 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. */\n min_amount: number | null;\n /** @description 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. */\n max_amount: number | null;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n *\n * @enum {string|null}\n */\n metering_interval_type: \"subscription_commitment\" | \"payment_interval\" | \"full_database\" | \"phase_duration\" | null;\n /** @description 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. */\n bill_usage_difference: boolean;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: ((components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"] | components[\"schemas\"][\"PriceBps\"]) & {\n metering_filter: components[\"schemas\"][\"MeteringFilter\"];\n })[];\n } | {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /** @enum {string} */\n type: \"credit\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Number of product units.\n * @example 2\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n })[];\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n };\n QuoteFile: {\n /** @description Quote file ID. */\n id: string;\n /** @description Quote file name. */\n name: string;\n /** @description Quote file MIME type. */\n mimetype: string;\n };\n QuoteDraft: {\n /**\n * @description Quote ID.\n * @example quo_hXQCd5y8P3GYXa\n */\n id: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id: string;\n /**\n * @description ID of the quote template.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Quote sequential number.\n * @example 327\n */\n number: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments: string | null;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms: string | null;\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner.\n * @example joe@acme.com\n */\n owner_email: string | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details: boolean;\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids: string[];\n /**\n * @description List of documents attached to the quote.\n * @example [\n * {\n * \"id\": \"quof_5GYXy8P3QCdaXh\",\n * \"name\": \"General Conditions of Sale\",\n * \"mimetype\": \"application/pdf\"\n * }\n * ]\n */\n attachments: components[\"schemas\"][\"QuoteFile\"][];\n signed_file: components[\"schemas\"][\"QuoteFile\"] ;\n /**\n * Format: uri\n * @description URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.\n * @example https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa\n */\n url: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example draft\n * @enum {string}\n */\n status: \"draft\";\n amount: components[\"schemas\"][\"Amount\"] & (number | null);\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n } & ({\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"subscription_update\";\n /**\n * @description 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.\n * @example sub_B6ClkdqNqVNBgY\n */\n subscription_id: string | null;\n /**\n * @description 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.\n * @example [\n * \"sub_0z39oqdhKl0PXb\"\n * ]\n */\n child_subscription_ids: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription: boolean;\n } | {\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example one_off\n * @enum {string}\n */\n type: \"one_off\";\n /**\n * @description 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.\n * @example inv_0ADWB0lzH52RFt\n */\n invoice_id: string | null;\n });\n QuoteComplete: {\n /**\n * @description Quote ID.\n * @example quo_hXQCd5y8P3GYXa\n */\n id: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id: string;\n /**\n * @description ID of the quote template.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Quote sequential number.\n * @example 327\n */\n number: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments: string | null;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms: string | null;\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner.\n * @example joe@acme.com\n */\n owner_email: string | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details: boolean;\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids: string[];\n /**\n * @description List of documents attached to the quote.\n * @example [\n * {\n * \"id\": \"quof_5GYXy8P3QCdaXh\",\n * \"name\": \"General Conditions of Sale\",\n * \"mimetype\": \"application/pdf\"\n * }\n * ]\n */\n attachments: components[\"schemas\"][\"QuoteFile\"][];\n signed_file: components[\"schemas\"][\"QuoteFile\"] ;\n /**\n * Format: uri\n * @description URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.\n * @example https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa\n */\n url: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & unknown;\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"subscription_update\";\n /**\n * @description 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.\n * @example sub_B6ClkdqNqVNBgY\n */\n subscription_id: string;\n /**\n * @description 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.\n * @example [\n * \"sub_0z39oqdhKl0PXb\"\n * ]\n */\n child_subscription_ids: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription: boolean;\n } | {\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example one_off\n * @enum {string}\n */\n type: \"one_off\";\n /**\n * @description 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.\n * @example inv_0ADWB0lzH52RFt\n */\n invoice_id: string;\n }) & ({\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example pending_approval\n * @enum {string}\n */\n status: \"pending_approval\" | \"changes_requested\";\n } | {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example pending_signature\n * @enum {string}\n */\n status: \"approved\" | \"pending_signature\";\n approved_at: components[\"schemas\"][\"DateTime\"] & string;\n } | {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example signed\n * @enum {string}\n */\n status: \"signed\";\n approved_at: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Quote signature. Only applies to the `signed` quote.\n * @example {\n * \"mode\": \"basic\",\n * \"signerName\": \"Acme\"\n * }\n */\n signature: {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example basic\n * @enum {string}\n */\n mode: \"basic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example electronic\n * @enum {string}\n */\n mode: \"electronic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example external\n * @enum {string}\n */\n mode: \"external\";\n };\n signed_at: components[\"schemas\"][\"DateTime\"] & string;\n });\n QuoteVoided: {\n /**\n * @description Quote ID.\n * @example quo_hXQCd5y8P3GYXa\n */\n id: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id: string;\n /**\n * @description ID of the quote template.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Quote sequential number.\n * @example 327\n */\n number: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments: string | null;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms: string | null;\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner.\n * @example joe@acme.com\n */\n owner_email: string | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details: boolean;\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids: string[];\n /**\n * @description List of documents attached to the quote.\n * @example [\n * {\n * \"id\": \"quof_5GYXy8P3QCdaXh\",\n * \"name\": \"General Conditions of Sale\",\n * \"mimetype\": \"application/pdf\"\n * }\n * ]\n */\n attachments: components[\"schemas\"][\"QuoteFile\"][];\n signed_file: components[\"schemas\"][\"QuoteFile\"] ;\n /**\n * Format: uri\n * @description URL to access the quote publicly. Only applies to the `pending_signature` or `signed` quote.\n * @example https://billing.hyperline.co/quote/quo_hXQCd5y8P3GYXa\n */\n url: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `pending_approval`: The quote is pending manager review and approval.\n * - `changes_requested`: Some changes have been requested following manager review.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n * - `signed`: The quote is signed and fully finalized.\n * - `voided`: The quote is voided.\n *\n * @example voided\n * @enum {string}\n */\n status: \"voided\";\n /**\n * @description Quote voiding reason. Only applies to the `voided` quote.\n * @example The customer is ultimately not interested.\n */\n void_reason: string;\n voided_at: components[\"schemas\"][\"DateTime\"] & string;\n amount: components[\"schemas\"][\"Amount\"] & (number | null);\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n approved_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Quote signature. Only applies to the `signed` quote.\n * @example {\n * \"mode\": \"basic\",\n * \"signerName\": \"Acme\"\n * }\n */\n signature: ({\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example basic\n * @enum {string}\n */\n mode: \"basic\";\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example electronic\n * @enum {string}\n */\n mode: \"electronic\";\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example external\n * @enum {string}\n */\n mode: \"external\";\n }) | ({\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example basic\n * @enum {string}\n */\n mode: \"basic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example electronic\n * @enum {string}\n */\n mode: \"electronic\";\n /**\n * @description Signer name of the quote.\n * @example Acme\n */\n signerName: string;\n } | {\n /**\n * @description\n * Signature mode.\n *\n * - `basic`: Basic signature. The signer manually put his name. No legal value.\n * - `electronic`: Certified electronic signature. Legally compliant.\n * - `external`: Signed outside of Hyperline. A signed file has been uploaded.\n *\n * @example external\n * @enum {string}\n */\n mode: \"external\";\n }) | null;\n signed_at: components[\"schemas\"][\"DateTime\"] & unknown;\n } & ({\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"subscription_update\";\n /**\n * @description 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.\n * @example sub_B6ClkdqNqVNBgY\n */\n subscription_id: string | null;\n /**\n * @description 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.\n * @example [\n * \"sub_0z39oqdhKl0PXb\"\n * ]\n */\n child_subscription_ids: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription: boolean;\n } | {\n /**\n * @description\n * Quote type.\n *\n * - `subscription`: The quote will create and start a new subscription.\n * - `subscription_update`: The quote will update an existing subscription.\n * - `one_off`: The quote will issue an one-off invoice.\n *\n * @example one_off\n * @enum {string}\n */\n type: \"one_off\";\n /**\n * @description 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.\n * @example inv_0ADWB0lzH52RFt\n */\n invoice_id: string | null;\n });\n Quote: components[\"schemas\"][\"QuoteDraft\"] | components[\"schemas\"][\"QuoteComplete\"] | components[\"schemas\"][\"QuoteVoided\"];\n CreateQuote: {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n *\n * @example draft\n * @enum {string}\n */\n status?: \"draft\" | \"approved\" | \"pending_signature\";\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.\n * @example joe@acme.com\n */\n owner_email?: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id?: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments?: string;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms?: string;\n /**\n * @description Estimated contract value. If not specified, automatically computed from the subscription configuration.\n * @example 20000\n */\n amount?: number | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details?: boolean | (\"true\" | \"false\");\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids?: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription?: boolean | (\"true\" | \"false\");\n } & ({\n /**\n * @description ID of the quote template. If not specified, a subscription configuration must be defined.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string;\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription?: {\n /** @description Subscription custom name. */\n name?: string;\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & {\n /** @description Create a free trial phase based on the plan configuration. */\n trial?: {\n /**\n * @description Defines how the free trial will end.\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\";\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n duration?: {\n /**\n * @description Free trial duration period. Only applies if the end strategy is `duration`.\n * @enum {string}\n */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @description Free trial duration count. Only applies if the end strategy is `duration`. */\n count: number;\n };\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n } | {\n expires_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription: {\n /** @description Subscription custom name. */\n name?: string;\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & {\n /** @description Create a free trial phase based on the plan configuration. */\n trial?: {\n /**\n * @description Defines how the free trial will end.\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\";\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n duration?: {\n /**\n * @description Free trial duration period. Only applies if the end strategy is `duration`.\n * @enum {string}\n */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @description Free trial duration count. Only applies if the end strategy is `duration`. */\n count: number;\n };\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n });\n PaginatedQuote: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Quote. */\n data: components[\"schemas\"][\"Quote\"][];\n };\n SendQuote: {\n /**\n * Format: email\n * @description Email address to which the quote will be sent for signature.\n * @example finance@acme.com\n */\n email: string;\n /**\n * @description Custom message used in the email content.\n * @example Please find attached our proposed quotation.\n */\n message?: string;\n };\n VoidQuote: {\n /**\n * @description Quote voiding reason.\n * @example The customer is ultimately not interested.\n */\n reason: string;\n };\n CreateSubscriptionUpdate: ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n type: \"add_product\" | \"add_item\";\n payload: {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"fee\";\n prices: {\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n }[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"seat\";\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n })[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"dynamic\";\n min_amount?: unknown;\n max_amount?: unknown;\n committed_count?: unknown;\n /** @enum {string|null} */\n usage_interval_type?: \"subscription_commitment\" | \"item_payment_interval\" | \"full_database\" | \"phase_duration\" | \"subscription_duration\" | \"custom\" | null;\n usage_interval_count?: number | null;\n /** @enum {string|null} */\n usage_interval_period?: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\" | null;\n usage_interval_period_start?: string | null;\n only_bill_usage_difference?: boolean | null;\n last_usage_billed?: unknown;\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"add_coupon\";\n payload: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /** @description Coupon expiration date. Only applies to the `custom` coupon frequency. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n expires_at?: string;\n /** @description Coupon first application date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n apply_at?: string;\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids?: string[];\n /**\n * @deprecated\n * @description Deprecated field, please use `product_ids`.\n */\n billing_item_ids?: string[];\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"remove_coupon\";\n payload: {\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n type: \"remove_product\" | \"remove_item\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"update_count\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n count: number;\n };\n }) | ({\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n } & {\n /** @enum {string} */\n type: \"update_prices\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n prices: ({\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n } | {\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"packaged\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n });\n CreateSubscriptionUpdates: {\n /** @enum {string} */\n application_schedule: \"immediately\";\n /** @enum {string} */\n payment_schedule: \"immediately\" | \"next_invoice\";\n /** @enum {string} */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n updates: ({\n type: \"add_product\" | \"add_item\";\n payload: {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"fee\";\n prices: {\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n }[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"seat\";\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n })[];\n } | {\n product_id: string;\n product_name?: string;\n product_description?: string;\n /** @default 1 */\n count: number;\n /** @enum {string} */\n billing_interval_period: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\";\n billing_interval_count: number;\n /** @enum {string} */\n start_or_end: \"start\" | \"end\";\n display_interval_dates_in_description?: boolean;\n /** @enum {string} */\n type: \"dynamic\";\n min_amount?: unknown;\n max_amount?: unknown;\n committed_count?: unknown;\n /** @enum {string|null} */\n usage_interval_type?: \"subscription_commitment\" | \"item_payment_interval\" | \"full_database\" | \"phase_duration\" | \"subscription_duration\" | \"custom\" | null;\n usage_interval_count?: number | null;\n /** @enum {string|null} */\n usage_interval_period?: \"days\" | \"weeks\" | \"quarters\" | \"months\" | \"years\" | \"once\" | \"all\" | null;\n usage_interval_period_start?: string | null;\n only_bill_usage_difference?: boolean | null;\n last_usage_billed?: unknown;\n prices: ({\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n } | {\n type: \"remove_product\" | \"remove_item\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n };\n } | {\n /** @enum {string} */\n type: \"add_coupon\";\n payload: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /** @description Coupon expiration date. Only applies to the `custom` coupon frequency. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n expires_at?: string;\n /** @description Coupon first application date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */\n apply_at?: string;\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids?: string[];\n /**\n * @deprecated\n * @description Deprecated field, please use `product_ids`.\n */\n billing_item_ids?: string[];\n };\n } | {\n /** @enum {string} */\n type: \"remove_coupon\";\n payload: {\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n };\n } | {\n /** @enum {string} */\n type: \"update_count\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n count: number;\n };\n } | {\n /** @enum {string} */\n type: \"update_prices\";\n payload: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n product_id: string;\n prices: ({\n /** @enum {string} */\n type: \"fee\";\n amount: number;\n } | {\n /** @enum {string} */\n type: \"volume\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"packaged\";\n amount: number;\n from: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bulk\";\n amount: number;\n to: number | null;\n /**\n * @default pro_rata\n * @enum {string|null}\n */\n on_bucket_incomplete: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n unit_count?: number;\n } | {\n /** @enum {string} */\n type: \"bps\";\n from: number;\n to: number | null;\n percentage: number;\n per_unit_cap: number | null;\n per_unit_floor: number | null;\n per_unit_fee: number | null;\n })[];\n };\n })[];\n };\n Subscription: {\n /**\n * @description Subscription ID.\n * @example sub_B6ClkdqNqVNBgY\n */\n id: string;\n currency: components[\"schemas\"][\"Currency\"];\n /**\n * @description\n * Subscription status.\n *\n * - `draft`: The subscription is being created, this status is only used in the subscription assignation flow of the UI version of Hyperline.\n * - `pending`: The subscription has been created and won't be charged until it is activated.\n * - `active`: The subscription is running and will be invoiced at the next payment date.\n * - `paused`: The subscription's payment collection is paused.\n * - `cancelled`: The subscription has been canceled from an active state.\n * - `voided`: The subscription has been voided directly from the pending state.\n * - `errored`: We attempted 4 times (3 retries) and failed to charge a subscription's invoice, see [Handling payment errors](https://docs.hyperline.co/docs/payments/payment-errors). We consider the subscription as inactive (as the customer failed to pay you) meaning that we won't invoice the customer in the future nor collect payment. You can choose to reactivate it manually.\n *\n * @example active\n * @enum {string}\n */\n status: \"active\" | \"cancelled\" | \"draft\" | \"errored\" | \"paused\" | \"pending\" | \"voided\";\n /** @description Reference to the purchase order. */\n purchase_order: string | null;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n plan_id: string | null;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id: string;\n /** @description ID of the checkout session. */\n checkout_session_id: string | null;\n /** @description ID of the related opportunity/deal in the connected CRM. */\n crm_opportunity_id: string | null;\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee: number | null;\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the subscription should automatically renew.\n * @example true\n */\n renew_automatically: boolean;\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Strategy used to activate the subscription.\n *\n * - `start_date`: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.\n * - `manually`: The subscription requires activation through a manual action.\n * - `checkout`: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.\n * - `quote`: The subscription will be activated depending on the configuration and the signature of the related quote.\n *\n * @example checkout\n * @enum {string|null}\n */\n activation_strategy: \"start_date\" | \"manually\" | \"checkout\" | \"quote\" | \"contract_start_date\" | null;\n starts_at: components[\"schemas\"][\"DateTime\"] & string;\n contract_start: components[\"schemas\"][\"DateTime\"] & string;\n contract_end: components[\"schemas\"][\"DateTime\"] & unknown;\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n paused_at: components[\"schemas\"][\"DateTime\"] & unknown;\n reactivate_at: components[\"schemas\"][\"DateTime\"] & unknown;\n cancel_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string|null}\n */\n cancellation_strategy: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\" | null;\n cancellation_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n estimated_arr: components[\"schemas\"][\"Amount\"] & (number | null);\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n renews_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description ID of the current subscription phase. */\n current_phase_id: string | null;\n /** @description Key/value pairs to store any information you find useful. */\n properties: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n } | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n SubscriptionProductFee: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"flat_fee\";\n /**\n * @description Number of product units.\n * @example 1\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n };\n SubscriptionProductCredit: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"credit\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Number of product units.\n * @example 2\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: components[\"schemas\"][\"PriceFee\"][];\n };\n SubscriptionProductSeat: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"seat\";\n /**\n * @description Name of the unit.\n * @example user\n */\n unit_name: string | null;\n /**\n * @description Number of product units.\n * @example 2\n */\n count: number;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: (components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"])[];\n };\n SubscriptionProductDynamic: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description: string | null;\n /** @description Indicates if the dates of the interval should be automatically added in the product description on the invoices. */\n description_display_interval_dates: boolean;\n attached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n detached_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_started_at: components[\"schemas\"][\"DateTime\"] & unknown;\n current_period_ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n next_payment_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string|null}\n */\n payment_schedule: \"start\" | \"end\" | null;\n /**\n * @description discriminator enum property added by openapi-typescript\n * @enum {string}\n */\n type: \"dynamic\";\n /**\n * @description Name of the unit.\n * @example hour\n */\n unit_name: string | null;\n /**\n * @description Minimum of units committed. If usage is less than this number, then this value will be used.\n * @example 2000\n */\n min_committed_count: number | null;\n /** @description 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. */\n min_amount: number | null;\n /** @description 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. */\n max_amount: number | null;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n *\n * @enum {string|null}\n */\n metering_interval_type: \"subscription_commitment\" | \"payment_interval\" | \"full_database\" | \"phase_duration\" | null;\n /** @description 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. */\n bill_usage_difference: boolean;\n /** @description Price tiers of the product. If fixed amount, only one price is available. */\n prices: ((components[\"schemas\"][\"PriceVolume\"] | components[\"schemas\"][\"PricePackaged\"] | components[\"schemas\"][\"PriceBulk\"] | components[\"schemas\"][\"PriceBps\"]) & {\n metering_filter: components[\"schemas\"][\"MeteringFilter\"];\n })[];\n };\n /** @description Checkout session of the subscription. */\n CheckoutSession: {\n /**\n * @description Checkout session ID.\n * @example che_hEUPdVG7IgjpW1\n */\n id: string;\n /**\n * @description Checkout session current status.\n * @example opened\n * @enum {string}\n */\n status: \"opened\" | \"completed\" | \"cancelled\" | \"errored\";\n /**\n * @description Types of payment method available on the checkout session.\n * @example [\n * \"card\"\n * ]\n */\n available_payment_methods: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /**\n * Format: uri\n * @description URL to which the user is automatically redirected after the completion of the checkout.\n * @example https://app.hyperline.co/callback/checkout\n */\n redirect_url: string | null;\n send_to: {\n /**\n * Format: email\n * @description Email address to which we'll automatically send a message with the checkout link.\n * @example josh@alpeak.com\n */\n email: string;\n /** @description Custom message to include in the email send. If not provided, we will use a generic one. */\n message: string | null;\n } | null;\n /**\n * Format: uri\n * @description URL to access the checkout session. Only defined if the status is `opened`.\n * @example https://billing.hyperline.co/checkout/che_hEUPdVG7IgjpW1\n */\n url: string;\n } | null;\n SubscriptionDetails: components[\"schemas\"][\"Subscription\"] & {\n /** @description Products that make up the subscription. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons to be applied to the prices of subscription products. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n /** @description Phases of the subscription. */\n phases: {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n }[];\n quote: {\n /**\n * @description ID of the quote from which the subscription was created.\n * @example quo_38YwqvItBH3d8a\n */\n id: string;\n /**\n * @description Status of the quote from which the subscription was created.\n * @example signed\n * @enum {string}\n */\n status: \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"voided\" | \"signed\";\n } | null;\n plan: {\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n id: string;\n /**\n * @description Name of the plan used to create the subscription.\n * @example My example plan\n */\n name: string;\n } | null;\n checkout_session: components[\"schemas\"][\"CheckoutSession\"];\n /**\n * @description Payment method type used to pay the subscription.\n * @enum {string|null}\n */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n payment_method: components[\"schemas\"][\"PaymentMethod\"] & unknown;\n /** @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent */\n generate_draft_invoices: boolean;\n };\n CancelSubscription: {\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Indicates if the cancel should refund the customer using a pro rata strategy. */\n pro_rata?: boolean;\n };\n CreateSubscription: {\n /** @description Subscription custom name. */\n name?: string;\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & ({\n /**\n * @description\n * Strategy used to activate the subscription.\n *\n * - `start_date`: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.\n * - `manually`: The subscription requires activation through a manual action.\n * - `checkout`: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.\n * - `quote`: The subscription will be activated depending on the configuration and the signature of the related quote.\n *\n * @example checkout\n * @enum {string}\n */\n activation_strategy: \"start_date\" | \"manually\" | \"checkout\";\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n } | {\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n }) & {\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n plan_id?: string;\n /**\n * @description\n * Payment method strategy used to bill the subscription. By default, the current payment method of the customer will be used.\n *\n * - `new`: Ask the customer for a new payment method. The customer can fill in their payment method either on the subscription's checkout session or on their portal page.\n * - `current`: Use the current default payment method of the customer.\n * - `external`: Manage the payments of the subscription outside of Hyperline.\n *\n * @example current\n * @enum {string}\n */\n payment_method_strategy?: \"current\" | \"external\" | \"new\";\n /** @description Set the allowed types of payment methods for the customer. Only applies to the `new` payment method strategy. */\n available_payment_method_types?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /** @description [On demand] Will split the subscription into 2 phases, one will contain 'once' products and the other the recurring ones. Call `next-phase` endpoint to transition between the 2 phases. */\n create_setup_phase?: boolean | (\"true\" | \"false\");\n checkout_session?: {\n send_to?: {\n /**\n * Format: email\n * @description Email address to which we'll automatically send a message with the checkout link.\n */\n email: string;\n /** @description Custom message to include in the email send. If not provided, we will use a generic one. */\n message?: string;\n };\n /**\n * Format: uri\n * @description URL to which the user is automatically redirected after the completion of the checkout.\n */\n redirect_url?: string;\n };\n /** @description Create a free trial phase based on the plan configuration. Only applies if a `plan_id` is provided. */\n trial?: {\n /**\n * @description Defines how the free trial will end.\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\";\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n duration?: {\n /**\n * @description Free trial duration period. Only applies if the end strategy is `duration`.\n * @enum {string}\n */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @description Free trial duration count. Only applies if the end strategy is `duration`. */\n count: number;\n };\n };\n /**\n * @description\n * Alignment of product billing cycles. Only applies when creating a subscription from a plan.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n };\n PaginatedSubscription: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of Subscription. */\n data: components[\"schemas\"][\"Subscription\"][];\n };\n LiveBilling: {\n total_amount: number;\n total_discount: number;\n fixed_amount: number;\n billing_items: {\n id: string | null;\n total_amount: number;\n original_amount: number;\n discount_amount: number | null;\n item_name: string;\n tiers: {\n from: number;\n to: number | null;\n amount: number;\n total_amount: number;\n count: number;\n }[];\n }[];\n coupons: {\n id: string | null;\n name: string | null;\n discount_amount: number;\n item_ids: string[];\n }[];\n };\n PaginatedSubscriptionPhase: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of SubscriptionPhase. */\n data: {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n }[];\n };\n TaxRate: {\n /**\n * @description Tax rate ID.\n * @example taxr_YfiSnLIYORD9VN\n */\n id: string;\n /**\n * @description Name of the tax rate.\n * @example VAT\n */\n name: string;\n /**\n * @description Internal description of the tax rate.\n * @example Standard VAT\n */\n description: string | null;\n /**\n * @description Tax rate code identifier.\n * @example STAND_VAT\n */\n code: string;\n /**\n * @description The percentage rate of the tax.\n * @example 20\n */\n rate: number;\n /**\n * @description ID of the invoicing entity to which the tax rate is attached.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id: string;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedTaxRate: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of TaxRate. */\n data: components[\"schemas\"][\"TaxRate\"][];\n };\n App: {\n /** @description App ID */\n id: string;\n /** @description App name */\n name: string;\n /** @description App description */\n description: string | null;\n /** @description App logo URL */\n logo_uri: string | null;\n /** @description List of URLs whitelisted to use as a callback after authentication. */\n callbacks: string[];\n /** @description OAuth client ID */\n client_id: string;\n };\n CreateApp: {\n /** @description App name */\n name: string;\n /** @description App description */\n description?: string;\n /**\n * Format: uri\n * @description App logo URL\n */\n logo_uri?: string;\n /** @description List of URLs whitelisted to use as a callback after authentication. */\n callbacks: string[];\n };\n UpdateApp: {\n /** @description App name */\n name: string;\n /** @description App description */\n description: string | null;\n /**\n * Format: uri\n * @description App logo URL\n */\n logo_uri: string | null;\n /** @description List of URLs whitelisted to use as a callback after authentication. */\n callbacks: string[];\n };\n WalletSettings: {\n /**\n * @description Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in `active` state and with money.\n * @example true\n */\n enabled: boolean;\n /**\n * @description Allow top up for free amounts on wallets.\n * @example true\n */\n allow_free_credits: boolean;\n /**\n * @description Allow wallet top up on customer's portal.\n * @example false\n */\n allow_topup_on_portal: boolean;\n /**\n * @description Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.\n * @example []\n */\n product_ids: string[];\n updated_at: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n UpdateWalletSettings: {\n /**\n * @description Indicates if the wallet feature is enabled or not. If disabled, wallets won't be debited even if they are in `active` state and with money.\n * @example true\n */\n enabled?: boolean;\n /**\n * @description Allow top up for free amounts on wallets.\n * @example true\n */\n allow_free_credits?: boolean;\n /**\n * @description Allow wallet top up on customer's portal.\n * @example false\n */\n allow_topup_on_portal?: boolean;\n /**\n * @description Product IDs on which wallet will apply. If empty, the wallet will apply to all invoice line items.\n * @example []\n */\n product_ids?: string[];\n };\n Wallet: {\n /**\n * @description Wallet ID.\n * @example wal_PPpxP5d3uvgiTT\n */\n id: string;\n /**\n * @description Wallet customer ID.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description Wallet state.\n * @example active\n * @enum {string}\n */\n state: \"active\" | \"paused\";\n currency: components[\"schemas\"][\"Currency\"];\n /** @description Wallet actual balance. Expressed in currency's smallest unit. */\n balance: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n };\n /** @description Wallet projected balance. Automatically computed by Hyperline depending on the customer's active subscriptions and future payments. Expressed in currency's smallest unit. */\n projected_balance: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n };\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example true\n * @enum {boolean}\n */\n is_auto_load_enabled: true;\n /**\n * @description Indicates if the auto-load is free or paid.\n * @example paid\n * @enum {string}\n */\n auto_load_type: \"free\" | \"paid\";\n auto_load_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Interval indicating how often the wallet is auto-loaded.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n auto_load_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n auto_load_next_date: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Indicates if the wallet amount must be reset before auto-load.\n * @example false\n */\n auto_load_reset: boolean;\n } | {\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example false\n * @enum {boolean}\n */\n is_auto_load_enabled: false;\n });\n CreateWallet: {\n /**\n * @description Wallet customer ID.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n } & ({\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example true\n * @enum {boolean}\n */\n is_auto_load_enabled: true;\n /**\n * @description Indicates if the auto-load is free or paid.\n * @example paid\n * @enum {string}\n */\n auto_load_type: \"free\" | \"paid\";\n auto_load_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Interval indicating how often the wallet is auto-loaded.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n auto_load_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n auto_load_next_date: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Indicates if the wallet amount must be reset before auto-load.\n * @example false\n */\n auto_load_reset: boolean;\n } | {\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example false\n * @enum {boolean}\n */\n is_auto_load_enabled?: false;\n });\n UpdateWallet: {\n /**\n * @description Wallet state.\n * @example active\n * @enum {string}\n */\n state?: \"active\" | \"paused\";\n } & ({\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example true\n * @enum {boolean}\n */\n is_auto_load_enabled: true;\n /**\n * @description Indicates if the auto-load is free or paid.\n * @example paid\n * @enum {string}\n */\n auto_load_type: \"free\" | \"paid\";\n auto_load_amount: components[\"schemas\"][\"Amount\"] & unknown;\n /**\n * @description Interval indicating how often the wallet is auto-loaded.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n auto_load_interval: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n auto_load_next_date: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description Indicates if the wallet amount must be reset before auto-load.\n * @example false\n */\n auto_load_reset: boolean;\n } | {\n /**\n * @description Indicates if the wallet is auto-loaded regularly.\n * @example false\n * @enum {boolean}\n */\n is_auto_load_enabled?: false;\n });\n LoadWallet: {\n amount?: components[\"schemas\"][\"Amount\"] & unknown;\n amount_free?: components[\"schemas\"][\"Amount\"] & unknown;\n };\n WalletTransaction: {\n /**\n * @description Wallet transaction ID.\n * @example walt_FCihRDLYhKpSpL\n */\n id: string;\n /**\n * @description Wallet transaction type.\n * @example credit_paid\n * @enum {string}\n */\n type: \"credit_free\" | \"credit_paid\" | \"debit\";\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Generated invoice ID for the transaction. Only applies for `credit_paid` and `debit`. */\n invoice_id: string | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n PaginatedWalletTransaction: {\n meta: {\n /**\n * @description Total of existing items.\n * @example 1\n */\n total: number;\n /**\n * @description Number of items returned.\n * @example 1\n */\n taken: number;\n /**\n * @description Number of items skipped.\n * @example 0\n */\n skipped: number;\n };\n /** @description List of WalletTransaction. */\n data: components[\"schemas\"][\"WalletTransaction\"][];\n };\n WebhookEndpoint: {\n /**\n * @description Webhook endpoint ID.\n * @example ep_1srOrx2ZWZBpBUvZwXKQmoEYga2\n */\n id: string;\n /**\n * @description Webhook endpoint description.\n * @example Production webhook endpoint\n */\n description: string;\n /**\n * Format: uri\n * @description Webhook endpoint URL.\n * @example https://example.com/webhook\n */\n url: string;\n /** @description Webhook rate limit (per second). */\n rate_limit: number | null;\n /**\n * @description Webhook event types filter. If not defined, all event messages will be sent.\n * @example [\n * \"customer.created\",\n * \"customer.updated\"\n * ]\n */\n event_types: (\"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\")[] | null;\n /**\n * Format: date-time\n * @description Webhook creation date.\n * @example 2024-01-20T16:04:11Z\n */\n created_at: string;\n };\n PaginatedWebhookEndpoint: {\n meta: {\n iterator: string | null;\n };\n data: components[\"schemas\"][\"WebhookEndpoint\"][];\n };\n WebhookMessage: {\n /**\n * @description Webhook message ID.\n * @example msg_1srOrx2ZWZBpBUvZwXKQmoEYga2\n */\n id: string;\n /**\n * @description Unique ID corresponding to the event occurrence in the Hyperline system.\n * @example evt_9avP4zLks7L1yh\n */\n event_id: string;\n /** @description Webhook message payload. */\n payload: {\n /**\n * @description Event type.\n * @enum {string}\n */\n event_type: \"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\";\n /** @description Depends on the type of event, see the [event catalog](https://app.hyperline.co/app/settings/webhooks) for more details. */\n data: Record<string, never>;\n } | \"EXPUNGED\";\n /**\n * Format: date-time\n * @description Date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-01-20T16:04:11Z\n */\n sent_at: string;\n };\n PaginatedWebhookMessage: {\n meta: {\n iterator: string | null;\n };\n data: components[\"schemas\"][\"WebhookMessage\"][];\n };\n };\n responses: never;\n parameters: never;\n requestBodies: never;\n headers: never;\n pathItems: never;\n}\nexport type $defs = Record<string, never>;\nexport interface operations {\n getInvoices: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n id?: string;\n id__not?: string;\n id__isNull?: string;\n id__isNotNull?: string;\n id__equals?: string;\n id__contains?: string;\n id__startsWith?: string;\n id__endWith?: string;\n customerId?: string;\n customerId__not?: string;\n customerId__isNull?: string;\n customerId__isNotNull?: string;\n customerId__equals?: string;\n customerId__contains?: string;\n customerId__startsWith?: string;\n customerId__endWith?: string;\n customerName?: string;\n customerName__not?: string;\n customerName__isNull?: string;\n customerName__isNotNull?: string;\n customerName__equals?: string;\n customerName__contains?: string;\n customerName__startsWith?: string;\n customerName__endWith?: string;\n invoiceNumber?: string;\n invoiceNumber__not?: string;\n invoiceNumber__isNull?: string;\n invoiceNumber__isNotNull?: string;\n invoiceNumber__equals?: string;\n invoiceNumber__contains?: string;\n invoiceNumber__startsWith?: string;\n invoiceNumber__endWith?: string;\n dueDate?: string;\n dueDate__not?: string;\n dueDate__isNull?: string;\n dueDate__isNotNull?: string;\n dueDate__equals?: string;\n dueDate__lt?: string;\n dueDate__lte?: string;\n dueDate__gt?: string;\n dueDate__gte?: string;\n emissionDate?: string;\n emissionDate__not?: string;\n emissionDate__isNull?: string;\n emissionDate__isNotNull?: string;\n emissionDate__equals?: string;\n emissionDate__lt?: string;\n emissionDate__lte?: string;\n emissionDate__gt?: string;\n emissionDate__gte?: string;\n periodStart?: string;\n periodStart__not?: string;\n periodStart__isNull?: string;\n periodStart__isNotNull?: string;\n periodStart__equals?: string;\n periodStart__lt?: string;\n periodStart__lte?: string;\n periodStart__gt?: string;\n periodStart__gte?: string;\n periodEnd?: string;\n periodEnd__not?: string;\n periodEnd__isNull?: string;\n periodEnd__isNotNull?: string;\n periodEnd__equals?: string;\n periodEnd__lt?: string;\n periodEnd__lte?: string;\n periodEnd__gt?: string;\n periodEnd__gte?: string;\n updatedAt?: string;\n updatedAt__not?: string;\n updatedAt__isNull?: string;\n updatedAt__isNotNull?: string;\n updatedAt__equals?: string;\n updatedAt__lt?: string;\n updatedAt__lte?: string;\n updatedAt__gt?: string;\n updatedAt__gte?: string;\n settledAt?: string;\n settledAt__not?: string;\n settledAt__isNull?: string;\n settledAt__isNotNull?: string;\n settledAt__equals?: string;\n settledAt__lt?: string;\n settledAt__lte?: string;\n settledAt__gt?: string;\n settledAt__gte?: string;\n originalQuoteId?: string;\n originalQuoteId__not?: string;\n originalQuoteId__isNull?: string;\n originalQuoteId__isNotNull?: string;\n originalQuoteId__equals?: string;\n originalQuoteId__contains?: string;\n originalQuoteId__startsWith?: string;\n originalQuoteId__endWith?: string;\n subscriptionId?: string;\n subscriptionId__not?: string;\n subscriptionId__isNull?: string;\n subscriptionId__isNotNull?: string;\n subscriptionId__equals?: string;\n subscriptionId__contains?: string;\n subscriptionId__startsWith?: string;\n subscriptionId__endWith?: string;\n invoicingEntityId?: string;\n invoicingEntityId__not?: string;\n invoicingEntityId__isNull?: string;\n invoicingEntityId__isNotNull?: string;\n invoicingEntityId__equals?: string;\n invoicingEntityId__contains?: string;\n invoicingEntityId__startsWith?: string;\n invoicingEntityId__endWith?: string;\n status?: (\"all\" | \"open\" | \"grace_period\" | \"to_pay\" | \"to_reconcile\" | \"error\" | \"paid\" | \"partially_paid\" | \"outstanding\" | \"refunded\" | \"document\" | \"late\" | \"draft\" | \"voided\" | \"closed\") | string;\n status__in?: (\"all\" | \"open\" | \"grace_period\" | \"to_pay\" | \"to_reconcile\" | \"error\" | \"paid\" | \"partially_paid\" | \"outstanding\" | \"refunded\" | \"document\" | \"late\" | \"draft\" | \"voided\" | \"closed\") | string;\n type?: (\"invoice\" | \"refund\" | \"document\") | string;\n type__in?: (\"invoice\" | \"refund\" | \"document\") | string;\n paymentMethod?: (\"card\" | \"transfer\" | \"external\" | \"missing\" | \"direct_debit\" | \"direct_debit_sepa\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"wallet\") | string;\n paymentMethod__in?: (\"card\" | \"transfer\" | \"external\" | \"missing\" | \"direct_debit\" | \"direct_debit_sepa\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"wallet\") | string;\n search?: string;\n category?: (\"refund\" | \"subscription\" | \"otp\") | string;\n category__in?: (\"refund\" | \"subscription\" | \"otp\") | string;\n customer_external_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedInvoice\"];\n };\n };\n };\n };\n createInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create invoice payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateInvoice\"];\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n createInvoices: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create invoices payload */\n requestBody?: {\n content: {\n \"application/json\": (components[\"schemas\"][\"CreateInvoice\"] & {\n /**\n * @description A unique identifier for the invoices in the batch\n * @example invoice-123\n */\n batch_invoice_id: string;\n })[];\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n successes: (components[\"schemas\"][\"Invoice\"] & {\n transactions: ({\n /**\n * @description Transaction ID.\n * @example tra_2QdJDDUej969ev\n */\n id: string;\n /**\n * @description\n * Transaction type.\n *\n * - `subscription`: The transaction is related to a subscription payment.\n * - `one_time`: The transaction is related to a one-time payment.\n * - `refund`: The transaction is related to a refund payment.\n *\n * @example subscription\n * @enum {string}\n */\n type: \"subscription\" | \"one_time\" | \"refund\";\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description ID of the customer linked to the transaction.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the transaction on the payment provider (Stripe, Mollie, GoCardless, ...) side.\n * @example pi_xxxxxxxxxx\n */\n provider_id: string | null;\n process_at: components[\"schemas\"][\"DateTime\"] & string;\n refunded_at: components[\"schemas\"][\"DateTime\"] & unknown;\n last_refreshed_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Fee applied by the Payment Service Provider. Only supported for Stripe. */\n provider_fee: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"];\n exchange_rate: number | null;\n } | null;\n /** @description Chargeback details related to the transaction. */\n chargeback: {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n last_chargeback_at: components[\"schemas\"][\"DateTime\"] & string;\n } | null;\n } & ({\n /** @enum {string} */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\";\n payment_method: components[\"schemas\"][\"PaymentMethod\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"transfer\" | \"transfer_automated\";\n bank_account: components[\"schemas\"][\"BankAccount\"];\n } | {\n /** @enum {string} */\n payment_method_type: \"wallet\";\n /** @example wal_PPpxP5d3uvgiTT */\n wallet_id: string;\n } | {\n /** @enum {string} */\n payment_method_type: \"external\";\n }) & ({\n /**\n * @description\n * Transaction status.\n *\n * - `scheduled`: The transaction is scheduled to be processed in the future.\n * - `to_process`: The transaction is waiting to be processed by our system.\n * - `pending`: The transaction has been authorized by the related payment processor, but the banking transaction is not yet settled.\n * - `settled`: The transaction has been cleared on the banking side, the money transfer is fully completed.\n * - `cancelled`: The transaction has been cancelled and won't be processed again.\n *\n * @example settled\n * @enum {string}\n */\n status: \"scheduled\" | \"to_process\" | \"pending\" | \"settled\" | \"cancelled\";\n } | {\n /**\n * @description\n * Transaction status.\n *\n * - `failed`: The transaction failed.\n *\n * @example failed\n * @enum {string}\n */\n status: \"failed\";\n /**\n * @description\n * Transaction error type.\n *\n * - `authentication_required`: The card was declined as the transaction requires authentication (e.g. 3-D Secure). The customer should go to their portal page and authenticate their card. If the error happened on an already authenticated transaction, the customer needs to contact their card issuer for more information.\n * - `payment_method_authorization_error`: A transaction authorization cannot be created for a variety of reasons such as the card issuer couldn't be reached, or the card requires a PIN.\n * - `payment_method_declined`: The payment method was declined for a variety of reasons such as a card reported as lost or stolen, insufficient funds or reaching the limit available on the method to complete the purchase, a payment method on a known block list, etc.\n * - `payment_method_expired`: The payment method is expired. The customer should go to their portal page and change their payment method.\n * - `payment_method_invalid`: The payment method is invalid in most cases because of incorrect details (card/account number, CVC, expiration date, postal code).\n * - `payment_method_not_supported`: The payment method doesn't support this type of purchase (e.g. currency, online payment).\n * - `declined`: The payment was declined for a variety of reasons such as security violation, banking service not available, transaction not allowed, etc.\n * - `fraud`: The payment provider suspected the transaction was fraudulent and has been blocked. Don't report more detailed information to your customer, and check on your provider account.\n * - `processing_error`: The payment couldn't be processed by the issuer for an unknown reason.\n * - `provider_error`: An error occurred when contacting the payment provider to initiate the transaction.\n * - `unknown`: A generic error happened on the payment provider side.\n *\n * @enum {string|null}\n */\n error_type: \"authentication_required\" | \"declined\" | \"fraud\" | \"payment_method_authorization_error\" | \"payment_method_declined\" | \"payment_method_expired\" | \"payment_method_invalid\" | \"payment_method_not_supported\" | \"processing_error\" | \"provider_error\" | \"unknown\" | null;\n /** @description Details of the error. */\n error_message: string | null;\n }))[];\n coupons: {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n discount_amount: components[\"schemas\"][\"Amount\"] & (number | null);\n /** @description Percentage to apply as a discount on the amount (excluding taxes) of a product. */\n discount_percent: number | null;\n /**\n * @description IDs of the line items to which the coupon applies.\n * @example [\n * \"ili_0FACNpeoEFkGu3\"\n * ]\n */\n line_item_ids: string[];\n }[];\n } & {\n /**\n * @description A unique identifier for the invoices in the batch\n * @example invoice-123\n */\n batch_invoice_id: string;\n })[];\n errors: {\n error?: unknown;\n batch_invoice_id: string;\n }[];\n };\n };\n };\n };\n };\n validateInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n chargeInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Payment method used to execute the payment. This payment method will override any previously set method on the invoice.\n * @example pm_1xMpj5bwRqN7LM\n */\n payment_method_id?: string;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n voidInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Indicates if an email for the generated credit note should be sent to the customer.\n * @default true\n */\n send_email?: boolean;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n };\n };\n getInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n updateInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update invoice payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateInvoice\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n uploadPdfToInvoice: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"multipart/form-data\": {\n file: components[\"schemas\"][\"File\"];\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": Record<string, never>;\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n downloadInvoice: {\n parameters: {\n query?: {\n lang?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n locale?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Download an invoice PDF file */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/pdf\": unknown;\n };\n };\n /** @description Invoice or file not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n createInvoiceTransaction: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Create invoice transaction payload */\n requestBody?: {\n content: {\n \"application/json\": {\n amount: components[\"schemas\"][\"Amount\"] & unknown;\n process_at: components[\"schemas\"][\"DateTime\"] & string;\n } & ({\n /**\n * @description Payment method used to execute the transaction. Only applies to scheduled transactions with a process_at date in the future.\n * @example pm_1xMpj5bwRqN7LM\n */\n payment_method_id: string;\n } | {\n /** @enum {string} */\n payment_method_type: \"transfer\";\n /**\n * @description Bank account linked to the transaction.\n * @example bac_KJyPrMA1toAqRG\n */\n bank_account_id?: string;\n } | {\n /** @enum {string} */\n payment_method_type?: \"external\";\n });\n };\n };\n responses: {\n /** @description The invoice with the newly created transaction */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"InvoiceDetails\"];\n };\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteInvoiceTransaction: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n transactionId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n /** @description Invoice not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getAnalytics: {\n parameters: {\n query?: {\n invoicing_entity_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n revenue_last_30_days: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Churn of the last 30 days. Churn corresponds to the number of customers who churned divided by the number of active customers. A churned customer is one who had a subscription but no longer has an active one. */\n churn_30_days: number;\n churned_revenue_30_days: components[\"schemas\"][\"Amount\"] & unknown;\n arr: components[\"schemas\"][\"Amount\"] & unknown;\n mrr: components[\"schemas\"][\"Amount\"] & unknown;\n pending_arr: components[\"schemas\"][\"Amount\"] & unknown;\n active_arr: components[\"schemas\"][\"Amount\"] & unknown;\n arr_in_discounts: components[\"schemas\"][\"Amount\"] & unknown;\n fixed_arr: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Number of customers with an assigned subscriptions. */\n active_customers: number;\n /** @description Average Revenue Per Account (customer). */\n arpa: number;\n };\n };\n };\n };\n };\n getCompanies: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCompany\"];\n };\n };\n };\n };\n createCompany: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Company name.\n * @example Acme\n */\n name: string;\n address: components[\"schemas\"][\"Address\"] ;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Company ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string;\n /**\n * @description Company name.\n * @example Acme\n */\n name: string;\n /** @description Logo URL of the default invoicing entity. */\n logo_url: string | null;\n /** @description Favicon URL of the default invoicing entity. */\n favicon_url: string | null;\n address: components[\"schemas\"][\"Address\"] ;\n };\n };\n };\n };\n };\n getCoupons: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCoupon\"];\n };\n };\n };\n };\n createCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create coupon payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCoupon\"];\n };\n };\n responses: {\n /** @description The newly created coupon */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Coupon\"];\n };\n };\n };\n };\n getCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Coupon\"] & {\n deletedAt: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n };\n };\n /** @description Coupon not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateCoupon\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Coupon\"];\n };\n };\n /** @description Coupon not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteCoupon: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer deleted */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n /** @description Coupon not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getCustomProperties: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCustomProperty\"];\n };\n };\n };\n };\n createCustomProperty: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n name: string;\n /** @enum {string} */\n type: \"date\" | \"boolean\" | \"number\" | \"text\" | \"select\";\n slug: string;\n entities: (\"customer\" | \"product\" | \"plan\" | \"quote\" | \"subscription\")[];\n /** @default false */\n api_only?: boolean | null;\n authorized_values?: string[] | null;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomProperty\"];\n };\n };\n };\n };\n updateCustomProperty: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n name: string;\n /** @enum {string} */\n type: \"date\" | \"boolean\" | \"number\" | \"text\" | \"select\";\n slug: string;\n entities: (\"customer\" | \"product\" | \"plan\" | \"quote\" | \"subscription\")[];\n /** @default false */\n api_only?: boolean | null;\n authorized_values?: string[] | null;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomProperty\"];\n };\n };\n };\n };\n deleteCustomProperty: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n listCustomerCredits: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCredit\"];\n };\n };\n };\n };\n createCreditForProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Create credit payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCredit\"];\n };\n };\n responses: {\n /** @description Credit created */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Credit\"];\n };\n };\n };\n };\n getOneCreditForCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Credit\"];\n };\n };\n };\n };\n listCreditTransactionsForCustomer: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n id?: string | null;\n type?: string | null;\n invoice_id?: string | null;\n created_at?: string | null;\n };\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCreditTransaction\"];\n };\n };\n };\n };\n purchaseCredits: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n /** @description Credit purchase payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCreditPurchase\"];\n };\n };\n responses: {\n /** @description Invoice ID and balance after purchase */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n invoice_id: string;\n new_credit_balance: number;\n };\n };\n };\n };\n };\n usageCredits: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n /** @description Credit topup payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCreditTopup\"];\n };\n };\n responses: {\n /** @description The created credit transaction */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CreditTransaction\"];\n };\n };\n };\n };\n createUsageEntry: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n productId: string;\n };\n cookie?: never;\n };\n /** @description Credit usage entry payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCreditUsage\"];\n };\n };\n responses: {\n /** @description The created credit transaction */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CreditTransaction\"];\n };\n };\n };\n };\n getCustomers: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n id?: string;\n id__not?: string;\n id__isNull?: string;\n id__isNotNull?: string;\n id__equals?: string;\n id__contains?: string;\n id__startsWith?: string;\n id__endWith?: string;\n name?: string;\n name__not?: string;\n name__isNull?: string;\n name__isNotNull?: string;\n name__equals?: string;\n name__contains?: string;\n name__startsWith?: string;\n name__endWith?: string;\n type?: string;\n type__not?: string;\n type__isNull?: string;\n type__isNotNull?: string;\n type__equals?: string;\n type__contains?: string;\n type__startsWith?: string;\n type__endWith?: string;\n status?: (\"all\" | \"active\" | \"inactive\" | \"imported\" | \"archived\") | string;\n status__in?: (\"all\" | \"active\" | \"inactive\" | \"imported\" | \"archived\") | string;\n currency?: string;\n currency__not?: string;\n currency__isNull?: string;\n currency__isNotNull?: string;\n currency__equals?: string;\n currency__contains?: string;\n currency__startsWith?: string;\n currency__endWith?: string;\n country?: string;\n country__not?: string;\n country__isNull?: string;\n country__isNotNull?: string;\n country__equals?: string;\n country__contains?: string;\n country__startsWith?: string;\n country__endWith?: string;\n vat_number?: string;\n vat_number__not?: string;\n vat_number__isNull?: string;\n vat_number__isNotNull?: string;\n vat_number__equals?: string;\n vat_number__contains?: string;\n vat_number__startsWith?: string;\n vat_number__endWith?: string;\n external_id?: string;\n external_id__not?: string;\n external_id__isNull?: string;\n external_id__isNotNull?: string;\n external_id__equals?: string;\n external_id__contains?: string;\n external_id__startsWith?: string;\n external_id__endWith?: string;\n billing_email?: string;\n billing_email__not?: string;\n billing_email__isNull?: string;\n billing_email__isNotNull?: string;\n billing_email__equals?: string;\n billing_email__contains?: string;\n billing_email__startsWith?: string;\n billing_email__endWith?: string;\n search?: string;\n subscription_status?: (\"active\" | \"pending\" | \"cancelled\" | \"paused\" | \"trialing\" | \"errored\" | \"draft\" | \"none\") | string;\n subscription_status__in?: (\"active\" | \"pending\" | \"cancelled\" | \"paused\" | \"trialing\" | \"errored\" | \"draft\" | \"none\") | string;\n invoicing_entity_id?: string;\n invoicing_entity_id__not?: string;\n invoicing_entity_id__isNull?: string;\n invoicing_entity_id__isNotNull?: string;\n invoicing_entity_id__equals?: string;\n invoicing_entity_id__contains?: string;\n invoicing_entity_id__startsWith?: string;\n invoicing_entity_id__endWith?: string;\n custom_properties?: string;\n created_at?: string;\n created_at__not?: string;\n created_at__isNull?: string;\n created_at__isNotNull?: string;\n created_at__equals?: string;\n created_at__lt?: string;\n created_at__lte?: string;\n created_at__gt?: string;\n created_at__gte?: string;\n updated_at?: string;\n updated_at__not?: string;\n updated_at__isNull?: string;\n updated_at__isNotNull?: string;\n updated_at__equals?: string;\n updated_at__lt?: string;\n updated_at__lte?: string;\n updated_at__gt?: string;\n updated_at__gte?: string;\n payment_method_type?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"external\" | \"missing\") | string;\n payment_method_type__in?: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"external\" | \"missing\") | string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedCustomer\"];\n };\n };\n };\n };\n createCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create customer payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateCustomer\"];\n };\n };\n responses: {\n /** @description The newly created customer */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomerDetails\"];\n };\n };\n };\n };\n getCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomerDetails\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateCustomer\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"CustomerDetails\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n deleteCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer deleted */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getCustomerPortalUrl: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n url: string;\n };\n };\n };\n };\n };\n archiveCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer archived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Customer\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n unarchiveCustomer: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Customer unarchived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Customer\"];\n };\n };\n /** @description Customer not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n bulkUpdateCustomersProviders: {\n parameters: {\n query?: {\n sync?: boolean | (\"true\" | \"false\");\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Customer ID.\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @description Provider name.\n * @enum {string}\n */\n provider_name: \"mollie\" | \"stripe\" | \"gocardless\" | \"airwallex\" | \"hubspot\" | \"salesforce\" | \"xero\" | \"exact-online\" | \"pennylane\";\n /** @description Provider ID. Required if multiple instances of the same provider are connected in Hyperline. */\n provider_id?: string;\n /** @description ID of the customer on the provider side. Using a null value will reset the previously saved ID. */\n provider_account_id: string | null;\n }[];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /** @description Number of record successfully updated. */\n successful: number;\n /** @description Number of record expected to be updated. */\n expected: number;\n /** @description Customer IDs that were successfully updated. */\n updated: string[];\n };\n };\n };\n };\n };\n getCustomerTaxRates: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Tax rate scheme.\n *\n * - `exempt`: The customer is exempt from tax.\n * - `standard`: The customer is subject to standard tax.\n * - `reverse_charge`: The customer is subject to reverse charge tax.\n * - `manual`: The customer tax rate is manually set.\n * - `not_eligible`: The customer is not eligible for tax.\n *\n * @enum {string}\n */\n scheme: \"exempt\" | \"standard\" | \"reverse_charge\" | \"manual\" | \"not_eligible\";\n /** @description Tax rate percentage. */\n rate: number;\n }[];\n };\n };\n };\n };\n getOrganisation: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Organisation\"];\n };\n };\n /** @description Organisation not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n patchOrganisation: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"PatchOrganisation\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Organisation\"];\n };\n };\n /** @description Organisation not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n listCustomerPaymentMethods: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedPaymentMethod\"];\n };\n };\n };\n };\n getCustomerPaymentMethod: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n paymentMethodId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaymentMethod\"] & (components[\"schemas\"][\"PaymentMethodCard\"] | components[\"schemas\"][\"PaymentMethodDirectDebit\"]);\n };\n };\n };\n };\n deleteCustomerPaymentMethod: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n paymentMethodId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n createComponentToken: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create component token payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateComponentToken\"];\n };\n };\n responses: {\n /** @description The newly created token */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n token: string;\n /** @enum {string} */\n token_type: \"bearer\";\n };\n };\n };\n };\n };\n getInvoicingEntities: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedInvoicingEntity\"];\n };\n };\n };\n };\n createInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default?: boolean;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone?: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id?: string | null;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email?: string | null;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1?: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2?: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code?: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state?: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city?: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n accounting_currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern?: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern?: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern?: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number?: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number?: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number?: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay?: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration?: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay?: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay?: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees?: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer?: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer?: string | null;\n /**\n * @description The footer text to be used in quotes.\n * @example Thank you for your business.\n */\n quote_footer?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url?: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color?: string | null;\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n };\n };\n };\n };\n };\n getInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n };\n };\n };\n };\n };\n updateInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name?: string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id?: string | null;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email?: string | null;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone?: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language?: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default?: boolean;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1?: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2?: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code?: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state?: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city?: string | null;\n country?: components[\"schemas\"][\"Country\"] & string;\n currency?: components[\"schemas\"][\"Currency\"] & unknown;\n accounting_currency?: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern?: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern?: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern?: string;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay?: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration?: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay?: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay?: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees?: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer?: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url?: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url?: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color?: string | null;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description The unique identifier for the invoicing entity.\n * @example inv123\n */\n id: string;\n /**\n * @description The name of the invoicing entity.\n * @example Acme Corp\n */\n name: string;\n /**\n * @description The trade name of the invoicing entity.\n * @example Acme\n */\n trade_name?: string;\n /**\n * @description The timezone the invoicing entity operates in.\n * @example America/New_York\n */\n timezone: string;\n /**\n * @description The default language of the invoicing entity.\n * @example en\n * @enum {string}\n */\n language: \"fr\" | \"en\" | \"de\" | \"it\" | \"nl\" | \"es\" | \"pt\" | \"pl\";\n /**\n * @description Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.\n * @example true\n */\n is_default: boolean;\n currency: components[\"schemas\"][\"Currency\"] & unknown;\n /**\n * @description The currency used for accounting purposes.\n * @example USD\n */\n accounting_currency: string;\n /**\n * @description The first line of the address for the invoicing entity.\n * @example 123 Elm St\n */\n address_line1: string | null;\n /**\n * @description The second line of the address for the invoicing entity.\n * @example Suite 5\n */\n address_line2: string | null;\n /**\n * @description The postal code for the invoicing entity's address.\n * @example 10001\n */\n zip_code: string | null;\n /**\n * @description The state or province of the invoicing entity.\n * @example NY\n */\n state: string | null;\n /**\n * @description The city of the invoicing entity.\n * @example New York\n */\n city: string | null;\n country: components[\"schemas\"][\"Country\"] & string;\n /**\n * @description The tax identification number of the invoicing entity.\n * @example 123456789\n */\n tax_id: string | null;\n /**\n * @description Boolean indicating whether the tax ID is valid.\n * @example true\n */\n tax_id_valid?: boolean;\n /**\n * Format: email\n * @description The billing email address for the invoicing entity.\n * @example billing@acmecorp.com\n */\n billing_email: string | null;\n /**\n * @description The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example INV-#####\n */\n invoice_number_pattern: string;\n /**\n * @description The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example CN-#####\n */\n credit_note_number_pattern: string;\n /**\n * @description The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.\n * @example DOC-#####\n */\n document_number_pattern: string;\n /**\n * @description The next invoice number to be used.\n * @example 1001\n */\n next_invoice_number: number;\n /**\n * @description The next credit note number to be used.\n * @example 201\n */\n next_credit_note_number: number;\n /**\n * @description The next document number to be used.\n * @example 1501\n */\n next_document_number: number;\n /**\n * @description The default payment term in days.\n * @example 30\n */\n default_payment_delay: number;\n /**\n * @description The grace period duration in days.\n * @example 7\n */\n invoice_grace_period_duration: number;\n /**\n * @description The payment initiation delay in days for the invoices.\n * @example 2\n */\n invoice_payment_initiation_delay: number | null;\n /**\n * @description The payment initiation delay in days for the custom documents.\n * @example 2\n */\n document_payment_initiation_delay: number | null;\n /**\n * @description The late fees applicable to the invoices.\n * @example 2% per month\n */\n invoice_late_fees: string | null;\n /**\n * @description The footer text to be used in invoices.\n * @example Thank you for your business.\n */\n invoice_footer: string | null;\n /**\n * @description The footer text to be used in documents. If not specified, the invoice footer will be used.\n * @example Thank you for your business.\n */\n document_footer: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used in invoices.\n * @example http://example.com/logo.png\n */\n logo_url: string | null;\n /**\n * Format: uri\n * @description URL of the logo to be used as favicon.\n * @example http://example.com/logo.png\n */\n favicon_url: string | null;\n /**\n * @description Brand color to be used in invoices (hexadecimal color code).\n * @example #FF5733\n */\n brand_color: string | null;\n /**\n * @description The creation date of the invoicing entity.\n * @example 2024-01-01T00:00:00Z\n */\n created_at: string;\n /**\n * @description The last update date of the invoicing entity.\n * @example 2024-04-01T00:00:00Z\n */\n updated_at: string;\n /** @description The date the invoicing entity was deleted, if applicable. */\n deleted_at: string | null;\n };\n };\n };\n };\n };\n deleteInvoicingEntity: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n getUserInfo: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description User given name.\n * @example John\n */\n given_name: string | null;\n /**\n * @description User family name.\n * @example Doe\n */\n family_name: string | null;\n /**\n * @description User full name.\n * @example John Doe\n */\n name: string | null;\n /**\n * Format: uri\n * @description User picture URL.\n * @example https://...\n */\n picture: string | null;\n /**\n * Format: email\n * @description User email.\n * @example john@doe.com\n */\n email: string;\n /**\n * @description Indicates if the user email is verified.\n * @example true\n */\n email_verified: boolean;\n };\n };\n };\n };\n };\n authorize: {\n parameters: {\n query: {\n client_id: string;\n audience?: string;\n scope?: string;\n response_type: \"code\";\n redirect_uri: string;\n state: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 302: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n generateTokens: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /** @description Application's client ID. */\n client_id: string;\n /** @description Application's client secret. */\n client_secret: string;\n } & ({\n /**\n * @description To exchange an auth code for an app access token, use `authorization_code`.\n * @enum {string}\n */\n grant_type: \"authorization_code\";\n /** @description The auth code received when creating the authorization. */\n code: string;\n /** @description Must match the value set at the `GET /authorize` endpoint. */\n redirect_uri: string;\n } | {\n /**\n * @description To renew an app access token with a refresh token, use `refresh_token`.\n * @enum {string}\n */\n grant_type: \"refresh_token\";\n /** @description The refresh token received when creating the authorization. */\n refresh_token: string;\n });\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /** @description Access token with which you will be able to access the Hyperline API on the organisation's behalf. */\n access_token: string;\n /** @description Refresh token with which you will be able to retrieve a new access token on this endpoint. The refresh token does not expire. */\n refresh_token?: string;\n /** @description The number of seconds left before the app access token expires. Be sure to renew your app access token before this reaches zero. */\n expires_in: number;\n /** @enum {string} */\n token_type: \"bearer\";\n };\n };\n };\n };\n };\n revokeToken: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /** @description Application's client ID. */\n client_id: string;\n /** @description Application's client secret. */\n client_secret: string;\n /** @description The refresh token to revoke. */\n token: string;\n };\n };\n };\n responses: {\n /** @description Token revoked */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n createPayment: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create payment payload */\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description\n * Payment type.\n *\n * - `one_time`: One-time payment, generating one-off invoice.\n *\n * @example one_time\n * @enum {string}\n */\n type: \"one_time\";\n /**\n * @description ID of the customer.\n * @example cus_Typ0px2W0aiEtl\n */\n customer_id: string;\n /**\n * @deprecated\n * @description Deprecated, please use `products`.\n */\n items?: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name. Allow to override the value from the catalog.\n * @example Product name\n */\n name?: string;\n amount?: components[\"schemas\"][\"Amount\"] & unknown;\n }[];\n /** @description Products composing the related invoice. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_3kXODDF42QXtnL\n */\n id: string;\n /**\n * @description Product name. Allow to override the value from the catalog.\n * @example Product name\n */\n name?: string;\n amount?: components[\"schemas\"][\"Amount\"] & unknown;\n }[];\n /** @description Purchase order added on the generated invoice. */\n purchase_order?: string;\n /** @description Custom note added on the generated invoice. */\n custom_note?: string;\n } & ({\n /**\n * @description\n * Charging method.\n *\n * - `immediately`: Customer's payment method will be charged directly to pay the invoice.\n * - `checkout`: Dedicated checkout page will be created for the customer to pay the invoice.\n *\n * @enum {string}\n */\n charging_method: \"immediately\";\n /**\n * @description Type of payment method to use to pay the invoice. If not specified, the payment_method_id or the default customer payment method is used.\n * @enum {string}\n */\n payment_method_type?: \"transfer\" | \"external\";\n /**\n * @description ID of the payment method to use to pay the invoice. Ignored if payment_method_type is specified.\n * @example pm_1ryTrMj4TTAT1N\n */\n payment_method_id?: string;\n } | {\n /**\n * @description\n * Charging method.\n *\n * - `immediately`: Customer's payment method will be charged directly to pay the invoice.\n * - `checkout`: Dedicated checkout page will be created for the customer to pay the invoice.\n *\n * @enum {string}\n */\n charging_method: \"checkout\";\n available_payment_methods: (\"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\")[];\n /** @description Only applies to `checkout` charging method. */\n checkout_session?: {\n /** @description Details to send email to the payer receiving the checkout. */\n send_to?: {\n /** Format: email */\n email: string;\n customMessage?: string;\n };\n /**\n * Format: uri\n * @description URL to which the user is automatically redirected after the completion of the checkout.\n */\n redirect_url?: string;\n };\n });\n };\n };\n responses: {\n /** @description The reference to the created invoice and optionally the checkout */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /** @description Created invoice ID. */\n invoice_id: string;\n /** @description Payment checkout session. */\n checkout?: {\n /** @description Checkout session ID. */\n id: string;\n /** @description URL to which the user is automatically redirected after the completion of the checkout. */\n url: string;\n };\n };\n };\n };\n };\n };\n getProducts: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n price_book_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedProduct\"];\n };\n };\n };\n };\n createProduct: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create product payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateProduct\"];\n };\n };\n responses: {\n /** @description The newly created product */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n };\n };\n getProduct: {\n parameters: {\n query?: {\n price_book_id?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n };\n };\n updateProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update product payload */\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Product name.\n * @example Product name\n */\n name: string;\n /**\n * @description Product description.\n * @example Product internal description\n */\n description?: string | null;\n /**\n * @description Public description of the product.\n * @example Product public description\n */\n public_description?: string | null;\n /** @description Product name and description translations. */\n translations?: {\n fr?: {\n name?: string | null;\n public_description?: string | null;\n };\n en?: {\n name?: string | null;\n public_description?: string | null;\n };\n de?: {\n name?: string | null;\n public_description?: string | null;\n };\n it?: {\n name?: string | null;\n public_description?: string | null;\n };\n nl?: {\n name?: string | null;\n public_description?: string | null;\n };\n es?: {\n name?: string | null;\n public_description?: string | null;\n };\n pt?: {\n name?: string | null;\n public_description?: string | null;\n };\n pl?: {\n name?: string | null;\n public_description?: string | null;\n };\n } | null;\n is_available_on_demand?: boolean;\n is_available_on_subscription?: boolean;\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n } | null;\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n accounting?: components[\"schemas\"][\"ProductAccounting\"];\n };\n };\n };\n responses: {\n /** @description The newly created product */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n /** @description Product not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n archiveProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Product archived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n /** @description Product not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n unarchiveProduct: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Product unarchived */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Product\"];\n };\n };\n /** @description Product not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updatePrices: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Prices payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"PriceFee\"][];\n };\n };\n responses: {\n /** @description The updated price configuration */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PriceConfiguration\"];\n };\n };\n };\n };\n getPlans: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedPlan\"];\n };\n };\n };\n };\n getPlan: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Plan\"];\n };\n };\n };\n };\n getQuotes: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n status?: (\"all\" | \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"signed\" | \"voided\") | string;\n status__in?: (\"all\" | \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"signed\" | \"voided\") | string;\n customer_id?: string;\n customer_id__not?: string;\n customer_id__isNull?: string;\n customer_id__isNotNull?: string;\n customer_id__equals?: string;\n customer_id__contains?: string;\n customer_id__startsWith?: string;\n customer_id__endWith?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedQuote\"];\n };\n };\n };\n };\n createQuote: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateQuote\"];\n \"multipart/form-data\": {\n /**\n * @description\n * Quote status.\n *\n * - `draft`: The quote is a draft.\n * - `approved`: The quote is approved and ready to be sent to the customer.\n * - `pending_signature`: The quote is awaiting the customer's signature.\n *\n * @example draft\n * @enum {string}\n */\n status?: \"draft\" | \"approved\" | \"pending_signature\";\n /**\n * Format: email\n * @description Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.\n * @example joe@acme.com\n */\n owner_email?: string;\n /**\n * @description ID of the customer.\n * @example cus_QalW2vTAdkR6IY\n */\n customer_id: string;\n /**\n * @description ID of the invoicing entity attached to the quote.\n * @example ive_47484fjdhy5\n */\n invoicing_entity_id?: string;\n /**\n * @description Custom comments displayed on the quote.\n * @example Please find the contract and subscription details we discussed.\n */\n comments?: string;\n /**\n * @description Custom quotation terms.\n * @example By signing this quote, you accept our conditions of use for the use of our products and services.\n */\n terms?: string;\n /**\n * @description Estimated contract value. If not specified, automatically computed from the subscription configuration.\n * @example 20000\n */\n amount?: number | null;\n /**\n * @description Collect customer payment method mandate during signature flow or not.\n * @example true\n */\n collect_payment_details?: boolean | (\"true\" | \"false\");\n /**\n * @description IDs of the customer custom properties required to be filled during the signature flow.\n * @example []\n */\n collect_custom_property_ids?: string[];\n /**\n * @description Whether the subscription should be automatically started when the quote is signed.\n * @example true\n */\n automatically_start_subscription?: boolean | (\"true\" | \"false\");\n } & ({\n /**\n * @description ID of the quote template. If not specified, a subscription configuration must be defined.\n * @example quot_9hNWq4c84Z146W\n */\n template_id: string;\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription?: {\n /** @description Subscription custom name. */\n name?: string;\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices?: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically?: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & {\n /** @description Create a free trial phase based on the plan configuration. */\n trial?: {\n /**\n * @description Defines how the free trial will end.\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\";\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n duration?: {\n /**\n * @description Free trial duration period. Only applies if the end strategy is `duration`.\n * @enum {string}\n */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @description Free trial duration count. Only applies if the end strategy is `duration`. */\n count: number;\n };\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment?: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n } | {\n expires_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Subscription configuration constituting the quote. */\n subscription: {\n /** @description Subscription custom name. */\n name?: string;\n /** @description Reference to the purchase order. */\n purchase_order?: string;\n /**\n * @description ID of the invoicing entity attached to the subscription.\n * @example ive_jerrb484RHn\n */\n invoicing_entity_id?: string;\n /**\n * @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent\n * @default false\n */\n generate_draft_invoices?: boolean | (\"true\" | \"false\");\n /**\n * @deprecated\n * @description Use `contract_start` `contract_end` and `renew_automatically` instead. Interval previously used to represent the commitment period of the subscription.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n commitment_interval?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Indicates if the subscription should automatically renew.\n * @default true\n * @example true\n */\n renew_automatically?: boolean | (\"true\" | \"false\");\n /**\n * @description If `renew_automatically` is enabled, will renew the subscription for the given interval.\n * @example {\n * \"period\": \"years\",\n * \"count\": 1\n * }\n */\n renew_for?: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n };\n /**\n * @description Minimum fee applied to each invoice outside of one time payments.\n * @example 250\n */\n minimum_invoice_fee?: number | null;\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & string;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & string;\n /**\n * @description\n * Strategy used to cancel the subscription. If not specified `do_nothing` is used.\n *\n * - `charge_prorata`: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.\n * - `charge_custom`: Will charge the customer a custom amount.\n * - `refund_prorata`: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.\n * - `refund_custom`: Will refund to the customer a custom amount.\n * - `end_of_period`: Will cancel the subscription at the end date of the current billing period.\n * - `do_nothing`: Will only cease the subscription without any additional actions.\n *\n * @enum {string}\n */\n cancellation_strategy?: \"refund_prorata\" | \"refund_custom\" | \"charge_prorata\" | \"charge_custom\" | \"end_of_period\" | \"do_nothing\";\n cancellation_amount?: components[\"schemas\"][\"Amount\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n } & {\n /** @description Create a free trial phase based on the plan configuration. */\n trial?: {\n /**\n * @description Defines how the free trial will end.\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\";\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n ends_at?: components[\"schemas\"][\"DateTime\"] & string;\n duration?: {\n /**\n * @description Free trial duration period. Only applies if the end strategy is `duration`.\n * @enum {string}\n */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @description Free trial duration count. Only applies if the end strategy is `duration`. */\n count: number;\n };\n };\n } & ({\n phases: ({\n /** @enum {string} */\n activation_strategy: \"start_date\" | \"manual\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\" | \"immediately\" | \"quote_signature\";\n products: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @default anniversary\n * @enum {string}\n */\n billing_cycle_alignment?: \"calendar_period\" | \"anniversary\";\n } & {\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n })[];\n } | {\n /** @description Products that make up the subscription. */\n products?: {\n /**\n * @description Product ID.\n * @example itm_FJKlqUb8COXw55\n */\n id: string;\n /**\n * @description Product name. This will appear on the final invoices.\n * @example Product name\n */\n name?: string;\n /**\n * @description Product description. This will appear on the final invoices.\n * @example A description of the product.\n */\n description?: string;\n /**\n * @description Indicates if the dates of the interval should be automatically added in the product description on the invoices.\n * @default false\n */\n description_display_interval_dates?: boolean;\n /**\n * @description Interval on which the product is billed. This interval can be different between products and can differ from the subscription commitment interval.\n * @example {\n * \"period\": \"months\",\n * \"count\": 1\n * }\n */\n payment_interval?: {\n /** @enum {string} */\n period: \"once\";\n } | {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n /** @default 1 */\n count?: number;\n };\n /**\n * @description Indicates if the product should be billed at the start or the end of the payment interval.\n * @example start\n * @enum {string}\n */\n payment_schedule?: \"start\" | \"end\";\n price?: components[\"schemas\"][\"PriceFee\"] & unknown;\n /**\n * @description 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.\n * @example [\n * {\n * \"type\": \"volume\",\n * \"from\": 0,\n * \"to\": 20,\n * \"amount\": 200,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * },\n * {\n * \"type\": \"volume\",\n * \"from\": 21,\n * \"to\": null,\n * \"amount\": 150,\n * \"unit_count\": 1,\n * \"on_tier_incomplete\": null\n * }\n * ]\n */\n prices?: (components[\"schemas\"][\"PriceFee\"] | components[\"schemas\"][\"PriceVolume\"])[];\n /**\n * @description Number of product units. Only applies to products of type `flat_fee` or `seat`.\n * @example 2\n */\n count?: number;\n /**\n * @description Product name. This will appear on the final invoices. Only applies to products of type `seat` or `usage`.\n * @example user\n */\n unit_name?: string;\n /** @description Minimum of units committed. If usage is less than this number, then this value will be used. Only applies to products of type `usage`. */\n min_committed_count?: number;\n /** @description 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`. */\n min_amount?: number;\n /** @description 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`. */\n max_amount?: number;\n /**\n * @description\n * Indicates on which type of interval the usage should be aggregated.\n *\n * - `subscription_commitment`: For the usage contained within the subscription commitment period.\n * - `payment_interval`: For the usage contained within the payment interval of the product.\n * - `full_database`: For all the usage we ingested for this product, no matter the period.\n * Only applies to products of type `usage`.\n * @enum {string}\n */\n metering_interval_type?: \"subscription_commitment\" | \"payment_interval\" | \"full_database\";\n /**\n * @description 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`.\n * @default false\n */\n bill_usage_difference?: boolean | (\"true\" | \"false\");\n }[];\n coupons?: (({\n /** @description Coupon ID. */\n id: string;\n } | {\n /** @enum {string} */\n type: \"amount\";\n /** @description Coupon name. */\n name?: string;\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n } | {\n /** @enum {string} */\n type: \"percent\";\n /** @description Coupon name. */\n name?: string;\n /** @description Coupon discount percentage. */\n discount_percent: number;\n }) & {\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n expires_at?: components[\"schemas\"][\"DateTime\"] & string;\n apply_at?: components[\"schemas\"][\"DateTime\"] & string;\n /** @description Product IDs to which the coupon will be applied. */\n product_ids?: string[];\n })[];\n });\n }) & {\n attachments: components[\"schemas\"][\"File\"][];\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n getQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n /** @description Quote not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n downloadQuote: {\n parameters: {\n query?: {\n locale?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/pdf\": unknown;\n };\n };\n /** @description Quote not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n sendQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"SendQuote\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n signQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"multipart/form-data\": {\n signed_quote: components[\"schemas\"][\"File\"];\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n voidQuote: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"VoidQuote\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Quote\"];\n };\n };\n };\n };\n downloadQuoteFile: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n quoteId: string;\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/pdf\": unknown;\n };\n };\n /** @description Quote or file not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n refreshSubscriptions: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n createSubscriptionUpdate: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateSubscriptionUpdate\"];\n };\n };\n responses: {\n /** @description Subscription update created */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n id: string;\n };\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n createSubscriptionUpdates: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateSubscriptionUpdates\"];\n };\n };\n responses: {\n /** @description Subscription updates created */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n id: string;\n }[];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n cancelSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CancelSubscription\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n reinstateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n pauseSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n reactivate_at?: components[\"schemas\"][\"DateTime\"] & unknown;\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n activateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n reactivateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getSubscriptions: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n status?: (\"all\" | \"inactive\" | \"active\" | \"errored\" | \"cancelled\" | \"paused\" | \"pending\" | \"draft\" | \"voided\" | \"archived\") | string;\n status__in?: (\"all\" | \"inactive\" | \"active\" | \"errored\" | \"cancelled\" | \"paused\" | \"pending\" | \"draft\" | \"voided\" | \"archived\") | string;\n currency?: string;\n currency__not?: string;\n currency__isNull?: string;\n currency__isNotNull?: string;\n currency__equals?: string;\n currency__contains?: string;\n currency__startsWith?: string;\n currency__endWith?: string;\n plan_id?: string;\n plan_id__not?: string;\n plan_id__isNull?: string;\n plan_id__isNotNull?: string;\n plan_id__equals?: string;\n plan_id__contains?: string;\n plan_id__startsWith?: string;\n plan_id__endWith?: string;\n original_quote_id?: string;\n original_quote_id__not?: string;\n original_quote_id__isNull?: string;\n original_quote_id__isNotNull?: string;\n original_quote_id__equals?: string;\n original_quote_id__contains?: string;\n original_quote_id__startsWith?: string;\n original_quote_id__endWith?: string;\n customer_id?: string;\n customer_id__not?: string;\n customer_id__isNull?: string;\n customer_id__isNotNull?: string;\n customer_id__equals?: string;\n customer_id__contains?: string;\n customer_id__startsWith?: string;\n customer_id__endWith?: string;\n invoicing_entity_id?: string;\n invoicing_entity_id__not?: string;\n invoicing_entity_id__isNull?: string;\n invoicing_entity_id__isNotNull?: string;\n invoicing_entity_id__equals?: string;\n invoicing_entity_id__contains?: string;\n invoicing_entity_id__startsWith?: string;\n invoicing_entity_id__endWith?: string;\n customer_external_id?: string;\n updated_at?: string;\n updated_at__not?: string;\n updated_at__isNull?: string;\n updated_at__isNotNull?: string;\n updated_at__equals?: string;\n updated_at__lt?: string;\n updated_at__lte?: string;\n updated_at__gt?: string;\n updated_at__gte?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedSubscription\"];\n };\n };\n };\n };\n createSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description\n * Create subscription payload.\n *\n * At least a `plan_id`, a set of `products` or `phases` must be specified in addition to the required fields.\n * */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateSubscription\"];\n };\n };\n responses: {\n /** @description The newly created subscription */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getSubscription: {\n parameters: {\n query?: {\n include_live_billing?: string;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Subscription\"] & {\n /** @description Products that make up the subscription. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons to be applied to the prices of subscription products. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n /** @description Phases of the subscription. */\n phases: {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n }[];\n quote: {\n /**\n * @description ID of the quote from which the subscription was created.\n * @example quo_38YwqvItBH3d8a\n */\n id: string;\n /**\n * @description Status of the quote from which the subscription was created.\n * @example signed\n * @enum {string}\n */\n status: \"draft\" | \"pending_approval\" | \"changes_requested\" | \"approved\" | \"pending_signature\" | \"voided\" | \"signed\";\n } | null;\n plan: {\n /**\n * @description ID of the plan used to create the subscription.\n * @example plan_zHmjoDee4ZRmQV\n */\n id: string;\n /**\n * @description Name of the plan used to create the subscription.\n * @example My example plan\n */\n name: string;\n } | null;\n checkout_session: components[\"schemas\"][\"CheckoutSession\"];\n /**\n * @description Payment method type used to pay the subscription.\n * @enum {string|null}\n */\n payment_method_type: \"card\" | \"direct_debit\" | \"direct_debit_ach\" | \"direct_debit_bacs\" | \"transfer\" | \"transfer_automated\" | \"external\" | null;\n payment_method: components[\"schemas\"][\"PaymentMethod\"] & unknown;\n /** @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent */\n generate_draft_invoices: boolean;\n } & {\n live_billing?: components[\"schemas\"][\"LiveBilling\"];\n };\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description\n * Update subscription payload.\n *\n * Dates fields can only be updated before a subscription is active. Other fields can be updated at any time.\n * */\n requestBody?: {\n content: {\n \"application/json\": {\n /** @description Subscription custom name. */\n name?: string | null;\n /** @description Reference to the purchase order. */\n purchase_order?: string | null;\n /** @description Minimum fee applied to each invoice outside of one time payments. */\n minimum_invoice_fee?: number | null;\n /** @description Only tax will be charged on this subscription. */\n tax_only?: boolean | (\"true\" | \"false\");\n /** @description Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent */\n generate_draft_invoices?: boolean | (\"true\" | \"false\");\n /** @description Generate non-legal documents instead of invoices. */\n generate_document?: boolean | (\"true\" | \"false\");\n /** @description If `generate_document` is turned on, allows you to give a name to your document. */\n document_name?: string | null;\n /** @description If `generate_document` is turned on, will add VAT to document. */\n add_vat_to_document?: boolean | (\"true\" | \"false\");\n /** @description Subscription will be invoiced but not charged (invoices/documents will be settled directly). */\n do_not_charge_subscription?: boolean | (\"true\" | \"false\");\n starts_at?: components[\"schemas\"][\"DateTime\"] & string;\n contract_start?: components[\"schemas\"][\"DateTime\"] & string;\n contract_end?: components[\"schemas\"][\"DateTime\"] & unknown;\n initial_billing_at?: components[\"schemas\"][\"DateTime\"] & string;\n cancel_at?: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Key/value pairs to store any information you find useful. */\n properties?: {\n [key: string]: string | number | boolean | null | (string | number | boolean | null)[];\n };\n /** @description 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. */\n custom_properties?: {\n [key: string]: string | number | boolean | (components[\"schemas\"][\"DateTime\"] & string) | null;\n };\n };\n };\n };\n responses: {\n /** @description The updated subscription */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getSubscriptionPhases: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedSubscriptionPhase\"];\n };\n };\n /** @description Subscription not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getSubscriptionPhase: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n phaseId: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Subscription phase ID.\n * @example sup_1FoLfIQ5VOMbXf\n */\n id: string;\n /**\n * @description\n * Type of subscription phase.\n *\n * - `setup`: The phase represents a non-recurring service setup period, often used before the actual recurring subscription begins.\n * - `trial`: The phase represents a non-recurring trial period, often used to allow users to opt out or experience a free test.\n * - `standard`: The phase represents a standard recurring billing.\n *\n * @example standard\n * @enum {string}\n */\n type: \"setup\" | \"trial\" | \"standard\";\n /**\n * @description\n * Status of subscription phase.\n *\n * - `pending`: The phase is waiting to start (not started yet).\n * - `active`: The phase is currently in progress.\n * - `finished`: The phase has ended and is complete.\n *\n * @example active\n * @enum {string}\n */\n status: \"pending\" | \"active\" | \"finished\";\n /**\n * @description Order in which the phase is executed within all subscription phases.\n * @example 0\n */\n order: number;\n /**\n * @description\n * Activation strategy of subscription phase.\n *\n * - `immediately`: The phase starts as soon as the subscription is activated.\n * - `manual`: The phase starts when a user manually activates it.\n * - `start_date`: The phase starts on a specified date.\n * - `quote_signature`: The phase starts when the subscription quote is signed.\n * - `checkout`: The phase starts when the subscription checkout is completed.\n * - `contract_start_date`: The phase starts on the start date of the related subscription contract.\n * - `previous_phase_end`: The phase starts when the previous phase ends.\n *\n * @example manual\n * @enum {string}\n */\n activation_strategy: \"immediately\" | \"manual\" | \"start_date\" | \"quote_signature\" | \"checkout\" | \"contract_start_date\" | \"previous_phase_end\";\n /**\n * @description\n * End strategy of subscription phase.\n *\n * - `manual`: The phase ends when a user manually stops it.\n * - `end_date`: The phase ends on a specified date.\n * - `duration`: The phase ends after a specific relative duration.\n * - `contract_end_date`: The phase ends on the end date of the related subscription contract.\n *\n * @example duration\n * @enum {string}\n */\n end_strategy: \"manual\" | \"end_date\" | \"duration\" | \"contract_end_date\";\n /**\n * @description Interval over which the subscription phase spans. Only applies to `duration` end strategy.\n * @example {\n * \"count\": 1,\n * \"period\": \"years\"\n * }\n */\n duration: {\n /** @enum {string} */\n period: \"days\" | \"weeks\" | \"months\" | \"years\";\n count: number;\n } | null;\n /**\n * @description\n * Represents when the first billing date occurs.\n *\n * - `phase_start`: Aligns with the start of the phase.\n * - `specific_date`: Occurs on a specified date.\n *\n * @example phase_start\n * @enum {string}\n */\n billing_date_setting: \"phase_start\" | \"specific_date\";\n initial_billing_at: components[\"schemas\"][\"DateTime\"] & unknown;\n starts_at: components[\"schemas\"][\"DateTime\"] & unknown;\n ends_at: components[\"schemas\"][\"DateTime\"] & unknown;\n /**\n * @description\n * Alignment of product billing cycles.\n *\n * - `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.\n * - `anniversary`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.\n *\n * @enum {string}\n */\n billing_cycle_alignment: \"calendar_period\" | \"anniversary\";\n /**\n * @description\n * Calculation method used when transitioning from one phase to the next one.\n *\n * - `prorata`: The prorated amount between the two phases relative to the end date (the transition date) must be paid.\n * - `pay_in_full`: The full amount for the phase billing period must be paid.\n * - `none`: No amount will need to be paid, phase will simply transition from one to the next.\n *\n * @example prorata\n * @enum {string}\n */\n transition_calculation_method: \"prorata\" | \"pay_in_full\" | \"none\";\n /**\n * @description\n * Represents when the transition amount will be invoiced.\n *\n * - `immediately`: An invoice will be generated immediately with the corresponding amount.\n *\n * @example immediately\n * @enum {string}\n */\n transition_invoicing_schedule: \"immediately\";\n /** @description Products comprising the subscription phase. */\n products: (components[\"schemas\"][\"SubscriptionProductFee\"] | components[\"schemas\"][\"SubscriptionProductCredit\"] | components[\"schemas\"][\"SubscriptionProductSeat\"] | components[\"schemas\"][\"SubscriptionProductDynamic\"])[];\n /** @description Coupons comprising the subscription phase. */\n coupons: (({\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"amount\";\n discount_amount: components[\"schemas\"][\"Amount\"] & unknown;\n currency: components[\"schemas\"][\"Currency\"] & (string | null);\n } | {\n /** @description Coupon description. */\n description: string | null;\n expiration_date: components[\"schemas\"][\"DateTime\"] & unknown;\n /** @description Maximum number of subscriptions to which a single coupon can be applied. */\n redemption_limit: number | null;\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n /** @enum {string} */\n type: \"percent\";\n /**\n * @description Percentage to apply as a discount on the amount (excluding taxes) of a product.\n * @example 15\n */\n discount_percent: number;\n }) & {\n /**\n * @description Coupon ID.\n * @example cou_DKL4Xcb5VSa8CQ\n */\n id: string | null;\n /**\n * @description Coupon name.\n * @example Partner discount\n */\n name: string | null;\n /**\n * @description Coupon identifier in the context of the subscription.\n * @example coos_d9pVekhjoGppuX\n */\n subscription_coupon_id: string;\n /**\n * @description\n * Coupon frequency.\n *\n * - `once`: Will apply the coupon only to the first one invoice.\n * - `forever`: Will apply the coupon to all invoices.\n * - `custom`: Will apply to coupon until a specified expiration date.\n *\n * @example forever\n * @enum {string}\n */\n repeat: \"once\" | \"forever\" | \"custom\";\n /**\n * @description Product IDs to which the coupon will be applied.\n * @example [\n * \"itm_FJKlqUb8COXw55\"\n * ]\n */\n product_ids: string[];\n apply_at: components[\"schemas\"][\"DateTime\"] & unknown;\n expires_at: components[\"schemas\"][\"DateTime\"] & unknown;\n })[];\n created_at: components[\"schemas\"][\"DateTime\"] & string;\n updated_at: components[\"schemas\"][\"DateTime\"] & string;\n };\n };\n };\n /** @description Subscription or phase not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n refreshSeatProductsOnSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n /**\n * @description Subscription update ID.\n * @example supd_MkTDgpM6ej6f8l\n */\n id: string;\n /**\n * @description\n * Indicates when the subscription should be updated.\n *\n * - `immediately`: The subscription will be updated immediately.\n * - `next_period`: The subscription will be updated at the end of the current billing period.\n * - `custom`: The subscription will be updated at a custom date.\n *\n * @enum {string}\n */\n application_schedule: \"immediately\" | \"next_period\" | \"custom\";\n /**\n * @description Date when the subscription should be updated. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n * @example 2024-11-30T18:24:34.496Z\n */\n apply_at: string;\n /**\n * @description\n * Indicates when the subscription should be billed.\n *\n * - `immediately`: The subscription will be billed immediately.\n * - `next_invoice`: The subscription will be billed at the next invoice.\n * - `custom`: The subscription will be billed at a custom date.\n *\n * @enum {string}\n */\n payment_schedule: \"immediately\" | \"next_invoice\" | \"custom\";\n /**\n * @description\n * Indicates how the products price should be calculated.\n *\n * - `pro_rata`: The price will be calculated proportionally to the time elapsed since the last billing period.\n * - `pay_in_full`: The price will be calculated for the entire billing period.\n * - `do_not_charge`: The price will not be calculated.\n *\n * @enum {string}\n */\n calculation_method: \"pro_rata\" | \"pay_in_full\" | \"do_not_charge\";\n /** @description Amount to adjust the subscription price. */\n adjustment_amount: number | null;\n /**\n * @description Subscription ID.\n * @example sub_7aWtG7Gb_fwGno\n */\n subscription_id: string;\n /**\n * @description Product ID.\n * @example itm_G6nU9iSC7eoDsk\n */\n product_id: string;\n /**\n * @description Previous count.\n * @example 2\n */\n previous_count: number;\n /**\n * @description New count.\n * @example 7\n */\n new_count: number;\n /** @description The next refresh date. Exists if your seat item is configured to be refreshed periodically. */\n next_refresh_date?: string | null;\n }[];\n };\n };\n };\n };\n transitionSubscription: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n transition_date?: components[\"schemas\"][\"DateTime\"] & string;\n };\n };\n };\n responses: {\n /** @description The updated subscription */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"SubscriptionDetails\"];\n };\n };\n };\n };\n getTaxRates: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n invoicing_entity_id?: string;\n invoicing_entity_id__not?: string;\n invoicing_entity_id__isNull?: string;\n invoicing_entity_id__isNotNull?: string;\n invoicing_entity_id__equals?: string;\n invoicing_entity_id__contains?: string;\n invoicing_entity_id__startsWith?: string;\n invoicing_entity_id__endWith?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedTaxRate\"];\n };\n };\n };\n };\n getTaxRate: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"TaxRate\"];\n };\n };\n /** @description Tax rate not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getApps: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"App\"][];\n };\n };\n };\n };\n createApp: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create app payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateApp\"];\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"App\"] & {\n /** @description OAuth client secret */\n client_secret: string;\n };\n };\n };\n };\n };\n updateApp: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update app payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateApp\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"App\"];\n };\n };\n };\n };\n deleteApp: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description App deleted */\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n getWalletSettings: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WalletSettings\"];\n };\n };\n };\n };\n updateWalletSettings: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Update wallet settings payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateWalletSettings\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WalletSettings\"];\n };\n };\n };\n };\n getWallets: {\n parameters: {\n query?: {\n customer_id?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"][];\n };\n };\n };\n };\n createWallet: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n /** @description Create wallet payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"CreateWallet\"];\n };\n };\n responses: {\n /** @description The newly created wallet */\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n };\n };\n getWallet: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n /** @description Wallet not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n updateWallet: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Update wallet payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"UpdateWallet\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n /** @description Wallet not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n loadWallet: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n /** @description Load wallet payload */\n requestBody?: {\n content: {\n \"application/json\": components[\"schemas\"][\"LoadWallet\"];\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"Wallet\"];\n };\n };\n /** @description Wallet not found */\n 404: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": {\n message: string;\n };\n };\n };\n };\n };\n getWalletTransactions: {\n parameters: {\n query?: {\n take?: number;\n skip?: number | null;\n };\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n /** @description Paginated list of wallet transactions */\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedWalletTransaction\"];\n };\n };\n };\n };\n getWebhookEndpoints: {\n parameters: {\n query?: {\n limit?: number;\n iterator?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedWebhookEndpoint\"];\n };\n };\n };\n };\n createWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Webhook endpoint description.\n * @example Production webhook endpoint\n */\n description?: string;\n /**\n * Format: uri\n * @description Webhook endpoint URL.\n * @example https://example.com/webhook\n */\n url: string;\n /** @description Webhook endpoint verification secret (base64 encoded random bytes). If not defined, a secret is automatically generated and only accessible in the UI. */\n secret?: string;\n /** @description Webhook rate limit (per second). */\n rate_limit?: number;\n /**\n * @description Webhook event types filter. If not defined, all event messages will be sent.\n * @example [\n * \"customer.created\",\n * \"customer.updated\"\n * ]\n */\n event_types?: (\"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\")[];\n };\n };\n };\n responses: {\n 201: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WebhookEndpoint\"];\n };\n };\n };\n };\n getWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WebhookEndpoint\"];\n };\n };\n };\n };\n updateWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: {\n content: {\n \"application/json\": {\n /**\n * @description Webhook endpoint description.\n * @example Production webhook endpoint\n */\n description?: string;\n /**\n * Format: uri\n * @description Webhook endpoint URL.\n * @example https://example.com/webhook\n */\n url: string;\n /** @description Webhook rate limit (per second). */\n rate_limit?: number;\n /**\n * @description Webhook event types filter. If not defined, all event messages will be sent.\n * @example [\n * \"customer.created\",\n * \"customer.updated\"\n * ]\n */\n event_types?: (\"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\")[];\n };\n };\n };\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"WebhookEndpoint\"];\n };\n };\n };\n };\n deleteWebhookEndpoint: {\n parameters: {\n query?: never;\n header?: never;\n path: {\n id: string;\n };\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 204: {\n headers: {\n [name: string]: unknown;\n };\n content?: never;\n };\n };\n };\n getWebhookMessages: {\n parameters: {\n query?: {\n before?: string | null;\n after?: string | null;\n event_types?: \"event.price_calculated\" | \"customer.created\" | \"customer.updated\" | \"customer.archived\" | \"customer.recovered\" | \"customer.deleted\" | \"subscription.created\" | \"subscription.trial_ended\" | \"subscription.activated\" | \"subscription.reactivated\" | \"subscription.contract_started\" | \"subscription.paused\" | \"subscription.phase_activated\" | \"subscription.updated\" | \"subscription.cancellation_scheduled\" | \"subscription.cancelled\" | \"subscription.voided\" | \"subscription.errored\" | \"subscription.charged\" | \"subscription.commitment_renewed\" | \"subscription.reinstated\" | \"invoice.created\" | \"invoice.grace_period.started\" | \"invoice.ready\" | \"invoice.settled\" | \"invoice.errored\" | \"invoice.voided\" | \"invoice.reminder_sent\" | \"credit_note.ready\" | \"credit_note.settled\" | \"checkout.created\" | \"checkout.completed\" | \"payment_method.created\" | \"payment_method.activated\" | \"payment_method.errored\" | \"payment_method.deleted\" | \"wallet.credited\" | \"wallet.debited\" | \"daily_analytics.ready\" | \"dataloader.failed\" | \"credit.low_balance\" | \"credit.balance_refreshed\" | \"credit.created\" | \"credit.updated\" | \"credit.balance_at_zero\" | \"credit.topup_transaction_created\" | \"credit.usage_transaction_created\" | \"quote.created\" | \"quote.updated\" | \"quote.approval_requested\" | \"quote.approved\" | \"quote.sent\" | \"quote.viewed\" | \"quote.signed\" | \"quote.voided\" | \"bank_account.created\" | \"bank_account.deleted\" | \"custom_property.created\" | \"custom_property.updated\" | \"custom_property.deleted\" | \"custom_property.value_created\" | \"custom_property.value_updated\" | \"product.created\" | \"product.archived\" | \"product.recovered\" | \"product.deleted\";\n limit?: number;\n iterator?: string;\n };\n header?: never;\n path?: never;\n cookie?: never;\n };\n requestBody?: never;\n responses: {\n 200: {\n headers: {\n [name: string]: unknown;\n };\n content: {\n \"application/json\": components[\"schemas\"][\"PaginatedWebhookMessage\"];\n };\n };\n };\n };\n}\n"]}