stripe 17.8.0-beta.1 → 18.0.0

package/types/InvoicePaymentsResource.d.ts

@@ -0,0 +1,74 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface InvoicePaymentRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface InvoicePaymentListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * The identifier of the invoice whose payments to return.
+       */
+      invoice?: string;
+
+      /**
+       * The payment details of the invoice payments to return.
+       */
+      payment?: InvoicePaymentListParams.Payment;
+
+      /**
+       * The status of the invoice payments to return.
+       */
+      status?: InvoicePaymentListParams.Status;
+    }
+
+    namespace InvoicePaymentListParams {
+      interface Payment {
+        /**
+         * Only return invoice payments associated by this payment intent ID.
+         */
+        payment_intent?: string;
+
+        /**
+         * Only return invoice payments associated by this payment type.
+         */
+        type: 'payment_intent';
+      }
+
+      type Status = 'canceled' | 'open' | 'paid';
+    }
+
+    class InvoicePaymentsResource {
+      /**
+       * Retrieves the invoice payment with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: InvoicePaymentRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
+
+      /**
+       * When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+       */
+      list(
+        params?: InvoicePaymentListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.InvoicePayment>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.InvoicePayment>;
+    }
+  }
+}

package/types/Invoices.d.ts

@@ -60,7 +60,7 @@ declare module 'stripe' {
       /**
        * Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.
        */
-      id: string;
+      id?: string;
 
       /**
        * String representing the object's type. Objects of the same type share the same value.
@@ -90,9 +90,9 @@ declare module 'stripe' {
       amount_due: number;
 
       /**
-       * Amount that was overpaid on the invoice. Overpayments are debited to the customer's credit balance.
+       * Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
        */
-      amount_overpaid?: number;
+      amount_overpaid: number;
 
       /**
        * The amount, in cents (or local equivalent), that was paid.
@@ -109,11 +109,6 @@ declare module 'stripe' {
        */
       amount_shipping: number;
 
-      /**
-       * List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
-       */
-      amounts_due?: Array<Invoice.AmountsDue> | null;
-
       /**
        * ID of the Connect Application that created the invoice.
        */
@@ -123,11 +118,6 @@ declare module 'stripe' {
         | Stripe.DeletedApplication
         | null;
 
-      /**
-       * The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
-       */
-      application_fee_amount: number | null;
-
       /**
        * Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
        */
@@ -164,14 +154,14 @@ declare module 'stripe' {
       billing_reason: Invoice.BillingReason | null;
 
       /**
-       * ID of the latest charge generated for this invoice, if any.
+       * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
        */
-      charge: string | Stripe.Charge | null;
+      collection_method: Invoice.CollectionMethod;
 
       /**
-       * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
+       * The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
        */
-      collection_method: Invoice.CollectionMethod;
+      confirmation_secret?: Invoice.ConfirmationSecret | null;
 
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
@@ -228,11 +218,6 @@ declare module 'stripe' {
        */
       customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
 
-      /**
-       * The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
-       */
-      default_margins?: Array<string | Stripe.Margin> | null;
-
       /**
        * ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
        */
@@ -258,11 +243,6 @@ declare module 'stripe' {
        */
       description: string | null;
 
-      /**
-       * Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
-       */
-      discount: Stripe.Discount | null;
-
       /**
        * The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
        */
@@ -346,19 +326,9 @@ declare module 'stripe' {
       on_behalf_of: string | Stripe.Account | null;
 
       /**
-       * Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
-       */
-      paid: boolean;
-
-      /**
-       * Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
+       * The parent that generated this invoice
        */
-      paid_out_of_band: boolean;
-
-      /**
-       * The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
-       */
-      payment_intent: string | Stripe.PaymentIntent | null;
+      parent: Invoice.Parent | null;
 
       payment_settings: Invoice.PaymentSettings;
 
@@ -387,11 +357,6 @@ declare module 'stripe' {
        */
       pre_payment_credit_notes_amount: number;
 
-      /**
-       * The quote this invoice was generated from.
-       */
-      quote: string | Stripe.Quote | null;
-
       /**
        * This is the transaction number that appears on email receipts sent for this invoice.
        */
@@ -429,21 +394,6 @@ declare module 'stripe' {
 
       status_transitions: Invoice.StatusTransitions;
 
-      /**
-       * The subscription that this invoice was prepared for, if any.
-       */
-      subscription: string | Stripe.Subscription | null;
-
-      /**
-       * Details about the subscription that created this invoice.
-       */
-      subscription_details: Invoice.SubscriptionDetails | null;
-
-      /**
-       * Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
-       */
-      subscription_proration_date?: number;
-
       /**
        * Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
        */
@@ -454,11 +404,6 @@ declare module 'stripe' {
        */
       subtotal_excluding_tax: number | null;
 
-      /**
-       * The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
-       */
-      tax: number | null;
-
       /**
        * ID of the test clock this invoice belongs to.
        */
@@ -481,11 +426,6 @@ declare module 'stripe' {
        */
       total_excluding_tax: number | null;
 
-      /**
-       * The aggregate amounts calculated per margin across all line items.
-       */
-      total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
-
       /**
        * Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
        */
@@ -494,14 +434,9 @@ declare module 'stripe' {
       > | null;
 
       /**
-       * The aggregate amounts calculated per tax rate for all line items.
-       */
-      total_tax_amounts: Array<Invoice.TotalTaxAmount>;
-
-      /**
-       * The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
+       * The aggregate tax information of all line items.
        */
-      transfer_data: Invoice.TransferData | null;
+      total_taxes: Array<Invoice.TotalTax> | null;
 
       /**
        * Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
@@ -510,52 +445,6 @@ declare module 'stripe' {
     }
 
     namespace Invoice {
-      interface AmountsDue {
-        /**
-         * Incremental amount due for this payment in cents (or local equivalent).
-         */
-        amount: number;
-
-        /**
-         * The amount in cents (or local equivalent) that was paid for this payment.
-         */
-        amount_paid: number;
-
-        /**
-         * The difference between the payment's amount and amount_paid, in cents (or local equivalent).
-         */
-        amount_remaining: number;
-
-        /**
-         * Number of days from when invoice is finalized until the payment is due.
-         */
-        days_until_due: number | null;
-
-        /**
-         * An arbitrary string attached to the object. Often useful for displaying to users.
-         */
-        description: string | null;
-
-        /**
-         * Date on which a payment plan's payment is due.
-         */
-        due_date: number | null;
-
-        /**
-         * Timestamp when the payment was paid.
-         */
-        paid_at: number | null;
-
-        /**
-         * The status of the payment, one of `open`, `paid`, or `past_due`
-         */
-        status: AmountsDue.Status;
-      }
-
-      namespace AmountsDue {
-        type Status = 'open' | 'paid' | 'past_due';
-      }
-
       interface AutomaticTax {
         /**
          * If Stripe disabled automatic tax, this enum describes why.
@@ -615,6 +504,18 @@ declare module 'stripe' {
 
       type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
+      interface ConfirmationSecret {
+        /**
+         * The client_secret of the payment that Stripe creates for the invoice after finalization.
+         */
+        client_secret: string;
+
+        /**
+         * The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization
+         */
+        type: string;
+      }
+
       interface CustomerShipping {
         address?: Stripe.Address;
 
@@ -961,15 +862,12 @@ declare module 'stripe' {
           | 'email_invalid'
           | 'expired_card'
           | 'financial_connections_account_inactive'
-          | 'financial_connections_institution_unavailable'
           | 'financial_connections_no_successful_transaction_refresh'
           | 'forwarding_api_inactive'
           | 'forwarding_api_invalid_parameter'
+          | 'forwarding_api_retryable_upstream_error'
           | 'forwarding_api_upstream_connection_error'
           | 'forwarding_api_upstream_connection_timeout'
-          | 'gift_card_balance_insufficient'
-          | 'gift_card_code_exists'
-          | 'gift_card_inactive'
           | 'idempotency_key_in_use'
           | 'incorrect_address'
           | 'incorrect_cvc'
@@ -1059,12 +957,12 @@ declare module 'stripe' {
           | 'return_intent_already_processed'
           | 'routing_number_invalid'
           | 'secret_key_required'
-          | 'sensitive_data_access_expired'
           | 'sepa_unsupported_account'
           | 'setup_attempt_failed'
           | 'setup_intent_authentication_failure'
           | 'setup_intent_invalid_parameter'
           | 'setup_intent_mandate_invalid'
+          | 'setup_intent_mobile_wallet_unsupported'
           | 'setup_intent_setup_attempt_expired'
           | 'setup_intent_unexpected_state'
           | 'shipping_address_invalid'
@@ -1077,7 +975,6 @@ declare module 'stripe' {
           | 'taxes_calculation_failed'
           | 'terminal_location_country_unsupported'
           | 'terminal_reader_busy'
-          | 'terminal_reader_collected_data_invalid'
           | 'terminal_reader_hardware_fault'
           | 'terminal_reader_invalid_location_for_activation'
           | 'terminal_reader_invalid_location_for_payment'
@@ -1099,6 +996,52 @@ declare module 'stripe' {
           | 'invalid_request_error';
       }
 
+      interface Parent {
+        /**
+         * Details about the quote that generated this invoice
+         */
+        quote_details: Parent.QuoteDetails | null;
+
+        /**
+         * Details about the subscription that generated this invoice
+         */
+        subscription_details: Parent.SubscriptionDetails | null;
+
+        /**
+         * The type of parent that generated this invoice
+         */
+        type: Parent.Type;
+      }
+
+      namespace Parent {
+        interface QuoteDetails {
+          /**
+           * The quote that generated this invoice
+           */
+          quote: string;
+        }
+
+        interface SubscriptionDetails {
+          /**
+           * Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
+           *  *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
+           */
+          metadata: Stripe.Metadata | null;
+
+          /**
+           * The subscription that generated this invoice
+           */
+          subscription: string | Stripe.Subscription;
+
+          /**
+           * Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
+           */
+          subscription_proration_date?: number;
+        }
+
+        type Type = 'quote_details' | 'subscription_details';
+      }
+
       interface PaymentSettings {
         /**
          * ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
@@ -1138,11 +1081,6 @@ declare module 'stripe' {
            */
           customer_balance: PaymentMethodOptions.CustomerBalance | null;
 
-          /**
-           * If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
-           */
-          id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
-
           /**
            * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
            */
@@ -1248,8 +1186,6 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
@@ -1284,11 +1220,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * The institution to use to filter for possible accounts to link.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -1301,11 +1232,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1323,21 +1250,21 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
-          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
+          | 'klarna'
           | 'konbini'
           | 'kr_card'
           | 'link'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'p24'
           | 'payco'
           | 'paynow'
@@ -1507,37 +1434,6 @@ declare module 'stripe' {
         voided_at: number | null;
       }
 
-      interface SubscriptionDetails {
-        /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
-         *  *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
-         */
-        metadata: Stripe.Metadata | null;
-
-        /**
-         * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
-         */
-        pause_collection?: SubscriptionDetails.PauseCollection | null;
-      }
-
-      namespace SubscriptionDetails {
-        interface PauseCollection {
-          /**
-           * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-           */
-          behavior: PauseCollection.Behavior;
-
-          /**
-           * The time after which the subscription will resume collecting payments.
-           */
-          resumes_at: number | null;
-        }
-
-        namespace PauseCollection {
-          type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
-        }
-      }
-
       interface ThresholdReason {
         /**
          * The total invoice amount threshold boundary if it triggered the threshold invoice.
@@ -1576,18 +1472,6 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.DeletedDiscount;
       }
 
-      interface TotalMarginAmount {
-        /**
-         * The amount, in cents (or local equivalent), of the reduction in line item amount.
-         */
-        amount: number;
-
-        /**
-         * The margin that was applied to get this margin amount.
-         */
-        margin: string | Stripe.Margin;
-      }
-
       interface TotalPretaxCreditAmount {
         /**
          * The amount, in cents (or local equivalent), of the pretax credit amount.
@@ -1607,11 +1491,6 @@ declare module 'stripe' {
          */
         discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
 
-        /**
-         * The margin that was applied to get this pretax credit amount.
-         */
-        margin?: string | Stripe.Margin;
-
         /**
          * Type of the pretax credit amount referenced.
          */
@@ -1619,39 +1498,45 @@ declare module 'stripe' {
       }
 
       namespace TotalPretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
+        type Type = 'credit_balance_transaction' | 'discount';
       }
 
-      interface TotalTaxAmount {
+      interface TotalTax {
         /**
-         * The amount, in cents (or local equivalent), of the tax.
+         * The amount of the tax, in cents (or local equivalent).
          */
         amount: number;
 
         /**
-         * Whether this tax amount is inclusive or exclusive.
+         * Whether this tax is inclusive or exclusive.
          */
-        inclusive: boolean;
+        tax_behavior: TotalTax.TaxBehavior;
 
         /**
-         * The tax rate that was applied to get this tax amount.
+         * Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
          */
-        tax_rate: string | Stripe.TaxRate;
+        tax_rate_details: TotalTax.TaxRateDetails | null;
 
         /**
          * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
          */
-        taxability_reason: TotalTaxAmount.TaxabilityReason | null;
+        taxability_reason: TotalTax.TaxabilityReason;
 
         /**
          * The amount on which tax is calculated, in cents (or local equivalent).
          */
         taxable_amount: number | null;
+
+        /**
+         * The type of tax information.
+         */
+        type: 'tax_rate_details';
       }
 
-      namespace TotalTaxAmount {
+      namespace TotalTax {
         type TaxabilityReason =
           | 'customer_exempt'
+          | 'not_available'
           | 'not_collecting'
           | 'not_subject_to_tax'
           | 'not_supported'
@@ -1666,18 +1551,12 @@ declare module 'stripe' {
           | 'standard_rated'
           | 'taxable_basis_reduced'
           | 'zero_rated';
-      }
 
-      interface TransferData {
-        /**
-         * The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
-         */
-        amount: number | null;
+        type TaxBehavior = 'exclusive' | 'inclusive';
 
-        /**
-         * The account where funds from the payment will be transferred to upon payment success.
-         */
-        destination: string | Stripe.Account;
+        interface TaxRateDetails {
+          tax_rate: string;
+        }
       }
     }
   }