@whop/sdk 0.0.35 → 0.0.37

package/resources/invoices.d.mts

@@ -1,4 +1,5 @@
 import { APIResource } from "../core/resource.mjs";
+import * as InvoicesAPI from "./invoices.mjs";
 import * as PaymentsAPI from "./payments.mjs";
 import * as Shared from "./shared.mjs";
 import { InvoiceListItemsCursorPage } from "./shared.mjs";
@@ -22,8 +23,6 @@ export declare class Invoices extends APIResource {
      * const invoice = await client.invoices.create({
      *   collection_method: 'send_invoice',
      *   company_id: 'biz_xxxxxxxxxxxxxx',
-     *   due_date: '2023-12-01T05:00:00.401Z',
-     *   member_id: 'mber_xxxxxxxxxxxxx',
      *   plan: {},
      *   product: { title: 'title' },
      * });
@@ -36,8 +35,30 @@ export declare class Invoices extends APIResource {
      * Required permissions:
      *
      * - `invoice:basic:read`
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.retrieve(
+     *   'inv_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Invoice>;
+    /**
+     * Update a draft invoice's details.
+     *
+     * Required permissions:
+     *
+     * - `invoice:update`
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.update(
+     *   'inv_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id: string, body?: InvoiceUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Invoice>;
     /**
      * Returns a paginated list of invoices for a company, with optional filtering by
      * product, status, collection method, and creation date.
@@ -45,8 +66,61 @@ export declare class Invoices extends APIResource {
      * Required permissions:
      *
      * - `invoice:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const invoiceListItem of client.invoices.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: InvoiceListParams | null | undefined, options?: RequestOptions): PagePromise<InvoiceListItemsCursorPage, Shared.InvoiceListItem>;
+    /**
+     * Delete a draft invoice.
+     *
+     * Required permissions:
+     *
+     * - `invoice:update`
+     *
+     * @example
+     * ```ts
+     * const invoice = await client.invoices.delete(
+     *   'inv_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<InvoiceDeleteResponse>;
+    /**
+     * Mark an open invoice as paid when payment was collected outside of Whop.
+     *
+     * Required permissions:
+     *
+     * - `invoice:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.invoices.markPaid(
+     *   'inv_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    markPaid(id: string, options?: RequestOptions): APIPromise<InvoiceMarkPaidResponse>;
+    /**
+     * Mark an open invoice as uncollectible when payment is not expected.
+     *
+     * Required permissions:
+     *
+     * - `invoice:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.invoices.markUncollectible(
+     *   'inv_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    markUncollectible(id: string, options?: RequestOptions): APIPromise<InvoiceMarkUncollectibleResponse>;
     /**
      * Void an open invoice so it can no longer be paid. Voiding is permanent and
      * cannot be undone.
@@ -54,16 +128,39 @@ export declare class Invoices extends APIResource {
      * Required permissions:
      *
      * - `invoice:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.invoices.void(
+     *   'inv_xxxxxxxxxxxxxx',
+     * );
+     * ```
      */
     void(id: string, options?: RequestOptions): APIPromise<InvoiceVoidResponse>;
 }
+/**
+ * The type of tax identifier
+ */
+export type TaxIdentifierType = 'ad_nrt' | 'ao_tin' | 'ar_cuit' | 'am_tin' | 'aw_tin' | 'au_abn' | 'au_arn' | 'eu_vat' | 'az_tin' | 'bs_tin' | 'bh_vat' | 'bd_bin' | 'bb_tin' | 'by_tin' | 'bj_ifu' | 'bo_tin' | 'ba_tin' | 'br_cnpj' | 'br_cpf' | 'bg_uic' | 'bf_ifu' | 'kh_tin' | 'cm_niu' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cv_nif' | 'cl_tin' | 'cn_tin' | 'co_nit' | 'cd_nif' | 'cr_tin' | 'hr_oib' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'sv_nit' | 'et_tin' | 'eu_oss_vat' | 'ge_vat' | 'de_stn' | 'gb_vat' | 'gn_nif' | 'hk_br' | 'hu_tin' | 'is_vat' | 'in_gst' | 'id_npwp' | 'il_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'kz_bin' | 'ke_pin' | 'kg_tin' | 'la_tin' | 'li_uid' | 'li_vat' | 'my_frp' | 'my_itn' | 'my_sst' | 'mr_nif' | 'mx_rfc' | 'md_vat' | 'me_pib' | 'ma_vat' | 'np_pan' | 'nz_gst' | 'ng_tin' | 'mk_vat' | 'no_vat' | 'no_voec' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'ro_tin' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sn_ninea' | 'rs_pib' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'za_vat' | 'kr_brn' | 'es_cif' | 'ch_uid' | 'ch_vat' | 'tw_vat' | 'tj_tin' | 'tz_vat' | 'th_vat' | 'tr_tin' | 'ug_tin' | 'ua_vat' | 'ae_trn' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'zm_tin' | 'zw_tin' | 'sr_fin' | 'xi_vat';
+/**
+ * Represents `true` or `false` values.
+ */
+export type InvoiceDeleteResponse = boolean;
+/**
+ * Represents `true` or `false` values.
+ */
+export type InvoiceMarkPaidResponse = boolean;
+/**
+ * Represents `true` or `false` values.
+ */
+export type InvoiceMarkUncollectibleResponse = boolean;
 /**
  * Represents `true` or `false` values.
  */
 export type InvoiceVoidResponse = boolean;
-export type InvoiceCreateParams = InvoiceCreateParams.CreateInvoiceInputWithProductAndMemberID | InvoiceCreateParams.CreateInvoiceInputWithProductAndEmailAddress | InvoiceCreateParams.CreateInvoiceInputWithProductIDAndMemberID | InvoiceCreateParams.CreateInvoiceInputWithProductIDAndEmailAddress;
+export type InvoiceCreateParams = InvoiceCreateParams.CreateInvoiceInputWithProduct | InvoiceCreateParams.CreateInvoiceInputWithProductID;
 export declare namespace InvoiceCreateParams {
-    interface CreateInvoiceInputWithProductAndMemberID {
+    interface CreateInvoiceInputWithProduct {
         /**
          * How the invoice should be collected. Use charge_automatically to charge a stored
          * payment method, or send_invoice to email the customer.
@@ -73,31 +170,27 @@ export declare namespace InvoiceCreateParams {
          * The unique identifier of the company to create this invoice for.
          */
         company_id: string;
-        /**
-         * The date by which the invoice must be paid.
-         */
-        due_date: string;
-        /**
-         * The unique identifier of an existing member to create this invoice for. If not
-         * provided, you must supply an email_address and customer_name.
-         */
-        member_id: string;
         /**
          * The plan attributes defining the price, currency, and billing interval for this
          * invoice.
          */
-        plan: CreateInvoiceInputWithProductAndMemberID.Plan;
+        plan: CreateInvoiceInputWithProduct.Plan;
         /**
          * The properties of the product to create for this invoice. Provide this to create
          * a new product inline.
          */
-        product: CreateInvoiceInputWithProductAndMemberID.Product;
+        product: CreateInvoiceInputWithProduct.Product;
         /**
          * The date and time when the invoice will be automatically finalized and charged.
          * Only valid when collection_method is charge_automatically. If not provided, the
          * charge will be processed immediately.
          */
         automatically_finalizes_at?: string | null;
+        /**
+         * Inline billing address to create a new mailing address for this invoice. Cannot
+         * be used together with mailing_address_id.
+         */
+        billing_address?: CreateInvoiceInputWithProduct.BillingAddress | null;
         /**
          * Whether to charge the customer a buyer fee on this invoice.
          */
@@ -107,6 +200,31 @@ export declare namespace InvoiceCreateParams {
          * is not yet a member of the company.
          */
         customer_name?: string | null;
+        /**
+         * The date by which the invoice must be paid. Required unless save_as_draft is
+         * true.
+         */
+        due_date?: string | null;
+        /**
+         * The email address of the customer. Required when creating an invoice for a
+         * customer who is not yet a member of the company.
+         */
+        email_address?: string | null;
+        /**
+         * Optional line items that break down the invoice total. When provided, the sum of
+         * (quantity \* unit_price) for all items must equal the plan price.
+         */
+        line_items?: Array<CreateInvoiceInputWithProduct.LineItem> | null;
+        /**
+         * The unique identifier of an existing mailing address to attach to this invoice.
+         * Cannot be used together with billing_address.
+         */
+        mailing_address_id?: string | null;
+        /**
+         * The unique identifier of an existing member to create this invoice for. If not
+         * provided, you must supply an email_address and customer_name.
+         */
+        member_id?: string | null;
         /**
          * The unique identifier of the payment method to charge. Required when
          * collection_method is charge_automatically.
@@ -117,8 +235,13 @@ export declare namespace InvoiceCreateParams {
          * must provide a payment_token.
          */
         payment_token_id?: string | null;
+        /**
+         * When true, creates the invoice as a draft without sending or charging. Relaxes
+         * customer and due date requirements.
+         */
+        save_as_draft?: boolean | null;
     }
-    namespace CreateInvoiceInputWithProductAndMemberID {
+    namespace CreateInvoiceInputWithProduct {
         /**
          * The plan attributes defining the price, currency, and billing interval for this
          * invoice.
@@ -257,203 +380,73 @@ export declare namespace InvoiceCreateParams {
              */
             product_tax_code_id?: string | null;
         }
-    }
-    interface CreateInvoiceInputWithProductAndEmailAddress {
-        /**
-         * How the invoice should be collected. Use charge_automatically to charge a stored
-         * payment method, or send_invoice to email the customer.
-         */
-        collection_method: Shared.CollectionMethod;
         /**
-         * The unique identifier of the company to create this invoice for.
+         * Inline billing address to create a new mailing address for this invoice. Cannot
+         * be used together with mailing_address_id.
          */
-        company_id: string;
-        /**
-         * The date by which the invoice must be paid.
-         */
-        due_date: string;
-        /**
-         * The email address of the customer. Required when creating an invoice for a
-         * customer who is not yet a member of the company.
-         */
-        email_address: string;
-        /**
-         * The plan attributes defining the price, currency, and billing interval for this
-         * invoice.
-         */
-        plan: CreateInvoiceInputWithProductAndEmailAddress.Plan;
-        /**
-         * The properties of the product to create for this invoice. Provide this to create
-         * a new product inline.
-         */
-        product: CreateInvoiceInputWithProductAndEmailAddress.Product;
-        /**
-         * The date and time when the invoice will be automatically finalized and charged.
-         * Only valid when collection_method is charge_automatically. If not provided, the
-         * charge will be processed immediately.
-         */
-        automatically_finalizes_at?: string | null;
-        /**
-         * Whether to charge the customer a buyer fee on this invoice.
-         */
-        charge_buyer_fee?: boolean | null;
-        /**
-         * The name of the customer. Required when creating an invoice for a customer who
-         * is not yet a member of the company.
-         */
-        customer_name?: string | null;
-        /**
-         * The unique identifier of the payment method to charge. Required when
-         * collection_method is charge_automatically.
-         */
-        payment_method_id?: string | null;
-        /**
-         * The payment token ID to use for this invoice. If using charge_automatically, you
-         * must provide a payment_token.
-         */
-        payment_token_id?: string | null;
-    }
-    namespace CreateInvoiceInputWithProductAndEmailAddress {
-        /**
-         * The plan attributes defining the price, currency, and billing interval for this
-         * invoice.
-         */
-        interface Plan {
+        interface BillingAddress {
             /**
-             * The interval in days at which the plan charges (renewal plans).
+             * The city of the address.
              */
-            billing_period?: number | null;
+            city?: string | null;
             /**
-             * An array of custom field objects.
+             * The country of the address.
              */
-            custom_fields?: Array<Plan.CustomField> | null;
+            country?: string | null;
             /**
-             * The description of the plan.
+             * The line 1 of the address.
              */
-            description?: string | null;
+            line1?: string | null;
             /**
-             * The number of days until the membership expires and revokes access (expiration
-             * plans). For example, 365 for a one-year access period.
+             * The line 2 of the address.
              */
-            expiration_days?: number | null;
+            line2?: string | null;
             /**
-             * An additional amount charged upon first purchase. Use only if a one time payment
-             * OR you want to charge an additional amount on top of the renewal price. Provided
-             * as a number in the specified currency. Eg: 10.43 for $10.43
+             * The name of the customer.
              */
-            initial_price?: number | null;
+            name?: string | null;
             /**
-             * A personal description or notes section for the business.
+             * The phone number of the customer.
              */
-            internal_notes?: string | null;
+            phone?: string | null;
             /**
-             * Whether this plan uses legacy payment method controls
+             * The postal code of the address.
              */
-            legacy_payment_method_controls?: boolean | null;
+            postal_code?: string | null;
             /**
-             * The explicit payment method configuration for the plan. If not provided, the
-             * platform or company's defaults will apply.
-             */
-            payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
-            /**
-             * The type of plan that can be attached to a product
-             */
-            plan_type?: Shared.PlanType | null;
-            /**
-             * The methods of how a plan can be released.
+             * The state of the address.
              */
-            release_method?: Shared.ReleaseMethod | null;
+            state?: string | null;
             /**
-             * The amount the customer is charged every billing period. Use only if a recurring
-             * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
+             * The type of tax identifier
              */
-            renewal_price?: number | null;
+            tax_id_type?: InvoicesAPI.TaxIdentifierType | null;
             /**
-             * The number of units available for purchase.
+             * The value of the tax identifier.
              */
-            stock?: number | null;
-            /**
-             * The number of free trial days added before a renewal plan.
-             */
-            trial_period_days?: number | null;
-            /**
-             * When true, the plan has unlimited stock (stock field is ignored). When false,
-             * purchases are limited by the stock field.
-             */
-            unlimited_stock?: boolean | null;
-            /**
-             * Visibility of a resource
-             */
-            visibility?: Shared.Visibility | null;
-        }
-        namespace Plan {
-            interface CustomField {
-                /**
-                 * The type of the custom field.
-                 */
-                field_type: 'text';
-                /**
-                 * The name of the custom field.
-                 */
-                name: string;
-                /**
-                 * The ID of the custom field (if being updated)
-                 */
-                id?: string | null;
-                /**
-                 * The order of the field.
-                 */
-                order?: number | null;
-                /**
-                 * The placeholder value of the field.
-                 */
-                placeholder?: string | null;
-                /**
-                 * Whether or not the field is required.
-                 */
-                required?: boolean | null;
-            }
-            /**
-             * The explicit payment method configuration for the plan. If not provided, the
-             * platform or company's defaults will apply.
-             */
-            interface PaymentMethodConfiguration {
-                /**
-                 * An array of payment method identifiers that are explicitly disabled. Only
-                 * applies if the include_platform_defaults is true.
-                 */
-                disabled: Array<PaymentsAPI.PaymentMethodTypes>;
-                /**
-                 * An array of payment method identifiers that are explicitly enabled. This means
-                 * these payment methods will be shown on checkout. Example use case is to only
-                 * enable a specific payment method like cashapp, or extending the platform
-                 * defaults with additional methods.
-                 */
-                enabled: Array<PaymentsAPI.PaymentMethodTypes>;
-                /**
-                 * Whether Whop's platform default payment method enablement settings are included
-                 * in this configuration. The full list of default payment methods can be found in
-                 * the documentation at docs.whop.com/payments.
-                 */
-                include_platform_defaults: boolean;
-            }
+            tax_id_value?: string | null;
         }
         /**
-         * The properties of the product to create for this invoice. Provide this to create
-         * a new product inline.
+         * A single line item to include on the invoice, with a label, quantity, and unit
+         * price.
          */
-        interface Product {
+        interface LineItem {
             /**
-             * The title of the product.
+             * The label or description for this line item.
              */
-            title: string;
+            label: string;
             /**
-             * The ID of the product tax code to apply to this product.
+             * The unit price for this line item. Provided as a number in the specified
+             * currency. Eg: 10.43 for $10.43
              */
-            product_tax_code_id?: string | null;
+            unit_price: number;
+            /**
+             * The quantity of this line item. Defaults to 1.
+             */
+            quantity?: number | null;
         }
     }
-    interface CreateInvoiceInputWithProductIDAndMemberID {
+    interface CreateInvoiceInputWithProductID {
         /**
          * How the invoice should be collected. Use charge_automatically to charge a stored
          * payment method, or send_invoice to email the customer.
@@ -463,20 +456,11 @@ export declare namespace InvoiceCreateParams {
          * The unique identifier of the company to create this invoice for.
          */
         company_id: string;
-        /**
-         * The date by which the invoice must be paid.
-         */
-        due_date: string;
-        /**
-         * The unique identifier of an existing member to create this invoice for. If not
-         * provided, you must supply an email_address and customer_name.
-         */
-        member_id: string;
         /**
          * The plan attributes defining the price, currency, and billing interval for this
          * invoice.
          */
-        plan: CreateInvoiceInputWithProductIDAndMemberID.Plan;
+        plan: CreateInvoiceInputWithProductID.Plan;
         /**
          * The unique identifier of an existing product to create this invoice for.
          */
@@ -487,6 +471,11 @@ export declare namespace InvoiceCreateParams {
          * charge will be processed immediately.
          */
         automatically_finalizes_at?: string | null;
+        /**
+         * Inline billing address to create a new mailing address for this invoice. Cannot
+         * be used together with mailing_address_id.
+         */
+        billing_address?: CreateInvoiceInputWithProductID.BillingAddress | null;
         /**
          * Whether to charge the customer a buyer fee on this invoice.
          */
@@ -496,6 +485,31 @@ export declare namespace InvoiceCreateParams {
          * is not yet a member of the company.
          */
         customer_name?: string | null;
+        /**
+         * The date by which the invoice must be paid. Required unless save_as_draft is
+         * true.
+         */
+        due_date?: string | null;
+        /**
+         * The email address of the customer. Required when creating an invoice for a
+         * customer who is not yet a member of the company.
+         */
+        email_address?: string | null;
+        /**
+         * Optional line items that break down the invoice total. When provided, the sum of
+         * (quantity \* unit_price) for all items must equal the plan price.
+         */
+        line_items?: Array<CreateInvoiceInputWithProductID.LineItem> | null;
+        /**
+         * The unique identifier of an existing mailing address to attach to this invoice.
+         * Cannot be used together with billing_address.
+         */
+        mailing_address_id?: string | null;
+        /**
+         * The unique identifier of an existing member to create this invoice for. If not
+         * provided, you must supply an email_address and customer_name.
+         */
+        member_id?: string | null;
         /**
          * The unique identifier of the payment method to charge. Required when
          * collection_method is charge_automatically.
@@ -506,8 +520,13 @@ export declare namespace InvoiceCreateParams {
          * must provide a payment_token.
          */
         payment_token_id?: string | null;
+        /**
+         * When true, creates the invoice as a draft without sending or charging. Relaxes
+         * customer and due date requirements.
+         */
+        save_as_draft?: boolean | null;
     }
-    namespace CreateInvoiceInputWithProductIDAndMemberID {
+    namespace CreateInvoiceInputWithProductID {
         /**
          * The plan attributes defining the price, currency, and billing interval for this
          * invoice.
@@ -632,185 +651,309 @@ export declare namespace InvoiceCreateParams {
                 include_platform_defaults: boolean;
             }
         }
+        /**
+         * Inline billing address to create a new mailing address for this invoice. Cannot
+         * be used together with mailing_address_id.
+         */
+        interface BillingAddress {
+            /**
+             * The city of the address.
+             */
+            city?: string | null;
+            /**
+             * The country of the address.
+             */
+            country?: string | null;
+            /**
+             * The line 1 of the address.
+             */
+            line1?: string | null;
+            /**
+             * The line 2 of the address.
+             */
+            line2?: string | null;
+            /**
+             * The name of the customer.
+             */
+            name?: string | null;
+            /**
+             * The phone number of the customer.
+             */
+            phone?: string | null;
+            /**
+             * The postal code of the address.
+             */
+            postal_code?: string | null;
+            /**
+             * The state of the address.
+             */
+            state?: string | null;
+            /**
+             * The type of tax identifier
+             */
+            tax_id_type?: InvoicesAPI.TaxIdentifierType | null;
+            /**
+             * The value of the tax identifier.
+             */
+            tax_id_value?: string | null;
+        }
+        /**
+         * A single line item to include on the invoice, with a label, quantity, and unit
+         * price.
+         */
+        interface LineItem {
+            /**
+             * The label or description for this line item.
+             */
+            label: string;
+            /**
+             * The unit price for this line item. Provided as a number in the specified
+             * currency. Eg: 10.43 for $10.43
+             */
+            unit_price: number;
+            /**
+             * The quantity of this line item. Defaults to 1.
+             */
+            quantity?: number | null;
+        }
     }
-    interface CreateInvoiceInputWithProductIDAndEmailAddress {
+}
+export interface InvoiceUpdateParams {
+    /**
+     * The date and time when the invoice will be automatically finalized and charged.
+     */
+    automatically_finalizes_at?: string | null;
+    /**
+     * Inline billing address to create or update a mailing address for this invoice.
+     */
+    billing_address?: InvoiceUpdateParams.BillingAddress | null;
+    /**
+     * Whether to charge the customer a buyer fee on this invoice.
+     */
+    charge_buyer_fee?: boolean | null;
+    /**
+     * The method of collection for an invoice.
+     */
+    collection_method?: Shared.CollectionMethod | null;
+    /**
+     * The name of the customer.
+     */
+    customer_name?: string | null;
+    /**
+     * The date by which the invoice must be paid.
+     */
+    due_date?: string | null;
+    /**
+     * The email address of the customer.
+     */
+    email_address?: string | null;
+    /**
+     * Line items that break down the invoice total.
+     */
+    line_items?: Array<InvoiceUpdateParams.LineItem> | null;
+    /**
+     * The unique identifier of an existing mailing address to attach.
+     */
+    mailing_address_id?: string | null;
+    /**
+     * The unique identifier of a member to assign as the customer.
+     */
+    member_id?: string | null;
+    /**
+     * The unique identifier of the payment method to charge.
+     */
+    payment_method_id?: string | null;
+    /**
+     * Updated plan attributes.
+     */
+    plan?: InvoiceUpdateParams.Plan | null;
+}
+export declare namespace InvoiceUpdateParams {
+    /**
+     * Inline billing address to create or update a mailing address for this invoice.
+     */
+    interface BillingAddress {
         /**
-         * How the invoice should be collected. Use charge_automatically to charge a stored
-         * payment method, or send_invoice to email the customer.
+         * The city of the address.
          */
-        collection_method: Shared.CollectionMethod;
+        city?: string | null;
         /**
-         * The unique identifier of the company to create this invoice for.
+         * The country of the address.
          */
-        company_id: string;
+        country?: string | null;
         /**
-         * The date by which the invoice must be paid.
+         * The line 1 of the address.
          */
-        due_date: string;
+        line1?: string | null;
         /**
-         * The email address of the customer. Required when creating an invoice for a
-         * customer who is not yet a member of the company.
+         * The line 2 of the address.
          */
-        email_address: string;
+        line2?: string | null;
         /**
-         * The plan attributes defining the price, currency, and billing interval for this
-         * invoice.
+         * The name of the customer.
          */
-        plan: CreateInvoiceInputWithProductIDAndEmailAddress.Plan;
+        name?: string | null;
         /**
-         * The unique identifier of an existing product to create this invoice for.
+         * The phone number of the customer.
          */
-        product_id: string;
+        phone?: string | null;
         /**
-         * The date and time when the invoice will be automatically finalized and charged.
-         * Only valid when collection_method is charge_automatically. If not provided, the
-         * charge will be processed immediately.
+         * The postal code of the address.
          */
-        automatically_finalizes_at?: string | null;
+        postal_code?: string | null;
         /**
-         * Whether to charge the customer a buyer fee on this invoice.
+         * The state of the address.
          */
-        charge_buyer_fee?: boolean | null;
+        state?: string | null;
         /**
-         * The name of the customer. Required when creating an invoice for a customer who
-         * is not yet a member of the company.
+         * The type of tax identifier
          */
-        customer_name?: string | null;
+        tax_id_type?: InvoicesAPI.TaxIdentifierType | null;
         /**
-         * The unique identifier of the payment method to charge. Required when
-         * collection_method is charge_automatically.
+         * The value of the tax identifier.
          */
-        payment_method_id?: string | null;
+        tax_id_value?: string | null;
+    }
+    /**
+     * A single line item to include on the invoice, with a label, quantity, and unit
+     * price.
+     */
+    interface LineItem {
         /**
-         * The payment token ID to use for this invoice. If using charge_automatically, you
-         * must provide a payment_token.
+         * The label or description for this line item.
          */
-        payment_token_id?: string | null;
+        label: string;
+        /**
+         * The unit price for this line item. Provided as a number in the specified
+         * currency. Eg: 10.43 for $10.43
+         */
+        unit_price: number;
+        /**
+         * The quantity of this line item. Defaults to 1.
+         */
+        quantity?: number | null;
     }
-    namespace CreateInvoiceInputWithProductIDAndEmailAddress {
+    /**
+     * Updated plan attributes.
+     */
+    interface Plan {
         /**
-         * The plan attributes defining the price, currency, and billing interval for this
-         * invoice.
+         * The interval in days at which the plan charges (renewal plans).
          */
-        interface Plan {
-            /**
-             * The interval in days at which the plan charges (renewal plans).
-             */
-            billing_period?: number | null;
-            /**
-             * An array of custom field objects.
-             */
-            custom_fields?: Array<Plan.CustomField> | null;
-            /**
-             * The description of the plan.
-             */
-            description?: string | null;
-            /**
-             * The number of days until the membership expires and revokes access (expiration
-             * plans). For example, 365 for a one-year access period.
-             */
-            expiration_days?: number | null;
-            /**
-             * An additional amount charged upon first purchase. Use only if a one time payment
-             * OR you want to charge an additional amount on top of the renewal price. Provided
-             * as a number in the specified currency. Eg: 10.43 for $10.43
-             */
-            initial_price?: number | null;
-            /**
-             * A personal description or notes section for the business.
-             */
-            internal_notes?: string | null;
+        billing_period?: number | null;
+        /**
+         * An array of custom field objects.
+         */
+        custom_fields?: Array<Plan.CustomField> | null;
+        /**
+         * The description of the plan.
+         */
+        description?: string | null;
+        /**
+         * The number of days until the membership expires and revokes access (expiration
+         * plans). For example, 365 for a one-year access period.
+         */
+        expiration_days?: number | null;
+        /**
+         * An additional amount charged upon first purchase. Use only if a one time payment
+         * OR you want to charge an additional amount on top of the renewal price. Provided
+         * as a number in the specified currency. Eg: 10.43 for $10.43
+         */
+        initial_price?: number | null;
+        /**
+         * A personal description or notes section for the business.
+         */
+        internal_notes?: string | null;
+        /**
+         * Whether this plan uses legacy payment method controls
+         */
+        legacy_payment_method_controls?: boolean | null;
+        /**
+         * The explicit payment method configuration for the plan. If not provided, the
+         * platform or company's defaults will apply.
+         */
+        payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
+        /**
+         * The type of plan that can be attached to a product
+         */
+        plan_type?: Shared.PlanType | null;
+        /**
+         * The methods of how a plan can be released.
+         */
+        release_method?: Shared.ReleaseMethod | null;
+        /**
+         * The amount the customer is charged every billing period. Use only if a recurring
+         * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
+         */
+        renewal_price?: number | null;
+        /**
+         * The number of units available for purchase.
+         */
+        stock?: number | null;
+        /**
+         * The number of free trial days added before a renewal plan.
+         */
+        trial_period_days?: number | null;
+        /**
+         * When true, the plan has unlimited stock (stock field is ignored). When false,
+         * purchases are limited by the stock field.
+         */
+        unlimited_stock?: boolean | null;
+        /**
+         * Visibility of a resource
+         */
+        visibility?: Shared.Visibility | null;
+    }
+    namespace Plan {
+        interface CustomField {
             /**
-             * Whether this plan uses legacy payment method controls
+             * The type of the custom field.
              */
-            legacy_payment_method_controls?: boolean | null;
+            field_type: 'text';
             /**
-             * The explicit payment method configuration for the plan. If not provided, the
-             * platform or company's defaults will apply.
+             * The name of the custom field.
              */
-            payment_method_configuration?: Plan.PaymentMethodConfiguration | null;
+            name: string;
             /**
-             * The type of plan that can be attached to a product
+             * The ID of the custom field (if being updated)
              */
-            plan_type?: Shared.PlanType | null;
+            id?: string | null;
             /**
-             * The methods of how a plan can be released.
+             * The order of the field.
              */
-            release_method?: Shared.ReleaseMethod | null;
+            order?: number | null;
             /**
-             * The amount the customer is charged every billing period. Use only if a recurring
-             * payment. Provided as a number in the specified currency. Eg: 10.43 for $10.43
+             * The placeholder value of the field.
              */
-            renewal_price?: number | null;
+            placeholder?: string | null;
             /**
-             * The number of units available for purchase.
+             * Whether or not the field is required.
              */
-            stock?: number | null;
-            /**
-             * The number of free trial days added before a renewal plan.
-             */
-            trial_period_days?: number | null;
+            required?: boolean | null;
+        }
+        /**
+         * The explicit payment method configuration for the plan. If not provided, the
+         * platform or company's defaults will apply.
+         */
+        interface PaymentMethodConfiguration {
             /**
-             * When true, the plan has unlimited stock (stock field is ignored). When false,
-             * purchases are limited by the stock field.
+             * An array of payment method identifiers that are explicitly disabled. Only
+             * applies if the include_platform_defaults is true.
              */
-            unlimited_stock?: boolean | null;
+            disabled: Array<PaymentsAPI.PaymentMethodTypes>;
             /**
-             * Visibility of a resource
+             * An array of payment method identifiers that are explicitly enabled. This means
+             * these payment methods will be shown on checkout. Example use case is to only
+             * enable a specific payment method like cashapp, or extending the platform
+             * defaults with additional methods.
              */
-            visibility?: Shared.Visibility | null;
-        }
-        namespace Plan {
-            interface CustomField {
-                /**
-                 * The type of the custom field.
-                 */
-                field_type: 'text';
-                /**
-                 * The name of the custom field.
-                 */
-                name: string;
-                /**
-                 * The ID of the custom field (if being updated)
-                 */
-                id?: string | null;
-                /**
-                 * The order of the field.
-                 */
-                order?: number | null;
-                /**
-                 * The placeholder value of the field.
-                 */
-                placeholder?: string | null;
-                /**
-                 * Whether or not the field is required.
-                 */
-                required?: boolean | null;
-            }
+            enabled: Array<PaymentsAPI.PaymentMethodTypes>;
             /**
-             * The explicit payment method configuration for the plan. If not provided, the
-             * platform or company's defaults will apply.
+             * Whether Whop's platform default payment method enablement settings are included
+             * in this configuration. The full list of default payment methods can be found in
+             * the documentation at docs.whop.com/payments.
              */
-            interface PaymentMethodConfiguration {
-                /**
-                 * An array of payment method identifiers that are explicitly disabled. Only
-                 * applies if the include_platform_defaults is true.
-                 */
-                disabled: Array<PaymentsAPI.PaymentMethodTypes>;
-                /**
-                 * An array of payment method identifiers that are explicitly enabled. This means
-                 * these payment methods will be shown on checkout. Example use case is to only
-                 * enable a specific payment method like cashapp, or extending the platform
-                 * defaults with additional methods.
-                 */
-                enabled: Array<PaymentsAPI.PaymentMethodTypes>;
-                /**
-                 * Whether Whop's platform default payment method enablement settings are included
-                 * in this configuration. The full list of default payment methods can be found in
-                 * the documentation at docs.whop.com/payments.
-                 */
-                include_platform_defaults: boolean;
-            }
+            include_platform_defaults: boolean;
         }
     }
 }
@@ -862,7 +1005,7 @@ export interface InvoiceListParams extends CursorPageParams {
     statuses?: Array<Shared.InvoiceStatus> | null;
 }
 export declare namespace Invoices {
-    export { type InvoiceVoidResponse as InvoiceVoidResponse, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceListParams as InvoiceListParams, };
+    export { type TaxIdentifierType as TaxIdentifierType, type InvoiceDeleteResponse as InvoiceDeleteResponse, type InvoiceMarkPaidResponse as InvoiceMarkPaidResponse, type InvoiceMarkUncollectibleResponse as InvoiceMarkUncollectibleResponse, type InvoiceVoidResponse as InvoiceVoidResponse, type InvoiceCreateParams as InvoiceCreateParams, type InvoiceUpdateParams as InvoiceUpdateParams, type InvoiceListParams as InvoiceListParams, };
 }
 export { type InvoiceListItemsCursorPage };
 //# sourceMappingURL=invoices.d.mts.map