stripe 15.2.0 → 15.3.0

package/CHANGELOG.md

@@ -1,17 +1,28 @@
 # Changelog
 
+## 15.3.0 - 2024-04-18
+* [#2069](https://github.com/stripe/stripe-node/pull/2069) Update generated code
+  * Add support for `create_preview` method on resource `Invoice`
+  * Add support for `payment_method_data` on `Checkout.SessionCreateParams`
+  * Add support for `saved_payment_method_options` on `Checkout.SessionCreateParams` and `Checkout.Session`
+  * Add support for `mobilepay` on `Checkout.Session.payment_method_options` and `Checkout.SessionCreateParams.payment_method_options`
+  * Add support for new value `mobilepay` on enum `Checkout.SessionCreateParams.payment_method_types[]`
+  * Add support for `allow_redisplay` on `ConfirmationTokenCreateParams.testHelpers.payment_method_data`, `CustomerListPaymentMethodsParams`, `PaymentIntentConfirmParams.payment_method_data`, `PaymentIntentCreateParams.payment_method_data`, `PaymentIntentUpdateParams.payment_method_data`, `PaymentMethodCreateParams`, `PaymentMethodUpdateParams`, `SetupIntentConfirmParams.payment_method_data`, `SetupIntentCreateParams.payment_method_data`, and `SetupIntentUpdateParams.payment_method_data`
+  * Add support for `schedule_details` and `subscription_details` on `InvoiceUpcomingLinesParams` and `InvoiceUpcomingParams`
+  * Add support for new value `other` on enums `Issuing.AuthorizationCaptureParams.testHelpers.purchase_details.fuel.unit`, `Issuing.TransactionCreateForceCaptureParams.testHelpers.purchase_details.fuel.unit`, and `Issuing.TransactionCreateUnlinkedRefundParams.testHelpers.purchase_details.fuel.unit`
+
 ## 15.2.0 - 2024-04-16
 * [#2064](https://github.com/stripe/stripe-node/pull/2064) Update generated code
-  * Add support for new resource `Entitlements.ActiveEntitlementSummary`
-  * Add support for `balances` and `payouts_list` on `AccountSession.components` and `AccountSessionCreateParams.components`
-  * Change `AccountSession.components.payment_details.features.destination_on_behalf_of_charge_management` and `AccountSession.components.payments.features.destination_on_behalf_of_charge_management` to be required
-  * Change `Billing.MeterEventCreateParams.timestamp` and `Dispute.payment_method_details.card` to be optional
-  * Change type of `Dispute.payment_method_details.card` from `DisputePaymentMethodDetailsCard | null` to `DisputePaymentMethodDetailsCard`
-  * Add support for new value `entitlements.active_entitlement_summary.updated` on enum `Event.type`
-  * Remove support for `config` on `Forwarding.RequestCreateParams` and `Forwarding.Request`. This field is no longer used by the Forwarding Request API.
-  * Add support for `capture_method` on `PaymentIntent.payment_method_options.revolut_pay`, `PaymentIntentConfirmParams.payment_method_options.revolut_pay`, `PaymentIntentCreateParams.payment_method_options.revolut_pay`, and `PaymentIntentUpdateParams.payment_method_options.revolut_pay`
-  * Add support for `swish` on `PaymentMethodConfigurationCreateParams`, `PaymentMethodConfigurationUpdateParams`, and `PaymentMethodConfiguration`
-  * Add support for new value `entitlements.active_entitlement_summary.updated` on enums `WebhookEndpointCreateParams.enabled_events[]` and `WebhookEndpointUpdateParams.enabled_events[]`
+  * Add support for new resource `Entitlements.ActiveEntitlementSummary`
+  * Add support for `balances` and `payouts_list` on `AccountSession.components` and `AccountSessionCreateParams.components`
+  * Change `AccountSession.components.payment_details.features.destination_on_behalf_of_charge_management` and `AccountSession.components.payments.features.destination_on_behalf_of_charge_management` to be required
+  * Change `Billing.MeterEventCreateParams.timestamp` and `Dispute.payment_method_details.card` to be optional
+  * Change type of `Dispute.payment_method_details.card` from `DisputePaymentMethodDetailsCard | null` to `DisputePaymentMethodDetailsCard`
+  * Add support for new value `entitlements.active_entitlement_summary.updated` on enum `Event.type`
+  * Remove support for `config` on `Forwarding.RequestCreateParams` and `Forwarding.Request`. This field is no longer used by the Forwarding Request API.
+  * Add support for `capture_method` on `PaymentIntent.payment_method_options.revolut_pay`, `PaymentIntentConfirmParams.payment_method_options.revolut_pay`, `PaymentIntentCreateParams.payment_method_options.revolut_pay`, and `PaymentIntentUpdateParams.payment_method_options.revolut_pay`
+  * Add support for `swish` on `PaymentMethodConfigurationCreateParams`, `PaymentMethodConfigurationUpdateParams`, and `PaymentMethodConfiguration`
+  * Add support for new value `entitlements.active_entitlement_summary.updated` on enums `WebhookEndpointCreateParams.enabled_events[]` and `WebhookEndpointUpdateParams.enabled_events[]`
 
 ## 15.1.0 - 2024-04-11
 * [#2062](https://github.com/stripe/stripe-node/pull/2062) Update generated code

package/VERSION

@@ -1 +1 @@
-15.2.0
+15.3.0

package/cjs/resources/Invoices.js

@@ -14,6 +14,10 @@ exports.Invoices = StripeResource_js_1.StripeResource.extend({
         methodType: 'list',
     }),
     del: stripeMethod({ method: 'DELETE', fullPath: '/v1/invoices/{invoice}' }),
+    createPreview: stripeMethod({
+        method: 'POST',
+        fullPath: '/v1/invoices/create_preview',
+    }),
     finalizeInvoice: stripeMethod({
         method: 'POST',
         fullPath: '/v1/invoices/{invoice}/finalize',

package/cjs/stripe.core.js

@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '15.2.0';
+    Stripe.PACKAGE_VERSION = '15.3.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
     Stripe.StripeResource = StripeResource_js_1.StripeResource;
     Stripe.resources = resources;

package/esm/resources/Invoices.js

@@ -11,6 +11,10 @@ export const Invoices = StripeResource.extend({
         methodType: 'list',
     }),
     del: stripeMethod({ method: 'DELETE', fullPath: '/v1/invoices/{invoice}' }),
+    createPreview: stripeMethod({
+        method: 'POST',
+        fullPath: '/v1/invoices/create_preview',
+    }),
     finalizeInvoice: stripeMethod({
         method: 'POST',
         fullPath: '/v1/invoices/{invoice}/finalize',

package/esm/stripe.core.js

@@ -31,7 +31,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '15.2.0';
+    Stripe.PACKAGE_VERSION = '15.3.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
     Stripe.StripeResource = StripeResource;
     Stripe.resources = resources;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "15.2.0",
+  "version": "15.3.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/Billing/MeterEventSummaries.d.ts

@@ -19,12 +19,12 @@ declare module 'stripe' {
         object: 'billing.meter_event_summary';
 
         /**
-         * Aggregated value of all the events within start_time (inclusive) and end_time (inclusive). The aggregation strategy is defined on meter via `default_aggregation``.
+         * Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
          */
         aggregated_value: number;
 
         /**
-         * End timestamp for this usage summary (inclusive).
+         * End timestamp for this event summary (inclusive).
          */
         end_time: number;
 
@@ -34,12 +34,12 @@ declare module 'stripe' {
         livemode: boolean;
 
         /**
-         * The meter associated with this usage summary.
+         * The meter associated with this event summary.
          */
         meter: string;
 
         /**
-         * Start timestamp for this usage summary (inclusive).
+         * Start timestamp for this event summary (inclusive).
          */
         start_time: number;
       }

package/types/Billing/MeterEvents.d.ts

@@ -34,7 +34,7 @@ declare module 'stripe' {
         livemode: boolean;
 
         /**
-         * The payload of the event.
+         * The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
          */
         payload: {
           [key: string]: string;

package/types/Billing/MeterEventsResource.d.ts

@@ -10,7 +10,7 @@ declare module 'stripe' {
         event_name: string;
 
         /**
-         * The payload of the event. This must contain a field with the event's numerical value and a field to map the event to a customer.
+         * The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
          */
         payload: {
           [key: string]: string;
@@ -27,7 +27,7 @@ declare module 'stripe' {
         identifier?: string;
 
         /**
-         * The time of the event. Measured in seconds since the Unix epoch. Defaults to current timestamp if not specified.
+         * The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
          */
         timestamp?: number;
       }

package/types/Billing/Meters.d.ts

@@ -32,12 +32,12 @@ declare module 'stripe' {
         display_name: string;
 
         /**
-         * The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.
+         * The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
          */
         event_name: string;
 
         /**
-         * The time window to pre-aggregate usage events for, if any.
+         * The time window to pre-aggregate meter events for, if any.
          */
         event_time_window: Meter.EventTimeWindow | null;
 
@@ -64,7 +64,7 @@ declare module 'stripe' {
       namespace Meter {
         interface CustomerMapping {
           /**
-           * The key in the usage event payload to use for mapping the event to a customer.
+           * The key in the meter event payload to use for mapping the event to a customer.
            */
           event_payload_key: string;
 
@@ -98,7 +98,7 @@ declare module 'stripe' {
 
         interface ValueSettings {
           /**
-           * The key in the usage event payload to use as the value for this meter.
+           * The key in the meter event payload to use as the value for this meter.
            */
           event_payload_key: string;
         }

package/types/Billing/MetersResource.d.ts

@@ -15,7 +15,7 @@ declare module 'stripe' {
         display_name: string;
 
         /**
-         * The name of the usage event to record usage for. Corresponds with the `event_name` field on usage events.
+         * The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
          */
         event_name: string;
 
@@ -25,7 +25,7 @@ declare module 'stripe' {
         customer_mapping?: MeterCreateParams.CustomerMapping;
 
         /**
-         * The time window to pre-aggregate usage events for, if any.
+         * The time window to pre-aggregate meter events for, if any.
          */
         event_time_window?: MeterCreateParams.EventTimeWindow;
 
@@ -35,7 +35,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * Fields that specify how to calculate a usage event's value.
+         * Fields that specify how to calculate a meter event's value.
          */
         value_settings?: MeterCreateParams.ValueSettings;
       }
@@ -55,7 +55,7 @@ declare module 'stripe' {
 
         interface DefaultAggregation {
           /**
-           * Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value, or `last` to use the last event's value.
+           * Specifies how events are aggregated. Allowed values are `count` to count the number of events and `sum` to sum each event's value.
            */
           formula: DefaultAggregation.Formula;
         }
@@ -123,12 +123,12 @@ declare module 'stripe' {
         customer: string;
 
         /**
-         * The timestamp from when to stop aggregating usage events (exclusive).
+         * The timestamp from when to stop aggregating meter events (exclusive).
          */
         end_time: number;
 
         /**
-         * The timestamp from when to start aggregating usage events (inclusive).
+         * The timestamp from when to start aggregating meter events (inclusive).
          */
         start_time: number;
 

package/types/Checkout/Sessions.d.ts

@@ -228,6 +228,11 @@ declare module 'stripe' {
          */
         return_url?: string;
 
+        /**
+         * Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
+         */
+        saved_payment_method_options: Session.SavedPaymentMethodOptions | null;
+
         /**
          * The ID of the SetupIntent for Checkout Sessions in `setup` mode.
          */
@@ -912,6 +917,8 @@ declare module 'stripe' {
 
           link?: PaymentMethodOptions.Link;
 
+          mobilepay?: PaymentMethodOptions.Mobilepay;
+
           oxxo?: PaymentMethodOptions.Oxxo;
 
           p24?: PaymentMethodOptions.P24;
@@ -1312,6 +1319,17 @@ declare module 'stripe' {
             type SetupFutureUsage = 'none' | 'off_session';
           }
 
+          interface Mobilepay {
+            /**
+             * Indicates that you intend to make future payments with this PaymentIntent's payment method.
+             *
+             * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
+             *
+             * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
+             */
+            setup_future_usage?: 'none';
+          }
+
           interface Oxxo {
             /**
              * The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
@@ -1485,6 +1503,26 @@ declare module 'stripe' {
 
         type RedirectOnCompletion = 'always' | 'if_required' | 'never';
 
+        interface SavedPaymentMethodOptions {
+          /**
+           * Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method.
+           */
+          allow_redisplay_filters: Array<
+            SavedPaymentMethodOptions.AllowRedisplayFilter
+          > | null;
+
+          /**
+           * Enable customers to choose if they wish to save their payment method for future use.
+           */
+          payment_method_save: SavedPaymentMethodOptions.PaymentMethodSave | null;
+        }
+
+        namespace SavedPaymentMethodOptions {
+          type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
+
+          type PaymentMethodSave = 'disabled' | 'enabled';
+        }
+
         interface ShippingAddressCollection {
           /**
            * An array of two-letter ISO country codes representing which countries Checkout should provide as options for

package/types/Checkout/SessionsResource.d.ts

@@ -162,6 +162,11 @@ declare module 'stripe' {
          */
         payment_method_configuration?: string;
 
+        /**
+         * This parameter allows you to set some attributes on the payment method created during a Checkout session.
+         */
+        payment_method_data?: SessionCreateParams.PaymentMethodData;
+
         /**
          * Payment-method-specific configuration.
          */
@@ -202,6 +207,11 @@ declare module 'stripe' {
          */
         return_url?: string;
 
+        /**
+         * Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
+         */
+        saved_payment_method_options?: SessionCreateParams.SavedPaymentMethodOptions;
+
         /**
          * A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
          */
@@ -947,6 +957,17 @@ declare module 'stripe' {
 
         type PaymentMethodCollection = 'always' | 'if_required';
 
+        interface PaymentMethodData {
+          /**
+           * Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
+           */
+          allow_redisplay?: PaymentMethodData.AllowRedisplay;
+        }
+
+        namespace PaymentMethodData {
+          type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+        }
+
         interface PaymentMethodOptions {
           /**
            * contains details about the ACSS Debit payment method options.
@@ -1048,6 +1069,11 @@ declare module 'stripe' {
            */
           link?: PaymentMethodOptions.Link;
 
+          /**
+           * contains details about the Mobilepay payment method options.
+           */
+          mobilepay?: PaymentMethodOptions.Mobilepay;
+
           /**
            * contains details about the OXXO payment method options.
            */
@@ -1507,6 +1533,17 @@ declare module 'stripe' {
             type SetupFutureUsage = 'none' | 'off_session';
           }
 
+          interface Mobilepay {
+            /**
+             * Indicates that you intend to make future payments with this PaymentIntent's payment method.
+             *
+             * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
+             *
+             * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
+             */
+            setup_future_usage?: 'none';
+          }
+
           interface Oxxo {
             /**
              * The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
@@ -1762,6 +1799,7 @@ declare module 'stripe' {
           | 'klarna'
           | 'konbini'
           | 'link'
+          | 'mobilepay'
           | 'oxxo'
           | 'p24'
           | 'paynow'
@@ -1785,6 +1823,26 @@ declare module 'stripe' {
 
         type RedirectOnCompletion = 'always' | 'if_required' | 'never';
 
+        interface SavedPaymentMethodOptions {
+          /**
+           * Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method.
+           */
+          allow_redisplay_filters?: Array<
+            SavedPaymentMethodOptions.AllowRedisplayFilter
+          >;
+
+          /**
+           * Enable customers to choose if they wish to save their payment method for future use.
+           */
+          payment_method_save?: SavedPaymentMethodOptions.PaymentMethodSave;
+        }
+
+        namespace SavedPaymentMethodOptions {
+          type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
+
+          type PaymentMethodSave = 'disabled' | 'enabled';
+        }
+
         interface SetupIntentData {
           /**
            * An arbitrary string attached to the object. Often useful for displaying to users.

package/types/CustomersResource.d.ts

@@ -767,6 +767,11 @@ declare module 'stripe' {
     }
 
     interface CustomerListPaymentMethodsParams extends PaginationParams {
+      /**
+       * This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
+       */
+      allow_redisplay?: CustomerListPaymentMethodsParams.AllowRedisplay;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -779,6 +784,8 @@ declare module 'stripe' {
     }
 
     namespace CustomerListPaymentMethodsParams {
+      type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
       type Type =
         | 'acss_debit'
         | 'affirm'