stripe 17.7.0 → 18.0.0

package/types/ConfirmationTokens.d.ts

@@ -161,6 +161,8 @@ declare module 'stripe' {
 
         bancontact?: PaymentMethodPreview.Bancontact;
 
+        billie?: PaymentMethodPreview.Billie;
+
         billing_details: PaymentMethodPreview.BillingDetails;
 
         blik?: PaymentMethodPreview.Blik;
@@ -208,6 +210,8 @@ declare module 'stripe' {
 
         naver_pay?: PaymentMethodPreview.NaverPay;
 
+        nz_bank_account?: PaymentMethodPreview.NzBankAccount;
+
         oxxo?: PaymentMethodPreview.Oxxo;
 
         p24?: PaymentMethodPreview.P24;
@@ -228,6 +232,8 @@ declare module 'stripe' {
 
         samsung_pay?: PaymentMethodPreview.SamsungPay;
 
+        satispay?: PaymentMethodPreview.Satispay;
+
         sepa_debit?: PaymentMethodPreview.SepaDebit;
 
         sofort?: PaymentMethodPreview.Sofort;
@@ -324,6 +330,8 @@ declare module 'stripe' {
 
         interface Bancontact {}
 
+        interface Billie {}
+
         interface BillingDetails {
           /**
            * Billing address.
@@ -1281,6 +1289,11 @@ declare module 'stripe' {
         interface Multibanco {}
 
         interface NaverPay {
+          /**
+           * Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
+           */
+          buyer_id?: string | null;
+
           /**
            * Whether to fund this transaction with Naver Pay points or a card.
            */
@@ -1291,6 +1304,38 @@ declare module 'stripe' {
           type Funding = 'card' | 'points';
         }
 
+        interface NzBankAccount {
+          /**
+           * The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
+           */
+          account_holder_name: string | null;
+
+          /**
+           * The numeric code for the bank account's bank.
+           */
+          bank_code: string;
+
+          /**
+           * The name of the bank.
+           */
+          bank_name: string;
+
+          /**
+           * The numeric code for the bank account's bank branch.
+           */
+          branch_code: string;
+
+          /**
+           * Last four digits of the bank account number.
+           */
+          last4: string;
+
+          /**
+           * The suffix of the bank account number.
+           */
+          suffix: string | null;
+        }
+
         interface Oxxo {}
 
         interface P24 {
@@ -1362,6 +1407,8 @@ declare module 'stripe' {
 
         interface SamsungPay {}
 
+        interface Satispay {}
+
         interface SepaDebit {
           /**
            * Bank code of bank associated with the bank account.
@@ -1429,6 +1476,7 @@ declare module 'stripe' {
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
+          | 'billie'
           | 'blik'
           | 'boleto'
           | 'card'
@@ -1449,6 +1497,7 @@ declare module 'stripe' {
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'oxxo'
           | 'p24'
           | 'pay_by_bank'
@@ -1459,6 +1508,7 @@ declare module 'stripe' {
           | 'promptpay'
           | 'revolut_pay'
           | 'samsung_pay'
+          | 'satispay'
           | 'sepa_debit'
           | 'sofort'
           | 'swish'

package/types/CreditNoteLineItems.d.ts

@@ -21,11 +21,6 @@ declare module 'stripe' {
        */
       amount: number;
 
-      /**
-       * The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.
-       */
-      amount_excluding_tax: number | null;
-
       /**
        * Description of the item being credited.
        */
@@ -62,14 +57,14 @@ declare module 'stripe' {
       quantity: number | null;
 
       /**
-       * The amount of tax calculated per tax rate for this line item
+       * The tax rates which apply to the line item.
        */
-      tax_amounts: Array<CreditNoteLineItem.TaxAmount>;
+      tax_rates: Array<Stripe.TaxRate>;
 
       /**
-       * The tax rates which apply to the line item.
+       * The tax information of the line item.
        */
-      tax_rates: Array<Stripe.TaxRate>;
+      taxes: Array<CreditNoteLineItem.Tax> | null;
 
       /**
        * The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
@@ -85,11 +80,6 @@ declare module 'stripe' {
        * Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
        */
       unit_amount_decimal: string | null;
-
-      /**
-       * The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.
-       */
-      unit_amount_excluding_tax: string | null;
     }
 
     namespace CreditNoteLineItem {
@@ -133,36 +123,42 @@ declare module 'stripe' {
         type Type = 'credit_balance_transaction' | 'discount';
       }
 
-      interface TaxAmount {
+      interface Tax {
         /**
-         * 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: Tax.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: Tax.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: TaxAmount.TaxabilityReason | null;
+        taxability_reason: Tax.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 TaxAmount {
+      namespace Tax {
         type TaxabilityReason =
           | 'customer_exempt'
+          | 'not_available'
           | 'not_collecting'
           | 'not_subject_to_tax'
           | 'not_supported'
@@ -177,6 +173,12 @@ declare module 'stripe' {
           | 'standard_rated'
           | 'taxable_basis_reduced'
           | 'zero_rated';
+
+        type TaxBehavior = 'exclusive' | 'inclusive';
+
+        interface TaxRateDetails {
+          tax_rate: string;
+        }
       }
 
       type Type = 'custom_line_item' | 'invoice_line_item';

package/types/CreditNotes.d.ts

@@ -117,9 +117,9 @@ declare module 'stripe' {
       reason: CreditNote.Reason | null;
 
       /**
-       * Refund related to this credit note.
+       * Refunds related to this credit note.
        */
-      refund: string | Stripe.Refund | null;
+      refunds: Array<CreditNote.Refund>;
 
       /**
        * The details of the cost of shipping, including the ShippingRate applied to the invoice.
@@ -141,11 +141,6 @@ declare module 'stripe' {
        */
       subtotal_excluding_tax: number | null;
 
-      /**
-       * The aggregate amounts calculated per tax rate for all line items.
-       */
-      tax_amounts: Array<CreditNote.TaxAmount>;
-
       /**
        * The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
        */
@@ -156,6 +151,11 @@ declare module 'stripe' {
        */
       total_excluding_tax: number | null;
 
+      /**
+       * The aggregate tax information for all line items.
+       */
+      total_taxes: Array<CreditNote.TotalTax> | null;
+
       /**
        * Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.
        */
@@ -214,6 +214,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent).
+         */
+        amount_refunded: number;
+
+        /**
+         * ID of the refund.
+         */
+        refund: string | Stripe.Refund;
+      }
+
       interface ShippingCost {
         /**
          * Total shipping cost before any taxes are applied.
@@ -288,36 +300,42 @@ declare module 'stripe' {
 
       type Status = 'issued' | 'void';
 
-      interface TaxAmount {
+      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: TaxAmount.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 TaxAmount {
+      namespace TotalTax {
         type TaxabilityReason =
           | 'customer_exempt'
+          | 'not_available'
           | 'not_collecting'
           | 'not_subject_to_tax'
           | 'not_supported'
@@ -332,6 +350,12 @@ declare module 'stripe' {
           | 'standard_rated'
           | 'taxable_basis_reduced'
           | 'zero_rated';
+
+        type TaxBehavior = 'exclusive' | 'inclusive';
+
+        interface TaxRateDetails {
+          tax_rate: string;
+        }
       }
 
       type Type = 'post_payment' | 'pre_payment';

package/types/CreditNotesResource.d.ts

@@ -59,14 +59,14 @@ declare module 'stripe' {
       reason?: CreditNoteCreateParams.Reason;
 
       /**
-       * ID of an existing refund to link this credit note to.
+       * The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
        */
-      refund?: string;
+      refund_amount?: number;
 
       /**
-       * The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
+       * Refunds to link to this credit note.
        */
-      refund_amount?: number;
+      refunds?: Array<CreditNoteCreateParams.Refund>;
 
       /**
        * When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
@@ -151,6 +151,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+         */
+        amount_refunded?: number;
+
+        /**
+         * ID of an existing refund to link this credit note to.
+         */
+        refund?: string;
+      }
+
       interface ShippingCost {
         /**
          * The ID of the shipping rate to use for this order.
@@ -269,14 +281,14 @@ declare module 'stripe' {
       reason?: CreditNoteListPreviewLineItemsParams.Reason;
 
       /**
-       * ID of an existing refund to link this credit note to.
+       * The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
        */
-      refund?: string;
+      refund_amount?: number;
 
       /**
-       * The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
+       * Refunds to link to this credit note.
        */
-      refund_amount?: number;
+      refunds?: Array<CreditNoteListPreviewLineItemsParams.Refund>;
 
       /**
        * When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
@@ -361,6 +373,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+         */
+        amount_refunded?: number;
+
+        /**
+         * ID of an existing refund to link this credit note to.
+         */
+        refund?: string;
+      }
+
       interface ShippingCost {
         /**
          * The ID of the shipping rate to use for this order.
@@ -426,14 +450,14 @@ declare module 'stripe' {
       reason?: CreditNotePreviewParams.Reason;
 
       /**
-       * ID of an existing refund to link this credit note to.
+       * The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
        */
-      refund?: string;
+      refund_amount?: number;
 
       /**
-       * The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
+       * Refunds to link to this credit note.
        */
-      refund_amount?: number;
+      refunds?: Array<CreditNotePreviewParams.Refund>;
 
       /**
        * When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
@@ -518,6 +542,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+         */
+        amount_refunded?: number;
+
+        /**
+         * ID of an existing refund to link this credit note to.
+         */
+        refund?: string;
+      }
+
       interface ShippingCost {
         /**
          * The ID of the shipping rate to use for this order.

package/types/CustomerBalanceTransactions.d.ts

@@ -26,6 +26,11 @@ declare module 'stripe' {
        */
       amount: number;
 
+      /**
+       * The ID of the checkout session (if any) that created the transaction.
+       */
+      checkout_session: string | Stripe.Checkout.Session | null;
+
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
@@ -72,7 +77,7 @@ declare module 'stripe' {
       metadata: Stripe.Metadata | null;
 
       /**
-       * Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.
+       * Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.
        */
       type: CustomerBalanceTransaction.Type;
     }
@@ -81,6 +86,8 @@ declare module 'stripe' {
       type Type =
         | 'adjustment'
         | 'applied_to_invoice'
+        | 'checkout_session_subscription_payment'
+        | 'checkout_session_subscription_payment_canceled'
         | 'credit_note'
         | 'initial'
         | 'invoice_overpaid'

package/types/Customers.d.ts

@@ -240,7 +240,7 @@ declare module 'stripe' {
         ip_address: string | null;
 
         /**
-         * The customer's location as identified by Stripe Tax.
+         * The identified tax location of the customer.
          */
         location: Tax.Location | null;
       }
@@ -254,7 +254,7 @@ declare module 'stripe' {
 
         interface Location {
           /**
-           * The customer's country as identified by Stripe Tax.
+           * The identified tax country of the customer.
            */
           country: string;
 
@@ -264,7 +264,7 @@ declare module 'stripe' {
           source: Location.Source;
 
           /**
-           * The customer's state, county, province, or region as identified by Stripe Tax.
+           * The identified tax state, county, province, or region of the customer.
            */
           state: string | null;
         }

package/types/CustomersResource.d.ts

@@ -18,8 +18,6 @@ declare module 'stripe' {
        */
       cash_balance?: CustomerCreateParams.CashBalance;
 
-      coupon?: string;
-
       /**
        * An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
        */
@@ -72,11 +70,6 @@ declare module 'stripe' {
        */
       preferred_locales?: Array<string>;
 
-      /**
-       * The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
-       */
-      promotion_code?: string;
-
       /**
        * The customer's shipping information. Appears on invoices emailed to this customer.
        */
@@ -358,8 +351,6 @@ declare module 'stripe' {
        */
       cash_balance?: CustomerUpdateParams.CashBalance;
 
-      coupon?: string;
-
       /**
        * If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter.
        *
@@ -419,11 +410,6 @@ declare module 'stripe' {
        */
       preferred_locales?: Array<string>;
 
-      /**
-       * The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
-       */
-      promotion_code?: string;
-
       /**
        * The customer's shipping information. Appears on invoices emailed to this customer.
        */
@@ -864,6 +850,7 @@ declare module 'stripe' {
         | 'au_becs_debit'
         | 'bacs_debit'
         | 'bancontact'
+        | 'billie'
         | 'blik'
         | 'boleto'
         | 'card'
@@ -882,6 +869,7 @@ declare module 'stripe' {
         | 'mobilepay'
         | 'multibanco'
         | 'naver_pay'
+        | 'nz_bank_account'
         | 'oxxo'
         | 'p24'
         | 'pay_by_bank'
@@ -892,6 +880,7 @@ declare module 'stripe' {
         | 'promptpay'
         | 'revolut_pay'
         | 'samsung_pay'
+        | 'satispay'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'