// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../resource'; import { isRequestOptions } from '../core'; import * as Core from '../core'; import * as Shared from './shared'; import { InvoicesPage } from './shared'; import { Page, type PageParams } from '../pagination'; /** * An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for * a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and * can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as * the result of an action, such as a cancellation. */ export class Invoices extends APIResource { /** * This endpoint is used to create a one-off invoice for a customer. */ create(body: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise { return this._client.post('/invoices', { body, ...options }); } /** * This endpoint allows you to update the `metadata`, `net_terms`, `due_date`, * `invoice_date`, and `auto_collection` properties on an invoice. If you pass null * for the metadata value, it will clear any existing metadata for that invoice. * * `metadata` can be modified regardless of invoice state. `net_terms`, `due_date`, * `invoice_date`, and `auto_collection` can only be modified if the invoice is in * a `draft` state. `invoice_date` can only be modified for non-subscription * invoices. */ update( invoiceId: string, body: InvoiceUpdateParams, options?: Core.RequestOptions, ): Core.APIPromise { return this._client.put(`/invoices/${invoiceId}`, { body, ...options }); } /** * This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an * account in a list format. * * The list of invoices is ordered starting from the most recently issued invoice * date. The response also includes * [`pagination_metadata`](/api-reference/pagination), which lets the caller * retrieve the next page of results if they exist. * * By default, this only returns invoices that are `issued`, `paid`, or `synced`. * * When fetching any `draft` invoices, this returns the last-computed invoice * values for each draft invoice, which may not always be up-to-date since Orb * regularly refreshes invoices asynchronously. */ list( query?: InvoiceListParams, options?: Core.RequestOptions, ): Core.PagePromise; list(options?: Core.RequestOptions): Core.PagePromise; list( query: InvoiceListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.PagePromise { if (isRequestOptions(query)) { return this.list({}, query); } return this._client.getAPIList('/invoices', InvoicesPage, { query, ...options }); } /** * This endpoint deletes an invoice line item from a draft invoice. * * This endpoint only allows deletion of one-off line items (not subscription-based * line items). The invoice must be in a draft status for this operation to * succeed. */ deleteLineItem( invoiceId: string, lineItemId: string, options?: Core.RequestOptions, ): Core.APIPromise { return this._client.delete(`/invoices/${invoiceId}/invoice_line_items/${lineItemId}`, { ...options, headers: { Accept: '*/*', ...options?.headers }, }); } /** * This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an * identifier. */ fetch(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise { return this._client.get(`/invoices/${invoiceId}`, options); } /** * This endpoint can be used to fetch the upcoming * [invoice](/core-concepts#invoice) for the current billing period given a * subscription. */ fetchUpcoming( query: InvoiceFetchUpcomingParams, options?: Core.RequestOptions, ): Core.APIPromise { return this._client.get('/invoices/upcoming', { query, ...options }); } /** * This endpoint allows an eligible invoice to be issued manually. This is only * possible with invoices where status is `draft`, `will_auto_issue` is false, and * an `eligible_to_issue_at` is a time in the past. Issuing an invoice could * possibly trigger side effects, some of which could be customer-visible (e.g. * sending emails, auto-collecting payment, syncing the invoice to external * providers, etc). */ issue( invoiceId: string, body?: InvoiceIssueParams, options?: Core.RequestOptions, ): Core.APIPromise; issue(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise; issue( invoiceId: string, body: InvoiceIssueParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(body)) { return this.issue(invoiceId, {}, body); } return this._client.post(`/invoices/${invoiceId}/issue`, { body, ...options }); } /** * This endpoint allows an eligible invoice to be issued manually. This is only * possible with invoices where status is `draft`, `will_auto_issue` is false, and * an `eligible_to_issue_at` is a time in the past. Issuing an invoice could * possibly trigger side effects, some of which could be customer-visible (e.g. * sending emails, auto-collecting payment, syncing the invoice to external * providers, etc). * * This is a lighter-weight alternative to the issue invoice endpoint, returning an * invoice summary without any line item details. */ issueSummary( invoiceId: string, body?: InvoiceIssueSummaryParams, options?: Core.RequestOptions, ): Core.APIPromise; issueSummary( invoiceId: string, options?: Core.RequestOptions, ): Core.APIPromise; issueSummary( invoiceId: string, body: InvoiceIssueSummaryParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(body)) { return this.issueSummary(invoiceId, {}, body); } return this._client.post(`/invoices/summary/${invoiceId}/issue`, { body, ...options }); } /** * This is a lighter-weight endpoint that returns a list of all * [`Invoice`](/core-concepts#invoice) summaries for an account in a list format. * * These invoice summaries do not include line item details, minimums, maximums, * and discounts, making this endpoint more efficient. * * The list of invoices is ordered starting from the most recently issued invoice * date. The response also includes * [`pagination_metadata`](/api-reference/pagination), which lets the caller * retrieve the next page of results if they exist. * * By default, this only returns invoices that are `issued`, `paid`, or `synced`. * * When fetching any `draft` invoices, this returns the last-computed invoice * values for each draft invoice, which may not always be up-to-date since Orb * regularly refreshes invoices asynchronously. */ listSummary( query?: InvoiceListSummaryParams, options?: Core.RequestOptions, ): Core.PagePromise; listSummary( options?: Core.RequestOptions, ): Core.PagePromise; listSummary( query: InvoiceListSummaryParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.PagePromise { if (isRequestOptions(query)) { return this.listSummary({}, query); } return this._client.getAPIList('/invoices/summary', InvoiceListSummaryResponsesPage, { query, ...options, }); } /** * This endpoint allows an invoice's status to be set to the `paid` status. This * can only be done to invoices that are in the `issued` or `synced` status. */ markPaid( invoiceId: string, body: InvoiceMarkPaidParams, options?: Core.RequestOptions, ): Core.APIPromise { return this._client.post(`/invoices/${invoiceId}/mark_paid`, { body, ...options }); } /** * This endpoint collects payment for an invoice. By default, it uses the * customer's default payment method. Optionally, a shared payment token (SPT) can * be provided to pay using agent-granted credentials instead. This action can only * be taken on invoices with status "issued". */ pay( invoiceId: string, body: InvoicePayParams, options?: Core.RequestOptions, ): Core.APIPromise { return this._client.post(`/invoices/${invoiceId}/pay`, { body, ...options }); } /** * This endpoint allows an invoice's status to be set to the `void` status. This * can only be done to invoices that are in the `issued` status. * * If the associated invoice has used the customer balance to change the amount * due, the customer balance operation will be reverted. For example, if the * invoice used \$10 of customer balance, that amount will be added back to the * customer balance upon voiding. * * If the invoice was used to purchase a credit block, but the invoice is not yet * paid, the credit block will be voided. If the invoice was created due to a * top-up, the top-up will be disabled. */ void(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise { return this._client.post(`/invoices/${invoiceId}/void`, options); } } export class InvoiceListSummaryResponsesPage extends Page {} export interface InvoiceFetchUpcomingResponse { id: string; /** * This is the final amount required to be charged to the customer and reflects the * application of the customer balance to the `total` of the invoice. */ amount_due: string; auto_collection: InvoiceFetchUpcomingResponse.AutoCollection; billing_address: Shared.Address | null; /** * The creation time of the resource in Orb. */ created_at: string; /** * A list of credit notes associated with the invoice */ credit_notes: Array; /** * An ISO 4217 currency string or `credits` */ currency: string; customer: Shared.CustomerMinified; customer_balance_transactions: Array; /** * Tax IDs are commonly required to be displayed on customer invoices, which are * added to the headers of invoices. * * ### Supported Tax ID Countries and Types * * | Country | Type | Description | * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | * | Albania | `al_tin` | Albania Tax Identification Number | * | Andorra | `ad_nrt` | Andorran NRT Number | * | Angola | `ao_tin` | Angola Tax Identification Number | * | Argentina | `ar_cuit` | Argentinian Tax ID Number | * | Armenia | `am_tin` | Armenia Tax Identification Number | * | Aruba | `aw_tin` | Aruba Tax Identification Number | * | Australia | `au_abn` | Australian Business Number (AU ABN) | * | Australia | `au_arn` | Australian Taxation Office Reference Number | * | Austria | `eu_vat` | European VAT Number | * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | * | Bahamas | `bs_tin` | Bahamas Tax Identification Number | * | Bahrain | `bh_vat` | Bahraini VAT Number | * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | * | Barbados | `bb_tin` | Barbados Tax Identification Number | * | Belarus | `by_tin` | Belarus TIN Number | * | Belgium | `eu_vat` | European VAT Number | * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | * | Bolivia | `bo_tin` | Bolivian Tax ID | * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number | * | Brazil | `br_cnpj` | Brazilian CNPJ Number | * | Brazil | `br_cpf` | Brazilian CPF Number | * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | * | Bulgaria | `eu_vat` | European VAT Number | * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) | * | Cambodia | `kh_tin` | Cambodia Tax Identification Number | * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | * | Canada | `ca_bn` | Canadian BN | * | Canada | `ca_gst_hst` | Canadian GST/HST Number | * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | * | Canada | `ca_qst` | Canadian QST Number (Québec) | * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | * | Chile | `cl_tin` | Chilean TIN | * | China | `cn_tin` | Chinese Tax ID | * | Colombia | `co_nit` | Colombian NIT Number | * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | * | Costa Rica | `cr_tin` | Costa Rican Tax ID | * | Croatia | `eu_vat` | European VAT Number | * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | * | Cyprus | `eu_vat` | European VAT Number | * | Czech Republic | `eu_vat` | European VAT Number | * | Denmark | `eu_vat` | European VAT Number | * | Dominican Republic | `do_rcn` | Dominican RCN Number | * | Ecuador | `ec_ruc` | Ecuadorian RUC Number | * | Egypt | `eg_tin` | Egyptian Tax Identification Number | * | El Salvador | `sv_nit` | El Salvadorian NIT Number | * | Estonia | `eu_vat` | European VAT Number | * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | * | Finland | `eu_vat` | European VAT Number | * | France | `eu_vat` | European VAT Number | * | Georgia | `ge_vat` | Georgian VAT | * | Germany | `de_stn` | German Tax Number (Steuernummer) | * | Germany | `eu_vat` | European VAT Number | * | Greece | `eu_vat` | European VAT Number | * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | * | Hong Kong | `hk_br` | Hong Kong BR Number | * | Hungary | `eu_vat` | European VAT Number | * | Hungary | `hu_tin` | Hungary Tax Number (adószám) | * | Iceland | `is_vat` | Icelandic VAT | * | India | `in_gst` | Indian GST Number | * | Indonesia | `id_npwp` | Indonesian NPWP Number | * | Ireland | `eu_vat` | European VAT Number | * | Israel | `il_vat` | Israel VAT | * | Italy | `eu_vat` | European VAT Number | * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | * | Laos | `la_tin` | Laos Tax Identification Number | * | Latvia | `eu_vat` | European VAT Number | * | Liechtenstein | `li_uid` | Liechtensteinian UID Number | * | Liechtenstein | `li_vat` | Liechtenstein VAT Number | * | Lithuania | `eu_vat` | European VAT Number | * | Luxembourg | `eu_vat` | European VAT Number | * | Malaysia | `my_frp` | Malaysian FRP Number | * | Malaysia | `my_itn` | Malaysian ITN | * | Malaysia | `my_sst` | Malaysian SST Number | * | Malta | `eu_vat` | European VAT Number | * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | * | Mexico | `mx_rfc` | Mexican RFC Number | * | Moldova | `md_vat` | Moldova VAT Number | * | Montenegro | `me_pib` | Montenegro PIB Number | * | Morocco | `ma_vat` | Morocco VAT Number | * | Nepal | `np_pan` | Nepal PAN Number | * | Netherlands | `eu_vat` | European VAT Number | * | New Zealand | `nz_gst` | New Zealand GST Number | * | Nigeria | `ng_tin` | Nigerian Tax Identification Number | * | North Macedonia | `mk_vat` | North Macedonia VAT Number | * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number | * | Norway | `no_vat` | Norwegian VAT Number | * | Norway | `no_voec` | Norwegian VAT on e-commerce Number | * | Oman | `om_vat` | Omani VAT Number | * | Peru | `pe_ruc` | Peruvian RUC Number | * | Philippines | `ph_tin` | Philippines Tax Identification Number | * | Poland | `eu_vat` | European VAT Number | * | Poland | `pl_nip` | Polish Tax ID Number | * | Portugal | `eu_vat` | European VAT Number | * | Romania | `eu_vat` | European VAT Number | * | Romania | `ro_tin` | Romanian Tax ID Number | * | Russia | `ru_inn` | Russian INN | * | Russia | `ru_kpp` | Russian KPP | * | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | * | Senegal | `sn_ninea` | Senegal NINEA Number | * | Serbia | `rs_pib` | Serbian PIB Number | * | Singapore | `sg_gst` | Singaporean GST | * | Singapore | `sg_uen` | Singaporean UEN | * | Slovakia | `eu_vat` | European VAT Number | * | Slovenia | `eu_vat` | European VAT Number | * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | * | South Africa | `za_vat` | South African VAT Number | * | South Korea | `kr_brn` | Korean BRN | * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | * | Spain | `eu_vat` | European VAT Number | * | Suriname | `sr_fin` | Suriname FIN Number | * | Sweden | `eu_vat` | European VAT Number | * | Switzerland | `ch_uid` | Switzerland UID Number | * | Switzerland | `ch_vat` | Switzerland VAT Number | * | Taiwan | `tw_vat` | Taiwanese VAT | * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | * | Tanzania | `tz_vat` | Tanzania VAT Number | * | Thailand | `th_vat` | Thai VAT | * | Turkey | `tr_tin` | Turkish Tax Identification Number | * | Uganda | `ug_tin` | Uganda Tax Identification Number | * | Ukraine | `ua_vat` | Ukrainian VAT | * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | * | United Kingdom | `gb_vat` | United Kingdom VAT Number | * | United States | `us_ein` | United States EIN | * | Uruguay | `uy_ruc` | Uruguayan RUC Number | * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | * | Venezuela | `ve_rif` | Venezuelan RIF Number | * | Vietnam | `vn_tin` | Vietnamese Tax ID Number | * | Zambia | `zm_tin` | Zambia Tax Identification Number | * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number | */ customer_tax_id: Shared.CustomerTaxID | null; /** * @deprecated This field is deprecated in favor of `discounts`. If a `discounts` * list is provided, the first discount in the list will be returned. If the list * is empty, `None` will be returned. */ discount: unknown; discounts: Array; /** * When the invoice payment is due. The due date is null if the invoice is not yet * finalized. */ due_date: string | null; /** * If the invoice has a status of `draft`, this will be the time that the invoice * will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is * true, the invoice will automatically begin issuing at this time. */ eligible_to_issue_at: string | null; /** * A URL for the customer-facing invoice portal. This URL expires 30 days after the * invoice's due date, or 60 days after being re-generated through the UI. */ hosted_invoice_url: string | null; /** * Automatically generated invoice number to help track and reconcile invoices. * Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per * account or customer. */ invoice_number: string; /** * The link to download the PDF representation of the `Invoice`. */ invoice_pdf: string | null; invoice_source: 'subscription' | 'partial' | 'one_off'; /** * If the invoice failed to issue, this will be the last time it failed to issue * (even if it is now in a different state.) */ issue_failed_at: string | null; /** * If the invoice has been issued, this will be the time it transitioned to * `issued` (even if it is now in a different state.) */ issued_at: string | null; /** * The breakdown of prices in this invoice. */ line_items: Array; maximum: Shared.Maximum | null; maximum_amount: string | null; /** * Free-form text which is available on the invoice PDF and the Orb invoice portal. */ memo: string | null; /** * User specified key-value pairs for the resource. If not present, this defaults * to an empty dictionary. Individual keys can be removed by setting the value to * `null`, and the entire metadata mapping can be cleared by setting `metadata` to * `null`. */ metadata: { [key: string]: string }; minimum: Shared.Minimum | null; minimum_amount: string | null; /** * If the invoice has a status of `paid`, this gives a timestamp when the invoice * was paid. */ paid_at: string | null; /** * A list of payment attempts associated with the invoice */ payment_attempts: Array; /** * If payment was attempted on this invoice but failed, this will be the time of * the most recent attempt. */ payment_failed_at: string | null; /** * If payment was attempted on this invoice, this will be the start time of the * most recent attempt. This field is especially useful for delayed-notification * payment mechanisms (like bank transfers), where payment can take 3 days or more. */ payment_started_at: string | null; /** * If the invoice is in draft, this timestamp will reflect when the invoice is * scheduled to be issued. */ scheduled_issue_at: string | null; shipping_address: Shared.Address | null; status: 'issued' | 'paid' | 'synced' | 'void' | 'draft'; subscription: Shared.SubscriptionMinified | null; /** * The total before any discounts and minimums are applied. */ subtotal: string; /** * If the invoice failed to sync, this will be the last time an external invoicing * provider sync was attempted. This field will always be `null` for invoices using * Orb Invoicing. */ sync_failed_at: string | null; /** * The scheduled date of the invoice */ target_date: string; /** * The total after any minimums and discounts have been applied. */ total: string; /** * If the invoice has a status of `void`, this gives a timestamp when the invoice * was voided. */ voided_at: string | null; /** * This is true if the invoice will be automatically issued in the future, and * false otherwise. */ will_auto_issue: boolean; } export namespace InvoiceFetchUpcomingResponse { export interface AutoCollection { /** * True only if auto-collection is enabled for this invoice. */ enabled: boolean | null; /** * If the invoice is scheduled for auto-collection, this field will reflect when * the next attempt will occur. If dunning has been exhausted, or auto-collection * is not enabled for this invoice, this field will be `null`. */ next_attempt_at: string | null; /** * Number of auto-collection payment attempts. */ num_attempts: number | null; /** * If Orb has ever attempted payment auto-collection for this invoice, this field * will reflect when that attempt occurred. In conjunction with `next_attempt_at`, * this can be used to tell whether the invoice is currently in dunning (that is, * `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or * if dunning has been exhausted (`previously_attempted_at` is non-null, but * `next_attempt_time` is null). */ previously_attempted_at: string | null; } export interface CreditNote { id: string; credit_note_number: string; /** * An optional memo supplied on the credit note. */ memo: string | null; reason: string; total: string; type: string; /** * If the credit note has a status of `void`, this gives a timestamp when the * credit note was voided. */ voided_at: string | null; } export interface CustomerBalanceTransaction { /** * A unique id for this transaction. */ id: string; action: | 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover'; /** * The value of the amount changed in the transaction. */ amount: string; /** * The creation time of this transaction. */ created_at: string; credit_note: Shared.CreditNoteTiny | null; /** * An optional description provided for manual customer balance adjustments. */ description: string | null; /** * The new value of the customer's balance prior to the transaction, in the * customer's currency. */ ending_balance: string; invoice: Shared.InvoiceTiny | null; /** * The original value of the customer's balance prior to the transaction, in the * customer's currency. */ starting_balance: string; type: 'increment' | 'decrement'; } export interface LineItem { /** * A unique ID for this line item. */ id: string; /** * The line amount after any adjustments and before overage conversion, credits and * partial invoicing. */ adjusted_subtotal: string; /** * All adjustments applied to the line item in the order they were applied based on * invoice calculations (ie. usage discounts -> amount discounts -> percentage * discounts -> minimums -> maximums). */ adjustments: Array< | Shared.MonetaryUsageDiscountAdjustment | Shared.MonetaryAmountDiscountAdjustment | Shared.MonetaryPercentageDiscountAdjustment | Shared.MonetaryMinimumAdjustment | Shared.MonetaryMaximumAdjustment >; /** * The final amount for a line item after all adjustments and pre paid credits have * been applied. */ amount: string; /** * The number of prepaid credits applied. */ credits_applied: string; /** * The end date of the range of time applied for this line item's price. */ end_date: string; /** * An additional filter that was used to calculate the usage for this line item. */ filter: string | null; /** * [DEPRECATED] For configured prices that are split by a grouping key, this will * be populated with the key and a value. The `amount` and `subtotal` will be the * values for this particular grouping. */ grouping: string | null; /** * The name of the price associated with this line item. */ name: string; /** * Any amount applied from a partial invoice */ partially_invoiced_amount: string; /** * The Price resource represents a price that can be billed on a subscription, * resulting in a charge on an invoice in the form of an invoice line item. Prices * take a quantity and determine an amount to bill. * * Orb supports a few different pricing models out of the box. Each of these models * is serialized differently in a given Price object. The model_type field * determines the key for the configuration object that is present. * * For more on the types of prices, see * [the core concepts documentation](/core-concepts#plan-and-price) */ price: Shared.Price; /** * Either the fixed fee quantity or the usage during the service period. */ quantity: number; /** * The start date of the range of time applied for this line item's price. */ start_date: string; /** * For complex pricing structures, the line item can be broken down further in * `sub_line_items`. */ sub_line_items: Array; /** * The line amount before any adjustments. */ subtotal: string; /** * An array of tax rates and their incurred tax amounts. Empty if no tax * integration is configured. */ tax_amounts: Array; /** * A list of customer ids that were used to calculate the usage for this line item. */ usage_customer_ids: Array | null; } export interface PaymentAttempt { /** * The ID of the payment attempt. */ id: string; /** * The amount of the payment attempt. */ amount: string; /** * The time at which the payment attempt was created. */ created_at: string; /** * The payment provider that attempted to collect the payment. */ payment_provider: 'stripe' | null; /** * The ID of the payment attempt in the payment provider. */ payment_provider_id: string | null; /** * URL to the downloadable PDF version of the receipt. This field will be `null` * for payment attempts that did not succeed. */ receipt_pdf: string | null; /** * Whether the payment attempt succeeded. */ succeeded: boolean; } } /** * #InvoiceApiResourceWithoutLineItems */ export interface InvoiceIssueSummaryResponse { id: string; /** * This is the final amount required to be charged to the customer and reflects the * application of the customer balance to the `total` of the invoice. */ amount_due: string; auto_collection: InvoiceIssueSummaryResponse.AutoCollection; billing_address: Shared.Address | null; /** * The creation time of the resource in Orb. */ created_at: string; /** * A list of credit notes associated with the invoice */ credit_notes: Array; /** * An ISO 4217 currency string or `credits` */ currency: string; customer: Shared.CustomerMinified; customer_balance_transactions: Array; /** * Tax IDs are commonly required to be displayed on customer invoices, which are * added to the headers of invoices. * * ### Supported Tax ID Countries and Types * * | Country | Type | Description | * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | * | Albania | `al_tin` | Albania Tax Identification Number | * | Andorra | `ad_nrt` | Andorran NRT Number | * | Angola | `ao_tin` | Angola Tax Identification Number | * | Argentina | `ar_cuit` | Argentinian Tax ID Number | * | Armenia | `am_tin` | Armenia Tax Identification Number | * | Aruba | `aw_tin` | Aruba Tax Identification Number | * | Australia | `au_abn` | Australian Business Number (AU ABN) | * | Australia | `au_arn` | Australian Taxation Office Reference Number | * | Austria | `eu_vat` | European VAT Number | * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | * | Bahamas | `bs_tin` | Bahamas Tax Identification Number | * | Bahrain | `bh_vat` | Bahraini VAT Number | * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | * | Barbados | `bb_tin` | Barbados Tax Identification Number | * | Belarus | `by_tin` | Belarus TIN Number | * | Belgium | `eu_vat` | European VAT Number | * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | * | Bolivia | `bo_tin` | Bolivian Tax ID | * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number | * | Brazil | `br_cnpj` | Brazilian CNPJ Number | * | Brazil | `br_cpf` | Brazilian CPF Number | * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | * | Bulgaria | `eu_vat` | European VAT Number | * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) | * | Cambodia | `kh_tin` | Cambodia Tax Identification Number | * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | * | Canada | `ca_bn` | Canadian BN | * | Canada | `ca_gst_hst` | Canadian GST/HST Number | * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | * | Canada | `ca_qst` | Canadian QST Number (Québec) | * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | * | Chile | `cl_tin` | Chilean TIN | * | China | `cn_tin` | Chinese Tax ID | * | Colombia | `co_nit` | Colombian NIT Number | * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | * | Costa Rica | `cr_tin` | Costa Rican Tax ID | * | Croatia | `eu_vat` | European VAT Number | * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | * | Cyprus | `eu_vat` | European VAT Number | * | Czech Republic | `eu_vat` | European VAT Number | * | Denmark | `eu_vat` | European VAT Number | * | Dominican Republic | `do_rcn` | Dominican RCN Number | * | Ecuador | `ec_ruc` | Ecuadorian RUC Number | * | Egypt | `eg_tin` | Egyptian Tax Identification Number | * | El Salvador | `sv_nit` | El Salvadorian NIT Number | * | Estonia | `eu_vat` | European VAT Number | * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | * | Finland | `eu_vat` | European VAT Number | * | France | `eu_vat` | European VAT Number | * | Georgia | `ge_vat` | Georgian VAT | * | Germany | `de_stn` | German Tax Number (Steuernummer) | * | Germany | `eu_vat` | European VAT Number | * | Greece | `eu_vat` | European VAT Number | * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | * | Hong Kong | `hk_br` | Hong Kong BR Number | * | Hungary | `eu_vat` | European VAT Number | * | Hungary | `hu_tin` | Hungary Tax Number (adószám) | * | Iceland | `is_vat` | Icelandic VAT | * | India | `in_gst` | Indian GST Number | * | Indonesia | `id_npwp` | Indonesian NPWP Number | * | Ireland | `eu_vat` | European VAT Number | * | Israel | `il_vat` | Israel VAT | * | Italy | `eu_vat` | European VAT Number | * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | * | Laos | `la_tin` | Laos Tax Identification Number | * | Latvia | `eu_vat` | European VAT Number | * | Liechtenstein | `li_uid` | Liechtensteinian UID Number | * | Liechtenstein | `li_vat` | Liechtenstein VAT Number | * | Lithuania | `eu_vat` | European VAT Number | * | Luxembourg | `eu_vat` | European VAT Number | * | Malaysia | `my_frp` | Malaysian FRP Number | * | Malaysia | `my_itn` | Malaysian ITN | * | Malaysia | `my_sst` | Malaysian SST Number | * | Malta | `eu_vat` | European VAT Number | * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | * | Mexico | `mx_rfc` | Mexican RFC Number | * | Moldova | `md_vat` | Moldova VAT Number | * | Montenegro | `me_pib` | Montenegro PIB Number | * | Morocco | `ma_vat` | Morocco VAT Number | * | Nepal | `np_pan` | Nepal PAN Number | * | Netherlands | `eu_vat` | European VAT Number | * | New Zealand | `nz_gst` | New Zealand GST Number | * | Nigeria | `ng_tin` | Nigerian Tax Identification Number | * | North Macedonia | `mk_vat` | North Macedonia VAT Number | * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number | * | Norway | `no_vat` | Norwegian VAT Number | * | Norway | `no_voec` | Norwegian VAT on e-commerce Number | * | Oman | `om_vat` | Omani VAT Number | * | Peru | `pe_ruc` | Peruvian RUC Number | * | Philippines | `ph_tin` | Philippines Tax Identification Number | * | Poland | `eu_vat` | European VAT Number | * | Poland | `pl_nip` | Polish Tax ID Number | * | Portugal | `eu_vat` | European VAT Number | * | Romania | `eu_vat` | European VAT Number | * | Romania | `ro_tin` | Romanian Tax ID Number | * | Russia | `ru_inn` | Russian INN | * | Russia | `ru_kpp` | Russian KPP | * | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | * | Senegal | `sn_ninea` | Senegal NINEA Number | * | Serbia | `rs_pib` | Serbian PIB Number | * | Singapore | `sg_gst` | Singaporean GST | * | Singapore | `sg_uen` | Singaporean UEN | * | Slovakia | `eu_vat` | European VAT Number | * | Slovenia | `eu_vat` | European VAT Number | * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | * | South Africa | `za_vat` | South African VAT Number | * | South Korea | `kr_brn` | Korean BRN | * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | * | Spain | `eu_vat` | European VAT Number | * | Suriname | `sr_fin` | Suriname FIN Number | * | Sweden | `eu_vat` | European VAT Number | * | Switzerland | `ch_uid` | Switzerland UID Number | * | Switzerland | `ch_vat` | Switzerland VAT Number | * | Taiwan | `tw_vat` | Taiwanese VAT | * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | * | Tanzania | `tz_vat` | Tanzania VAT Number | * | Thailand | `th_vat` | Thai VAT | * | Turkey | `tr_tin` | Turkish Tax Identification Number | * | Uganda | `ug_tin` | Uganda Tax Identification Number | * | Ukraine | `ua_vat` | Ukrainian VAT | * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | * | United Kingdom | `gb_vat` | United Kingdom VAT Number | * | United States | `us_ein` | United States EIN | * | Uruguay | `uy_ruc` | Uruguayan RUC Number | * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | * | Venezuela | `ve_rif` | Venezuelan RIF Number | * | Vietnam | `vn_tin` | Vietnamese Tax ID Number | * | Zambia | `zm_tin` | Zambia Tax Identification Number | * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number | */ customer_tax_id: Shared.CustomerTaxID | null; /** * When the invoice payment is due. The due date is null if the invoice is not yet * finalized. */ due_date: string | null; /** * If the invoice has a status of `draft`, this will be the time that the invoice * will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is * true, the invoice will automatically begin issuing at this time. */ eligible_to_issue_at: string | null; /** * A URL for the customer-facing invoice portal. This URL expires 30 days after the * invoice's due date, or 60 days after being re-generated through the UI. */ hosted_invoice_url: string | null; /** * The scheduled date of the invoice */ invoice_date: string; /** * Automatically generated invoice number to help track and reconcile invoices. * Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per * account or customer. */ invoice_number: string; /** * The link to download the PDF representation of the `Invoice`. */ invoice_pdf: string | null; invoice_source: 'subscription' | 'partial' | 'one_off'; /** * If the invoice failed to issue, this will be the last time it failed to issue * (even if it is now in a different state.) */ issue_failed_at: string | null; /** * If the invoice has been issued, this will be the time it transitioned to * `issued` (even if it is now in a different state.) */ issued_at: string | null; /** * Free-form text which is available on the invoice PDF and the Orb invoice portal. */ memo: string | null; /** * User specified key-value pairs for the resource. If not present, this defaults * to an empty dictionary. Individual keys can be removed by setting the value to * `null`, and the entire metadata mapping can be cleared by setting `metadata` to * `null`. */ metadata: { [key: string]: string }; /** * If the invoice has a status of `paid`, this gives a timestamp when the invoice * was paid. */ paid_at: string | null; /** * A list of payment attempts associated with the invoice */ payment_attempts: Array; /** * If payment was attempted on this invoice but failed, this will be the time of * the most recent attempt. */ payment_failed_at: string | null; /** * If payment was attempted on this invoice, this will be the start time of the * most recent attempt. This field is especially useful for delayed-notification * payment mechanisms (like bank transfers), where payment can take 3 days or more. */ payment_started_at: string | null; /** * If the invoice is in draft, this timestamp will reflect when the invoice is * scheduled to be issued. */ scheduled_issue_at: string | null; shipping_address: Shared.Address | null; status: 'issued' | 'paid' | 'synced' | 'void' | 'draft'; subscription: Shared.SubscriptionMinified | null; /** * If the invoice failed to sync, this will be the last time an external invoicing * provider sync was attempted. This field will always be `null` for invoices using * Orb Invoicing. */ sync_failed_at: string | null; /** * The total after any minimums and discounts have been applied. */ total: string; /** * If the invoice has a status of `void`, this gives a timestamp when the invoice * was voided. */ voided_at: string | null; /** * This is true if the invoice will be automatically issued in the future, and * false otherwise. */ will_auto_issue: boolean; } export namespace InvoiceIssueSummaryResponse { export interface AutoCollection { /** * True only if auto-collection is enabled for this invoice. */ enabled: boolean | null; /** * If the invoice is scheduled for auto-collection, this field will reflect when * the next attempt will occur. If dunning has been exhausted, or auto-collection * is not enabled for this invoice, this field will be `null`. */ next_attempt_at: string | null; /** * Number of auto-collection payment attempts. */ num_attempts: number | null; /** * If Orb has ever attempted payment auto-collection for this invoice, this field * will reflect when that attempt occurred. In conjunction with `next_attempt_at`, * this can be used to tell whether the invoice is currently in dunning (that is, * `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or * if dunning has been exhausted (`previously_attempted_at` is non-null, but * `next_attempt_time` is null). */ previously_attempted_at: string | null; } export interface CreditNote { id: string; credit_note_number: string; /** * An optional memo supplied on the credit note. */ memo: string | null; reason: string; total: string; type: string; /** * If the credit note has a status of `void`, this gives a timestamp when the * credit note was voided. */ voided_at: string | null; } export interface CustomerBalanceTransaction { /** * A unique id for this transaction. */ id: string; action: | 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover'; /** * The value of the amount changed in the transaction. */ amount: string; /** * The creation time of this transaction. */ created_at: string; credit_note: Shared.CreditNoteTiny | null; /** * An optional description provided for manual customer balance adjustments. */ description: string | null; /** * The new value of the customer's balance prior to the transaction, in the * customer's currency. */ ending_balance: string; invoice: Shared.InvoiceTiny | null; /** * The original value of the customer's balance prior to the transaction, in the * customer's currency. */ starting_balance: string; type: 'increment' | 'decrement'; } export interface PaymentAttempt { /** * The ID of the payment attempt. */ id: string; /** * The amount of the payment attempt. */ amount: string; /** * The time at which the payment attempt was created. */ created_at: string; /** * The payment provider that attempted to collect the payment. */ payment_provider: 'stripe' | null; /** * The ID of the payment attempt in the payment provider. */ payment_provider_id: string | null; /** * URL to the downloadable PDF version of the receipt. This field will be `null` * for payment attempts that did not succeed. */ receipt_pdf: string | null; /** * Whether the payment attempt succeeded. */ succeeded: boolean; } } /** * #InvoiceApiResourceWithoutLineItems */ export interface InvoiceListSummaryResponse { id: string; /** * This is the final amount required to be charged to the customer and reflects the * application of the customer balance to the `total` of the invoice. */ amount_due: string; auto_collection: InvoiceListSummaryResponse.AutoCollection; billing_address: Shared.Address | null; /** * The creation time of the resource in Orb. */ created_at: string; /** * A list of credit notes associated with the invoice */ credit_notes: Array; /** * An ISO 4217 currency string or `credits` */ currency: string; customer: Shared.CustomerMinified; customer_balance_transactions: Array; /** * Tax IDs are commonly required to be displayed on customer invoices, which are * added to the headers of invoices. * * ### Supported Tax ID Countries and Types * * | Country | Type | Description | * | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | * | Albania | `al_tin` | Albania Tax Identification Number | * | Andorra | `ad_nrt` | Andorran NRT Number | * | Angola | `ao_tin` | Angola Tax Identification Number | * | Argentina | `ar_cuit` | Argentinian Tax ID Number | * | Armenia | `am_tin` | Armenia Tax Identification Number | * | Aruba | `aw_tin` | Aruba Tax Identification Number | * | Australia | `au_abn` | Australian Business Number (AU ABN) | * | Australia | `au_arn` | Australian Taxation Office Reference Number | * | Austria | `eu_vat` | European VAT Number | * | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | * | Bahamas | `bs_tin` | Bahamas Tax Identification Number | * | Bahrain | `bh_vat` | Bahraini VAT Number | * | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | * | Barbados | `bb_tin` | Barbados Tax Identification Number | * | Belarus | `by_tin` | Belarus TIN Number | * | Belgium | `eu_vat` | European VAT Number | * | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | * | Bolivia | `bo_tin` | Bolivian Tax ID | * | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number | * | Brazil | `br_cnpj` | Brazilian CNPJ Number | * | Brazil | `br_cpf` | Brazilian CPF Number | * | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | * | Bulgaria | `eu_vat` | European VAT Number | * | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) | * | Cambodia | `kh_tin` | Cambodia Tax Identification Number | * | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | * | Canada | `ca_bn` | Canadian BN | * | Canada | `ca_gst_hst` | Canadian GST/HST Number | * | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | * | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | * | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | * | Canada | `ca_qst` | Canadian QST Number (Québec) | * | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | * | Chile | `cl_tin` | Chilean TIN | * | China | `cn_tin` | Chinese Tax ID | * | Colombia | `co_nit` | Colombian NIT Number | * | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | * | Costa Rica | `cr_tin` | Costa Rican Tax ID | * | Croatia | `eu_vat` | European VAT Number | * | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | * | Cyprus | `eu_vat` | European VAT Number | * | Czech Republic | `eu_vat` | European VAT Number | * | Denmark | `eu_vat` | European VAT Number | * | Dominican Republic | `do_rcn` | Dominican RCN Number | * | Ecuador | `ec_ruc` | Ecuadorian RUC Number | * | Egypt | `eg_tin` | Egyptian Tax Identification Number | * | El Salvador | `sv_nit` | El Salvadorian NIT Number | * | Estonia | `eu_vat` | European VAT Number | * | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | * | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | * | Finland | `eu_vat` | European VAT Number | * | France | `eu_vat` | European VAT Number | * | Georgia | `ge_vat` | Georgian VAT | * | Germany | `de_stn` | German Tax Number (Steuernummer) | * | Germany | `eu_vat` | European VAT Number | * | Greece | `eu_vat` | European VAT Number | * | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | * | Hong Kong | `hk_br` | Hong Kong BR Number | * | Hungary | `eu_vat` | European VAT Number | * | Hungary | `hu_tin` | Hungary Tax Number (adószám) | * | Iceland | `is_vat` | Icelandic VAT | * | India | `in_gst` | Indian GST Number | * | Indonesia | `id_npwp` | Indonesian NPWP Number | * | Ireland | `eu_vat` | European VAT Number | * | Israel | `il_vat` | Israel VAT | * | Italy | `eu_vat` | European VAT Number | * | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | * | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | * | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | * | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | * | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | * | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | * | Laos | `la_tin` | Laos Tax Identification Number | * | Latvia | `eu_vat` | European VAT Number | * | Liechtenstein | `li_uid` | Liechtensteinian UID Number | * | Liechtenstein | `li_vat` | Liechtenstein VAT Number | * | Lithuania | `eu_vat` | European VAT Number | * | Luxembourg | `eu_vat` | European VAT Number | * | Malaysia | `my_frp` | Malaysian FRP Number | * | Malaysia | `my_itn` | Malaysian ITN | * | Malaysia | `my_sst` | Malaysian SST Number | * | Malta | `eu_vat` | European VAT Number | * | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | * | Mexico | `mx_rfc` | Mexican RFC Number | * | Moldova | `md_vat` | Moldova VAT Number | * | Montenegro | `me_pib` | Montenegro PIB Number | * | Morocco | `ma_vat` | Morocco VAT Number | * | Nepal | `np_pan` | Nepal PAN Number | * | Netherlands | `eu_vat` | European VAT Number | * | New Zealand | `nz_gst` | New Zealand GST Number | * | Nigeria | `ng_tin` | Nigerian Tax Identification Number | * | North Macedonia | `mk_vat` | North Macedonia VAT Number | * | Northern Ireland | `eu_vat` | Northern Ireland VAT Number | * | Norway | `no_vat` | Norwegian VAT Number | * | Norway | `no_voec` | Norwegian VAT on e-commerce Number | * | Oman | `om_vat` | Omani VAT Number | * | Peru | `pe_ruc` | Peruvian RUC Number | * | Philippines | `ph_tin` | Philippines Tax Identification Number | * | Poland | `eu_vat` | European VAT Number | * | Poland | `pl_nip` | Polish Tax ID Number | * | Portugal | `eu_vat` | European VAT Number | * | Romania | `eu_vat` | European VAT Number | * | Romania | `ro_tin` | Romanian Tax ID Number | * | Russia | `ru_inn` | Russian INN | * | Russia | `ru_kpp` | Russian KPP | * | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | * | Senegal | `sn_ninea` | Senegal NINEA Number | * | Serbia | `rs_pib` | Serbian PIB Number | * | Singapore | `sg_gst` | Singaporean GST | * | Singapore | `sg_uen` | Singaporean UEN | * | Slovakia | `eu_vat` | European VAT Number | * | Slovenia | `eu_vat` | European VAT Number | * | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | * | South Africa | `za_vat` | South African VAT Number | * | South Korea | `kr_brn` | Korean BRN | * | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | * | Spain | `eu_vat` | European VAT Number | * | Suriname | `sr_fin` | Suriname FIN Number | * | Sweden | `eu_vat` | European VAT Number | * | Switzerland | `ch_uid` | Switzerland UID Number | * | Switzerland | `ch_vat` | Switzerland VAT Number | * | Taiwan | `tw_vat` | Taiwanese VAT | * | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | * | Tanzania | `tz_vat` | Tanzania VAT Number | * | Thailand | `th_vat` | Thai VAT | * | Turkey | `tr_tin` | Turkish Tax Identification Number | * | Uganda | `ug_tin` | Uganda Tax Identification Number | * | Ukraine | `ua_vat` | Ukrainian VAT | * | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | * | United Kingdom | `gb_vat` | United Kingdom VAT Number | * | United States | `us_ein` | United States EIN | * | Uruguay | `uy_ruc` | Uruguayan RUC Number | * | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | * | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | * | Venezuela | `ve_rif` | Venezuelan RIF Number | * | Vietnam | `vn_tin` | Vietnamese Tax ID Number | * | Zambia | `zm_tin` | Zambia Tax Identification Number | * | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number | */ customer_tax_id: Shared.CustomerTaxID | null; /** * When the invoice payment is due. The due date is null if the invoice is not yet * finalized. */ due_date: string | null; /** * If the invoice has a status of `draft`, this will be the time that the invoice * will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is * true, the invoice will automatically begin issuing at this time. */ eligible_to_issue_at: string | null; /** * A URL for the customer-facing invoice portal. This URL expires 30 days after the * invoice's due date, or 60 days after being re-generated through the UI. */ hosted_invoice_url: string | null; /** * The scheduled date of the invoice */ invoice_date: string; /** * Automatically generated invoice number to help track and reconcile invoices. * Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per * account or customer. */ invoice_number: string; /** * The link to download the PDF representation of the `Invoice`. */ invoice_pdf: string | null; invoice_source: 'subscription' | 'partial' | 'one_off'; /** * If the invoice failed to issue, this will be the last time it failed to issue * (even if it is now in a different state.) */ issue_failed_at: string | null; /** * If the invoice has been issued, this will be the time it transitioned to * `issued` (even if it is now in a different state.) */ issued_at: string | null; /** * Free-form text which is available on the invoice PDF and the Orb invoice portal. */ memo: string | null; /** * User specified key-value pairs for the resource. If not present, this defaults * to an empty dictionary. Individual keys can be removed by setting the value to * `null`, and the entire metadata mapping can be cleared by setting `metadata` to * `null`. */ metadata: { [key: string]: string }; /** * If the invoice has a status of `paid`, this gives a timestamp when the invoice * was paid. */ paid_at: string | null; /** * A list of payment attempts associated with the invoice */ payment_attempts: Array; /** * If payment was attempted on this invoice but failed, this will be the time of * the most recent attempt. */ payment_failed_at: string | null; /** * If payment was attempted on this invoice, this will be the start time of the * most recent attempt. This field is especially useful for delayed-notification * payment mechanisms (like bank transfers), where payment can take 3 days or more. */ payment_started_at: string | null; /** * If the invoice is in draft, this timestamp will reflect when the invoice is * scheduled to be issued. */ scheduled_issue_at: string | null; shipping_address: Shared.Address | null; status: 'issued' | 'paid' | 'synced' | 'void' | 'draft'; subscription: Shared.SubscriptionMinified | null; /** * If the invoice failed to sync, this will be the last time an external invoicing * provider sync was attempted. This field will always be `null` for invoices using * Orb Invoicing. */ sync_failed_at: string | null; /** * The total after any minimums and discounts have been applied. */ total: string; /** * If the invoice has a status of `void`, this gives a timestamp when the invoice * was voided. */ voided_at: string | null; /** * This is true if the invoice will be automatically issued in the future, and * false otherwise. */ will_auto_issue: boolean; } export namespace InvoiceListSummaryResponse { export interface AutoCollection { /** * True only if auto-collection is enabled for this invoice. */ enabled: boolean | null; /** * If the invoice is scheduled for auto-collection, this field will reflect when * the next attempt will occur. If dunning has been exhausted, or auto-collection * is not enabled for this invoice, this field will be `null`. */ next_attempt_at: string | null; /** * Number of auto-collection payment attempts. */ num_attempts: number | null; /** * If Orb has ever attempted payment auto-collection for this invoice, this field * will reflect when that attempt occurred. In conjunction with `next_attempt_at`, * this can be used to tell whether the invoice is currently in dunning (that is, * `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or * if dunning has been exhausted (`previously_attempted_at` is non-null, but * `next_attempt_time` is null). */ previously_attempted_at: string | null; } export interface CreditNote { id: string; credit_note_number: string; /** * An optional memo supplied on the credit note. */ memo: string | null; reason: string; total: string; type: string; /** * If the credit note has a status of `void`, this gives a timestamp when the * credit note was voided. */ voided_at: string | null; } export interface CustomerBalanceTransaction { /** * A unique id for this transaction. */ id: string; action: | 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover'; /** * The value of the amount changed in the transaction. */ amount: string; /** * The creation time of this transaction. */ created_at: string; credit_note: Shared.CreditNoteTiny | null; /** * An optional description provided for manual customer balance adjustments. */ description: string | null; /** * The new value of the customer's balance prior to the transaction, in the * customer's currency. */ ending_balance: string; invoice: Shared.InvoiceTiny | null; /** * The original value of the customer's balance prior to the transaction, in the * customer's currency. */ starting_balance: string; type: 'increment' | 'decrement'; } export interface PaymentAttempt { /** * The ID of the payment attempt. */ id: string; /** * The amount of the payment attempt. */ amount: string; /** * The time at which the payment attempt was created. */ created_at: string; /** * The payment provider that attempted to collect the payment. */ payment_provider: 'stripe' | null; /** * The ID of the payment attempt in the payment provider. */ payment_provider_id: string | null; /** * URL to the downloadable PDF version of the receipt. This field will be `null` * for payment attempts that did not succeed. */ receipt_pdf: string | null; /** * Whether the payment attempt succeeded. */ succeeded: boolean; } } export interface InvoiceCreateParams { /** * An ISO 4217 currency string. Must be the same as the customer's currency if it * is set. */ currency: string; /** * Optional invoice date to set. Must be in the past, if not set, `invoice_date` is * set to the current time in the customer's timezone. */ invoice_date: string; line_items: Array; /** * Determines whether this invoice will automatically attempt to charge a saved * payment method, if any. If not specified, the invoice inherits the customer's * auto_collection setting. */ auto_collection?: boolean | null; /** * The id of the `Customer` to create this invoice for. One of `customer_id` and * `external_customer_id` are required. */ customer_id?: string | null; /** * An optional discount to attach to the invoice. */ discount?: Shared.Discount | null; /** * An optional custom due date for the invoice. If not set, the due date will be * calculated based on the `net_terms` value. */ due_date?: (string & {}) | (string & {}) | null; /** * The `external_customer_id` of the `Customer` to create this invoice for. One of * `customer_id` and `external_customer_id` are required. */ external_customer_id?: string | null; /** * An optional memo to attach to the invoice. If no memo is provided, we will * attach the default memo */ memo?: string | null; /** * User-specified key/value pairs for the resource. Individual keys can be removed * by setting the value to `null`, and the entire metadata mapping can be cleared * by setting `metadata` to `null`. */ metadata?: { [key: string]: string | null } | null; /** * The net terms determines the due date of the invoice. Due date is calculated * based on the invoice or issuance date, depending on the account's configured due * date calculation method. A value of '0' here represents that the invoice is due * on issue, whereas a value of '30' represents that the customer has 30 days to * pay the invoice. Do not set this field if you want to set a custom due date. */ net_terms?: number | null; /** * When true, this invoice will be submitted for issuance upon creation. When * false, the resulting invoice will require manual review to issue. Defaulted to * false. */ will_auto_issue?: boolean; } export namespace InvoiceCreateParams { export interface LineItem { /** * A date string to specify the line item's end date in the customer's timezone. */ end_date: string; item_id: string; model_type: 'unit'; /** * The name of the line item. */ name: string; /** * The number of units on the line item */ quantity: number; /** * A date string to specify the line item's start date in the customer's timezone. */ start_date: string; /** * Configuration for unit pricing */ unit_config: Shared.UnitConfig; } } export interface InvoiceUpdateParams { /** * Determines whether this invoice will automatically attempt to charge a saved * payment method, if any. Can only be modified on draft invoices. If not * specified, the invoice's existing setting is unchanged. */ auto_collection?: boolean | null; /** * An optional custom due date for the invoice. If not set, the due date will be * calculated based on the `net_terms` value. */ due_date?: (string & {}) | (string & {}) | null; /** * The date of the invoice. Can only be modified for one-off draft invoices. */ invoice_date?: (string & {}) | (string & {}) | null; /** * User-specified key/value pairs for the resource. Individual keys can be removed * by setting the value to `null`, and the entire metadata mapping can be cleared * by setting `metadata` to `null`. */ metadata?: { [key: string]: string | null } | null; /** * The net terms determines the due date of the invoice. Due date is calculated * based on the invoice or issuance date, depending on the account's configured due * date calculation method. A value of '0' here represents that the invoice is due * on issue, whereas a value of '30' represents that the customer has 30 days to * pay the invoice. Do not set this field if you want to set a custom due date. */ net_terms?: number | null; } export interface InvoiceListParams extends PageParams { amount?: string | null; 'amount[gt]'?: string | null; 'amount[lt]'?: string | null; customer_id?: string | null; date_type?: 'due_date' | 'invoice_date' | null; due_date?: string | null; /** * Filters invoices by their due dates within a specific time range in the past. * Specify the range as a number followed by 'd' (days) or 'm' (months). For * example, '7d' filters invoices due in the last 7 days, and '2m' filters those * due in the last 2 months. */ due_date_window?: string | null; 'due_date[gt]'?: string | null; 'due_date[lt]'?: string | null; external_customer_id?: string | null; 'invoice_date[gt]'?: string | null; 'invoice_date[gte]'?: string | null; 'invoice_date[lt]'?: string | null; 'invoice_date[lte]'?: string | null; is_recurring?: boolean | null; status?: Array<'draft' | 'issued' | 'paid' | 'synced' | 'void'> | null; subscription_id?: string | null; } export interface InvoiceFetchUpcomingParams { subscription_id: string; } export interface InvoiceIssueParams { /** * If true, the invoice will be issued synchronously. If false, the invoice will be * issued asynchronously. The synchronous option is only available for invoices * that have no usage fees. If the invoice is configured to sync to an external * provider, a successful response from this endpoint guarantees the invoice is * present in the provider. */ synchronous?: boolean; } export interface InvoiceIssueSummaryParams { /** * If true, the invoice will be issued synchronously. If false, the invoice will be * issued asynchronously. The synchronous option is only available for invoices * that have no usage fees. If the invoice is configured to sync to an external * provider, a successful response from this endpoint guarantees the invoice is * present in the provider. */ synchronous?: boolean; } export interface InvoiceListSummaryParams extends PageParams { amount?: string | null; 'amount[gt]'?: string | null; 'amount[lt]'?: string | null; customer_id?: string | null; date_type?: 'due_date' | 'invoice_date' | null; due_date?: string | null; /** * Filters invoices by their due dates within a specific time range in the past. * Specify the range as a number followed by 'd' (days) or 'm' (months). For * example, '7d' filters invoices due in the last 7 days, and '2m' filters those * due in the last 2 months. */ due_date_window?: string | null; 'due_date[gt]'?: string | null; 'due_date[lt]'?: string | null; external_customer_id?: string | null; 'invoice_date[gt]'?: string | null; 'invoice_date[gte]'?: string | null; 'invoice_date[lt]'?: string | null; 'invoice_date[lte]'?: string | null; is_recurring?: boolean | null; status?: 'draft' | 'issued' | 'paid' | 'synced' | 'void' | null; subscription_id?: string | null; } export interface InvoiceMarkPaidParams { /** * A date string to specify the date of the payment. */ payment_received_date: string; /** * An optional external ID to associate with the payment. */ external_id?: string | null; /** * An optional note to associate with the payment. */ notes?: string | null; } export interface InvoicePayParams { /** * The ID of a shared payment token granted by an agent to use for this payment. */ shared_payment_token_id: string; } Invoices.InvoiceListSummaryResponsesPage = InvoiceListSummaryResponsesPage; export declare namespace Invoices { export { type InvoiceFetchUpcomingResponse as InvoiceFetchUpcomingResponse, type InvoiceIssueSummaryResponse as InvoiceIssueSummaryResponse, type InvoiceListSummaryResponse as InvoiceListSummaryResponse, InvoiceListSummaryResponsesPage as InvoiceListSummaryResponsesPage, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceUpdateParams as InvoiceUpdateParams, type InvoiceListParams as InvoiceListParams, type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams, type InvoiceIssueParams as InvoiceIssueParams, type InvoiceIssueSummaryParams as InvoiceIssueSummaryParams, type InvoiceListSummaryParams as InvoiceListSummaryParams, type InvoiceMarkPaidParams as InvoiceMarkPaidParams, type InvoicePayParams as InvoicePayParams, }; } export { InvoicesPage };