orb-billing 4.74.0 → 5.1.0

package/resources/invoices.d.ts

@@ -1,13 +1,13 @@
 import { APIResource } from "../resource.js";
 import * as Core from "../core.js";
 import * as Shared from "./shared.js";
-import * as PricesAPI from "./prices/prices.js";
-import { Page, type PageParams } from "../pagination.js";
+import { InvoicesPage } from "./shared.js";
+import { type PageParams } from "../pagination.js";
 export declare 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<Invoice>;
+    create(body: InvoiceCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
     /**
      * This endpoint allows you to update the `metadata` property on an invoice. If you
      * pass null for the metadata value, it will clear any existing metadata for that
@@ -15,7 +15,7 @@ export declare class Invoices extends APIResource {
      *
      * `metadata` can be modified regardless of invoice state.
      */
-    update(invoiceId: string, body: InvoiceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    update(invoiceId: string, body: InvoiceUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
     /**
      * This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an
      * account in a list format.
@@ -31,13 +31,13 @@ export declare class Invoices extends APIResource {
      * 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<InvoicesPage, Invoice>;
-    list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Invoice>;
+    list(query?: InvoiceListParams, options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Shared.Invoice>;
+    list(options?: Core.RequestOptions): Core.PagePromise<InvoicesPage, Shared.Invoice>;
     /**
      * This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
      * identifier.
      */
-    fetch(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    fetch(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
     /**
      * This endpoint can be used to fetch the upcoming
      * [invoice](/core-concepts#invoice) for the current billing period given a
@@ -52,1096 +52,32 @@ export declare class Invoices extends APIResource {
      * sending emails, auto-collecting payment, syncing the invoice to external
      * providers, etc).
      */
-    issue(invoiceId: string, body?: InvoiceIssueParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
-    issue(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    issue(invoiceId: string, body?: InvoiceIssueParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
+    issue(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
     /**
      * This endpoint allows an invoice's status to be set the `paid` status. This can
      * only be done to invoices that are in the `issued` status.
      */
-    markPaid(invoiceId: string, body: InvoiceMarkPaidParams, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    markPaid(invoiceId: string, body: InvoiceMarkPaidParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
     /**
      * This endpoint collects payment for an invoice using the customer's default
      * payment method. This action can only be taken on invoices with status "issued".
      */
-    pay(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice>;
+    pay(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
     /**
      * This endpoint allows an invoice's status to be set 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
+     * 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<Invoice>;
-}
-export declare class InvoicesPage extends Page<Invoice> {
-}
-/**
- * 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 interface Invoice {
-    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: Invoice.AutoCollection;
-    billing_address: Invoice.BillingAddress | null;
-    /**
-     * The creation time of the resource in Orb.
-     */
-    created_at: string;
-    /**
-     * A list of credit notes associated with the invoice
-     */
-    credit_notes: Array<Invoice.CreditNote>;
-    /**
-     * An ISO 4217 currency string or `credits`
-     */
-    currency: string;
-    customer: Invoice.Customer;
-    customer_balance_transactions: Array<Invoice.CustomerBalanceTransaction>;
-    /**
-     * 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                                                                                             |
-     * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-     * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-     * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-     * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-     * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-     * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-     * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-     * | 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                                                                                     |
-     * | 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)                                                                            |
-     * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-     * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-     * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-     * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-     * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-     * | 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                                                                                     |
-     * | EU                   | `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              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-     * | 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                                                  |
-     * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-     * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-     * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-     * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-     * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-     * | Nigeria              | `ng_tin`     | Nigerian Tax Identification 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                                                                                     |
-     * | 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                                                                                        |
-     * | 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                                                                                     |
-     * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-     * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-     * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-     * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-     * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-     * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-     * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-     * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-     * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-     * | United States        | `us_ein`     | United States EIN                                                                                       |
-     * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-     * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-     * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-     */
-    customer_tax_id: Invoice.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<Shared.InvoiceLevelDiscount>;
-    /**
-     * 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;
-    /**
-     * The breakdown of prices in this invoice.
-     */
-    line_items: Array<Invoice.LineItem>;
-    maximum: Invoice.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: Record<string, string>;
-    minimum: Invoice.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<Invoice.PaymentAttempt>;
-    /**
-     * 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: Invoice.ShippingAddress | null;
-    status: 'issued' | 'paid' | 'synced' | 'void' | 'draft';
-    subscription: Invoice.Subscription | 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 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 declare namespace Invoice {
-    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;
-    }
-    interface BillingAddress {
-        city: string | null;
-        country: string | null;
-        line1: string | null;
-        line2: string | null;
-        postal_code: string | null;
-        state: string | null;
-    }
-    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;
-    }
-    interface Customer {
-        id: string;
-        external_customer_id: string | null;
-    }
-    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';
-        /**
-         * The value of the amount changed in the transaction.
-         */
-        amount: string;
-        /**
-         * The creation time of this transaction.
-         */
-        created_at: string;
-        credit_note: CustomerBalanceTransaction.CreditNote | 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: CustomerBalanceTransaction.Invoice | null;
-        /**
-         * The original value of the customer's balance prior to the transaction, in the
-         * customer's currency.
-         */
-        starting_balance: string;
-        type: 'increment' | 'decrement';
-    }
-    namespace CustomerBalanceTransaction {
-        interface CreditNote {
-            /**
-             * The id of the Credit note
-             */
-            id: string;
-        }
-        interface Invoice {
-            /**
-             * The Invoice id
-             */
-            id: string;
-        }
-    }
-    /**
-     * 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                                                                                             |
-     * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-     * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-     * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-     * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-     * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-     * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-     * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-     * | 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                                                                                     |
-     * | 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)                                                                            |
-     * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-     * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-     * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-     * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-     * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-     * | 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                                                                                     |
-     * | EU                   | `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              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-     * | 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                                                  |
-     * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-     * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-     * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-     * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-     * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-     * | Nigeria              | `ng_tin`     | Nigerian Tax Identification 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                                                                                     |
-     * | 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                                                                                        |
-     * | 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                                                                                     |
-     * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-     * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-     * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-     * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-     * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-     * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-     * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-     * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-     * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-     * | United States        | `us_ein`     | United States EIN                                                                                       |
-     * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-     * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-     * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-     */
-    interface CustomerTaxID {
-        country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'DO' | 'EC' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA';
-        type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
-        value: string;
-    }
-    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<LineItem.MonetaryUsageDiscountAdjustment | LineItem.MonetaryAmountDiscountAdjustment | LineItem.MonetaryPercentageDiscountAdjustment | LineItem.MonetaryMinimumAdjustment | LineItem.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;
-        discount: Shared.Discount | null;
-        /**
-         * 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;
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        maximum: LineItem.Maximum | null;
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        maximum_amount: string | null;
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        minimum: LineItem.Minimum | null;
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        minimum_amount: 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: PricesAPI.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<LineItem.MatrixSubLineItem | LineItem.TierSubLineItem | LineItem.OtherSubLineItem>;
-        /**
-         * The line amount before 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<LineItem.TaxAmount>;
-        /**
-         * A list of customer ids that were used to calculate the usage for this line item.
-         */
-        usage_customer_ids: Array<string> | null;
-    }
-    namespace LineItem {
-        interface MonetaryUsageDiscountAdjustment {
-            id: string;
-            adjustment_type: 'usage_discount';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-            /**
-             * The number of usage units by which to discount the price this adjustment applies
-             * to in a given billing period.
-             */
-            usage_discount: number;
-        }
-        namespace MonetaryUsageDiscountAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryAmountDiscountAdjustment {
-            id: string;
-            adjustment_type: 'amount_discount';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * The amount by which to discount the prices this adjustment applies to in a given
-             * billing period.
-             */
-            amount_discount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryAmountDiscountAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryPercentageDiscountAdjustment {
-            id: string;
-            adjustment_type: 'percentage_discount';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The percentage (as a value between 0 and 1) by which to discount the price
-             * intervals this adjustment applies to in a given billing period.
-             */
-            percentage_discount: number;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryPercentageDiscountAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryMinimumAdjustment {
-            id: string;
-            adjustment_type: 'minimum';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryMinimumAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The item ID that revenue from this minimum will be attributed to.
-             */
-            item_id: string;
-            /**
-             * The minimum amount to charge in a given billing period for the prices this
-             * adjustment applies to.
-             */
-            minimum_amount: string;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryMinimumAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryMaximumAdjustment {
-            id: string;
-            adjustment_type: 'maximum';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryMaximumAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The maximum amount to charge in a given billing period for the prices this
-             * adjustment applies to.
-             */
-            maximum_amount: string;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryMaximumAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        interface Maximum {
-            /**
-             * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
-             * phase maximums, this can be a subset of prices.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this maximum to.
-             */
-            filters: Array<Maximum.Filter>;
-            /**
-             * Maximum amount applied
-             */
-            maximum_amount: string;
-        }
-        namespace Maximum {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        interface Minimum {
-            /**
-             * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
-             * phase minimums, this can be a subset of prices.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this minimum to.
-             */
-            filters: Array<Minimum.Filter>;
-            /**
-             * Minimum amount applied
-             */
-            minimum_amount: string;
-        }
-        namespace Minimum {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MatrixSubLineItem {
-            /**
-             * The total amount for this sub line item.
-             */
-            amount: string;
-            grouping: MatrixSubLineItem.Grouping | null;
-            matrix_config: MatrixSubLineItem.MatrixConfig;
-            name: string;
-            quantity: number;
-            type: 'matrix';
-        }
-        namespace MatrixSubLineItem {
-            interface Grouping {
-                key: string;
-                /**
-                 * No value indicates the default group
-                 */
-                value: string | null;
-            }
-            interface MatrixConfig {
-                /**
-                 * The ordered dimension values for this line item.
-                 */
-                dimension_values: Array<string | null>;
-            }
-        }
-        interface TierSubLineItem {
-            /**
-             * The total amount for this sub line item.
-             */
-            amount: string;
-            grouping: TierSubLineItem.Grouping | null;
-            name: string;
-            quantity: number;
-            tier_config: TierSubLineItem.TierConfig;
-            type: 'tier';
-        }
-        namespace TierSubLineItem {
-            interface Grouping {
-                key: string;
-                /**
-                 * No value indicates the default group
-                 */
-                value: string | null;
-            }
-            interface TierConfig {
-                first_unit: number;
-                last_unit: number | null;
-                unit_amount: string;
-            }
-        }
-        interface OtherSubLineItem {
-            /**
-             * The total amount for this sub line item.
-             */
-            amount: string;
-            grouping: OtherSubLineItem.Grouping | null;
-            name: string;
-            quantity: number;
-            type: "'null'";
-        }
-        namespace OtherSubLineItem {
-            interface Grouping {
-                key: string;
-                /**
-                 * No value indicates the default group
-                 */
-                value: string | null;
-            }
-        }
-        interface TaxAmount {
-            /**
-             * The amount of additional tax incurred by this tax rate.
-             */
-            amount: string;
-            /**
-             * The human-readable description of the applied tax rate.
-             */
-            tax_rate_description: string;
-            /**
-             * The tax rate percentage, out of 100.
-             */
-            tax_rate_percentage: string | null;
-        }
-    }
-    interface Maximum {
-        /**
-         * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
-         * phase maximums, this can be a subset of prices.
-         */
-        applies_to_price_ids: Array<string>;
-        /**
-         * The filters that determine which prices to apply this maximum to.
-         */
-        filters: Array<Maximum.Filter>;
-        /**
-         * Maximum amount applied
-         */
-        maximum_amount: string;
-    }
-    namespace Maximum {
-        interface Filter {
-            /**
-             * The property of the price to filter on.
-             */
-            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-            /**
-             * Should prices that match the filter be included or excluded.
-             */
-            operator: 'includes' | 'excludes';
-            /**
-             * The IDs or values that match this filter.
-             */
-            values: Array<string>;
-        }
-    }
-    interface Minimum {
-        /**
-         * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
-         * phase minimums, this can be a subset of prices.
-         */
-        applies_to_price_ids: Array<string>;
-        /**
-         * The filters that determine which prices to apply this minimum to.
-         */
-        filters: Array<Minimum.Filter>;
-        /**
-         * Minimum amount applied
-         */
-        minimum_amount: string;
-    }
-    namespace Minimum {
-        interface Filter {
-            /**
-             * The property of the price to filter on.
-             */
-            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-            /**
-             * Should prices that match the filter be included or excluded.
-             */
-            operator: 'includes' | 'excludes';
-            /**
-             * The IDs or values that match this filter.
-             */
-            values: Array<string>;
-        }
-    }
-    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;
-        /**
-         * Whether the payment attempt succeeded.
-         */
-        succeeded: boolean;
-    }
-    interface ShippingAddress {
-        city: string | null;
-        country: string | null;
-        line1: string | null;
-        line2: string | null;
-        postal_code: string | null;
-        state: string | null;
-    }
-    interface Subscription {
-        id: string;
-    }
+    void(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Invoice>;
 }
 export interface InvoiceFetchUpcomingResponse {
     id: string;
@@ -1151,7 +87,7 @@ export interface InvoiceFetchUpcomingResponse {
      */
     amount_due: string;
     auto_collection: InvoiceFetchUpcomingResponse.AutoCollection;
-    billing_address: InvoiceFetchUpcomingResponse.BillingAddress | null;
+    billing_address: Shared.Address | null;
     /**
      * The creation time of the resource in Orb.
      */
@@ -1164,7 +100,7 @@ export interface InvoiceFetchUpcomingResponse {
      * An ISO 4217 currency string or `credits`
      */
     currency: string;
-    customer: InvoiceFetchUpcomingResponse.Customer;
+    customer: Shared.CustomerMinified;
     customer_balance_transactions: Array<InvoiceFetchUpcomingResponse.CustomerBalanceTransaction>;
     /**
      * Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -1273,7 +209,7 @@ export interface InvoiceFetchUpcomingResponse {
      * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
      * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
      */
-    customer_tax_id: InvoiceFetchUpcomingResponse.CustomerTaxID | null;
+    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
@@ -1322,7 +258,7 @@ export interface InvoiceFetchUpcomingResponse {
      * The breakdown of prices in this invoice.
      */
     line_items: Array<InvoiceFetchUpcomingResponse.LineItem>;
-    maximum: InvoiceFetchUpcomingResponse.Maximum | null;
+    maximum: Shared.Maximum | null;
     maximum_amount: string | null;
     /**
      * Free-form text which is available on the invoice PDF and the Orb invoice portal.
@@ -1334,8 +270,10 @@ export interface InvoiceFetchUpcomingResponse {
      * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
      * `null`.
      */
-    metadata: Record<string, string>;
-    minimum: InvoiceFetchUpcomingResponse.Minimum | 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
@@ -1362,9 +300,9 @@ export interface InvoiceFetchUpcomingResponse {
      * scheduled to be issued.
      */
     scheduled_issue_at: string | null;
-    shipping_address: InvoiceFetchUpcomingResponse.ShippingAddress | null;
+    shipping_address: Shared.Address | null;
     status: 'issued' | 'paid' | 'synced' | 'void' | 'draft';
-    subscription: InvoiceFetchUpcomingResponse.Subscription | null;
+    subscription: Shared.SubscriptionMinified | null;
     /**
      * The total before any discounts and minimums are applied.
      */
@@ -1420,14 +358,6 @@ export declare namespace InvoiceFetchUpcomingResponse {
          */
         previously_attempted_at: string | null;
     }
-    interface BillingAddress {
-        city: string | null;
-        country: string | null;
-        line1: string | null;
-        line2: string | null;
-        postal_code: string | null;
-        state: string | null;
-    }
     interface CreditNote {
         id: string;
         credit_note_number: string;
@@ -1444,10 +374,6 @@ export declare namespace InvoiceFetchUpcomingResponse {
          */
         voided_at: string | null;
     }
-    interface Customer {
-        id: string;
-        external_customer_id: string | null;
-    }
     interface CustomerBalanceTransaction {
         /**
          * A unique id for this transaction.
@@ -1462,7 +388,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * The creation time of this transaction.
          */
         created_at: string;
-        credit_note: CustomerBalanceTransaction.CreditNote | null;
+        credit_note: Shared.CreditNoteTiny | null;
         /**
          * An optional description provided for manual customer balance adjustments.
          */
@@ -1472,7 +398,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * customer's currency.
          */
         ending_balance: string;
-        invoice: CustomerBalanceTransaction.Invoice | null;
+        invoice: Shared.InvoiceTiny | null;
         /**
          * The original value of the customer's balance prior to the transaction, in the
          * customer's currency.
@@ -1480,132 +406,6 @@ export declare namespace InvoiceFetchUpcomingResponse {
         starting_balance: string;
         type: 'increment' | 'decrement';
     }
-    namespace CustomerBalanceTransaction {
-        interface CreditNote {
-            /**
-             * The id of the Credit note
-             */
-            id: string;
-        }
-        interface Invoice {
-            /**
-             * The Invoice id
-             */
-            id: string;
-        }
-    }
-    /**
-     * 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                                                                                             |
-     * | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
-     * | Andorra              | `ad_nrt`     | Andorran NRT Number                                                                                     |
-     * | Argentina            | `ar_cuit`    | Argentinian Tax ID Number                                                                               |
-     * | Australia            | `au_abn`     | Australian Business Number (AU ABN)                                                                     |
-     * | Australia            | `au_arn`     | Australian Taxation Office Reference Number                                                             |
-     * | Austria              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Bahrain              | `bh_vat`     | Bahraini VAT Number                                                                                     |
-     * | Belgium              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Bolivia              | `bo_tin`     | Bolivian Tax ID                                                                                         |
-     * | 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                                                                                     |
-     * | 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)                                                                            |
-     * | Chile                | `cl_tin`     | Chilean TIN                                                                                             |
-     * | China                | `cn_tin`     | Chinese Tax ID                                                                                          |
-     * | Colombia             | `co_nit`     | Colombian NIT Number                                                                                    |
-     * | Costa Rica           | `cr_tin`     | Costa Rican Tax ID                                                                                      |
-     * | Croatia              | `eu_vat`     | European VAT Number                                                                                     |
-     * | 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                                                                                     |
-     * | EU                   | `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              | `eu_vat`     | European VAT Number                                                                                     |
-     * | Greece               | `eu_vat`     | European VAT Number                                                                                     |
-     * | 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                                                  |
-     * | Latvia               | `eu_vat`     | European VAT Number                                                                                     |
-     * | Liechtenstein        | `li_uid`     | Liechtensteinian UID 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                                                                                     |
-     * | Mexico               | `mx_rfc`     | Mexican RFC Number                                                                                      |
-     * | Netherlands          | `eu_vat`     | European VAT Number                                                                                     |
-     * | New Zealand          | `nz_gst`     | New Zealand GST Number                                                                                  |
-     * | Nigeria              | `ng_tin`     | Nigerian Tax Identification 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                                                                                     |
-     * | 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                                                                                        |
-     * | 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                                                                                     |
-     * | Sweden               | `eu_vat`     | European VAT Number                                                                                     |
-     * | Switzerland          | `ch_vat`     | Switzerland VAT Number                                                                                  |
-     * | Taiwan               | `tw_vat`     | Taiwanese VAT                                                                                           |
-     * | Thailand             | `th_vat`     | Thai VAT                                                                                                |
-     * | Turkey               | `tr_tin`     | Turkish Tax Identification Number                                                                       |
-     * | Ukraine              | `ua_vat`     | Ukrainian VAT                                                                                           |
-     * | United Arab Emirates | `ae_trn`     | United Arab Emirates TRN                                                                                |
-     * | United Kingdom       | `eu_vat`     | Northern Ireland VAT Number                                                                             |
-     * | United Kingdom       | `gb_vat`     | United Kingdom VAT Number                                                                               |
-     * | United States        | `us_ein`     | United States EIN                                                                                       |
-     * | Uruguay              | `uy_ruc`     | Uruguayan RUC Number                                                                                    |
-     * | Venezuela            | `ve_rif`     | Venezuelan RIF Number                                                                                   |
-     * | Vietnam              | `vn_tin`     | Vietnamese Tax ID Number                                                                                |
-     */
-    interface CustomerTaxID {
-        country: 'AD' | 'AE' | 'AR' | 'AT' | 'AU' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'DO' | 'EC' | 'EG' | 'ES' | 'EU' | 'FI' | 'FR' | 'GB' | 'GE' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KR' | 'KZ' | 'LI' | 'LT' | 'LU' | 'LV' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA';
-        type: 'ad_nrt' | 'ae_trn' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'bg_uic' | 'bh_vat' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'eu_oss_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kr_brn' | 'kz_bin' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sv_nit' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'uy_ruc' | 've_rif' | 'vn_tin' | 'za_vat';
-        value: string;
-    }
     interface LineItem {
         /**
          * A unique ID for this line item.
@@ -1621,7 +421,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * invoice calculations (ie. usage discounts -> amount discounts -> percentage
          * discounts -> minimums -> maximums).
          */
-        adjustments: Array<LineItem.MonetaryUsageDiscountAdjustment | LineItem.MonetaryAmountDiscountAdjustment | LineItem.MonetaryPercentageDiscountAdjustment | LineItem.MonetaryMinimumAdjustment | LineItem.MonetaryMaximumAdjustment>;
+        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.
@@ -1631,6 +431,9 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * The number of prepaid credits applied.
          */
         credits_applied: string;
+        /**
+         * @deprecated This field is deprecated in favor of `adjustments`
+         */
         discount: Shared.Discount | null;
         /**
          * The end date of the range of time applied for this line item's price.
@@ -1649,7 +452,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
         /**
          * @deprecated This field is deprecated in favor of `adjustments`.
          */
-        maximum: LineItem.Maximum | null;
+        maximum: Shared.Maximum | null;
         /**
          * @deprecated This field is deprecated in favor of `adjustments`.
          */
@@ -1657,7 +460,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
         /**
          * @deprecated This field is deprecated in favor of `adjustments`.
          */
-        minimum: LineItem.Minimum | null;
+        minimum: Shared.Minimum | null;
         /**
          * @deprecated This field is deprecated in favor of `adjustments`.
          */
@@ -1682,7 +485,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * For more on the types of prices, see
          * [the core concepts documentation](/core-concepts#plan-and-price)
          */
-        price: PricesAPI.Price;
+        price: Shared.Price;
         /**
          * Either the fixed fee quantity or the usage during the service period.
          */
@@ -1695,7 +498,7 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * For complex pricing structures, the line item can be broken down further in
          * `sub_line_items`.
          */
-        sub_line_items: Array<LineItem.MatrixSubLineItem | LineItem.TierSubLineItem | LineItem.OtherSubLineItem>;
+        sub_line_items: Array<Shared.MatrixSubLineItem | Shared.TierSubLineItem | Shared.OtherSubLineItem>;
         /**
          * The line amount before before any adjustments.
          */
@@ -1704,462 +507,12 @@ export declare namespace InvoiceFetchUpcomingResponse {
          * An array of tax rates and their incurred tax amounts. Empty if no tax
          * integration is configured.
          */
-        tax_amounts: Array<LineItem.TaxAmount>;
+        tax_amounts: Array<Shared.TaxAmount>;
         /**
          * A list of customer ids that were used to calculate the usage for this line item.
          */
         usage_customer_ids: Array<string> | null;
     }
-    namespace LineItem {
-        interface MonetaryUsageDiscountAdjustment {
-            id: string;
-            adjustment_type: 'usage_discount';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-            /**
-             * The number of usage units by which to discount the price this adjustment applies
-             * to in a given billing period.
-             */
-            usage_discount: number;
-        }
-        namespace MonetaryUsageDiscountAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryAmountDiscountAdjustment {
-            id: string;
-            adjustment_type: 'amount_discount';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * The amount by which to discount the prices this adjustment applies to in a given
-             * billing period.
-             */
-            amount_discount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryAmountDiscountAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryPercentageDiscountAdjustment {
-            id: string;
-            adjustment_type: 'percentage_discount';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The percentage (as a value between 0 and 1) by which to discount the price
-             * intervals this adjustment applies to in a given billing period.
-             */
-            percentage_discount: number;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryPercentageDiscountAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryMinimumAdjustment {
-            id: string;
-            adjustment_type: 'minimum';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryMinimumAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The item ID that revenue from this minimum will be attributed to.
-             */
-            item_id: string;
-            /**
-             * The minimum amount to charge in a given billing period for the prices this
-             * adjustment applies to.
-             */
-            minimum_amount: string;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryMinimumAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MonetaryMaximumAdjustment {
-            id: string;
-            adjustment_type: 'maximum';
-            /**
-             * The value applied by an adjustment.
-             */
-            amount: string;
-            /**
-             * @deprecated The price IDs that this adjustment applies to.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this adjustment to.
-             */
-            filters: Array<MonetaryMaximumAdjustment.Filter>;
-            /**
-             * True for adjustments that apply to an entire invocice, false for adjustments
-             * that apply to only one price.
-             */
-            is_invoice_level: boolean;
-            /**
-             * The maximum amount to charge in a given billing period for the prices this
-             * adjustment applies to.
-             */
-            maximum_amount: string;
-            /**
-             * The reason for the adjustment.
-             */
-            reason: string | null;
-        }
-        namespace MonetaryMaximumAdjustment {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        interface Maximum {
-            /**
-             * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
-             * phase maximums, this can be a subset of prices.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this maximum to.
-             */
-            filters: Array<Maximum.Filter>;
-            /**
-             * Maximum amount applied
-             */
-            maximum_amount: string;
-        }
-        namespace Maximum {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        /**
-         * @deprecated This field is deprecated in favor of `adjustments`.
-         */
-        interface Minimum {
-            /**
-             * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
-             * phase minimums, this can be a subset of prices.
-             */
-            applies_to_price_ids: Array<string>;
-            /**
-             * The filters that determine which prices to apply this minimum to.
-             */
-            filters: Array<Minimum.Filter>;
-            /**
-             * Minimum amount applied
-             */
-            minimum_amount: string;
-        }
-        namespace Minimum {
-            interface Filter {
-                /**
-                 * The property of the price to filter on.
-                 */
-                field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-                /**
-                 * Should prices that match the filter be included or excluded.
-                 */
-                operator: 'includes' | 'excludes';
-                /**
-                 * The IDs or values that match this filter.
-                 */
-                values: Array<string>;
-            }
-        }
-        interface MatrixSubLineItem {
-            /**
-             * The total amount for this sub line item.
-             */
-            amount: string;
-            grouping: MatrixSubLineItem.Grouping | null;
-            matrix_config: MatrixSubLineItem.MatrixConfig;
-            name: string;
-            quantity: number;
-            type: 'matrix';
-        }
-        namespace MatrixSubLineItem {
-            interface Grouping {
-                key: string;
-                /**
-                 * No value indicates the default group
-                 */
-                value: string | null;
-            }
-            interface MatrixConfig {
-                /**
-                 * The ordered dimension values for this line item.
-                 */
-                dimension_values: Array<string | null>;
-            }
-        }
-        interface TierSubLineItem {
-            /**
-             * The total amount for this sub line item.
-             */
-            amount: string;
-            grouping: TierSubLineItem.Grouping | null;
-            name: string;
-            quantity: number;
-            tier_config: TierSubLineItem.TierConfig;
-            type: 'tier';
-        }
-        namespace TierSubLineItem {
-            interface Grouping {
-                key: string;
-                /**
-                 * No value indicates the default group
-                 */
-                value: string | null;
-            }
-            interface TierConfig {
-                first_unit: number;
-                last_unit: number | null;
-                unit_amount: string;
-            }
-        }
-        interface OtherSubLineItem {
-            /**
-             * The total amount for this sub line item.
-             */
-            amount: string;
-            grouping: OtherSubLineItem.Grouping | null;
-            name: string;
-            quantity: number;
-            type: "'null'";
-        }
-        namespace OtherSubLineItem {
-            interface Grouping {
-                key: string;
-                /**
-                 * No value indicates the default group
-                 */
-                value: string | null;
-            }
-        }
-        interface TaxAmount {
-            /**
-             * The amount of additional tax incurred by this tax rate.
-             */
-            amount: string;
-            /**
-             * The human-readable description of the applied tax rate.
-             */
-            tax_rate_description: string;
-            /**
-             * The tax rate percentage, out of 100.
-             */
-            tax_rate_percentage: string | null;
-        }
-    }
-    interface Maximum {
-        /**
-         * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
-         * phase maximums, this can be a subset of prices.
-         */
-        applies_to_price_ids: Array<string>;
-        /**
-         * The filters that determine which prices to apply this maximum to.
-         */
-        filters: Array<Maximum.Filter>;
-        /**
-         * Maximum amount applied
-         */
-        maximum_amount: string;
-    }
-    namespace Maximum {
-        interface Filter {
-            /**
-             * The property of the price to filter on.
-             */
-            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-            /**
-             * Should prices that match the filter be included or excluded.
-             */
-            operator: 'includes' | 'excludes';
-            /**
-             * The IDs or values that match this filter.
-             */
-            values: Array<string>;
-        }
-    }
-    interface Minimum {
-        /**
-         * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
-         * phase minimums, this can be a subset of prices.
-         */
-        applies_to_price_ids: Array<string>;
-        /**
-         * The filters that determine which prices to apply this minimum to.
-         */
-        filters: Array<Minimum.Filter>;
-        /**
-         * Minimum amount applied
-         */
-        minimum_amount: string;
-    }
-    namespace Minimum {
-        interface Filter {
-            /**
-             * The property of the price to filter on.
-             */
-            field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
-            /**
-             * Should prices that match the filter be included or excluded.
-             */
-            operator: 'includes' | 'excludes';
-            /**
-             * The IDs or values that match this filter.
-             */
-            values: Array<string>;
-        }
-    }
     interface PaymentAttempt {
         /**
          * The ID of the payment attempt.
@@ -2186,17 +539,6 @@ export declare namespace InvoiceFetchUpcomingResponse {
          */
         succeeded: boolean;
     }
-    interface ShippingAddress {
-        city: string | null;
-        country: string | null;
-        line1: string | null;
-        line2: string | null;
-        postal_code: string | null;
-        state: string | null;
-    }
-    interface Subscription {
-        id: string;
-    }
 }
 export interface InvoiceCreateParams {
     /**
@@ -2240,7 +582,9 @@ export interface InvoiceCreateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | 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
@@ -2268,15 +612,7 @@ export declare namespace InvoiceCreateParams {
          * A date string to specify the line item's start date in the customer's timezone.
          */
         start_date: string;
-        unit_config: LineItem.UnitConfig;
-    }
-    namespace LineItem {
-        interface UnitConfig {
-            /**
-             * Rate per unit of usage
-             */
-            unit_amount: string;
-        }
+        unit_config: Shared.UnitConfig;
     }
 }
 export interface InvoiceUpdateParams {
@@ -2285,7 +621,9 @@ export interface InvoiceUpdateParams {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface InvoiceListParams extends PageParams {
     amount?: string | null;
@@ -2340,6 +678,7 @@ export interface InvoiceMarkPaidParams {
     notes?: string | null;
 }
 export declare namespace Invoices {
-    export { type Invoice as Invoice, type InvoiceFetchUpcomingResponse as InvoiceFetchUpcomingResponse, InvoicesPage as InvoicesPage, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceUpdateParams as InvoiceUpdateParams, type InvoiceListParams as InvoiceListParams, type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams, type InvoiceIssueParams as InvoiceIssueParams, type InvoiceMarkPaidParams as InvoiceMarkPaidParams, };
+    export { type InvoiceFetchUpcomingResponse as InvoiceFetchUpcomingResponse, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceUpdateParams as InvoiceUpdateParams, type InvoiceListParams as InvoiceListParams, type InvoiceFetchUpcomingParams as InvoiceFetchUpcomingParams, type InvoiceIssueParams as InvoiceIssueParams, type InvoiceMarkPaidParams as InvoiceMarkPaidParams, };
 }
+export { InvoicesPage };
 //# sourceMappingURL=invoices.d.ts.map