stripe 19.3.0-beta.1 → 19.4.0-alpha.1

package/types/Billing/CreditBalanceTransactions.d.ts

@@ -75,6 +75,11 @@ declare module 'stripe' {
 
         namespace Credit {
           interface Amount {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Amount.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -83,10 +88,61 @@ declare module 'stripe' {
             /**
              * The type of this amount. We currently only support `monetary` billing credits.
              */
-            type: 'monetary';
+            type: Amount.Type;
           }
 
           namespace Amount {
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: string;
+            }
+
+            namespace CustomPricingUnit {
+              interface CustomPricingUnitDetails {
+                /**
+                 * Time at which the object was created. Measured in seconds since the Unix epoch.
+                 */
+                created: number;
+
+                /**
+                 * The name of the custom pricing unit.
+                 */
+                display_name: string;
+
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * A lookup key for the custom pricing unit.
+                 */
+                lookup_key: string | null;
+
+                /**
+                 * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+                 */
+                metadata: Stripe.Metadata;
+
+                /**
+                 * The status of the custom pricing unit.
+                 */
+                status: string;
+              }
+            }
+
             interface Monetary {
               /**
                * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -98,6 +154,8 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
 
           interface CreditsApplicationInvoiceVoided {
@@ -131,6 +189,11 @@ declare module 'stripe' {
 
         namespace Debit {
           interface Amount {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Amount.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -139,10 +202,61 @@ declare module 'stripe' {
             /**
              * The type of this amount. We currently only support `monetary` billing credits.
              */
-            type: 'monetary';
+            type: Amount.Type;
           }
 
           namespace Amount {
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: string;
+            }
+
+            namespace CustomPricingUnit {
+              interface CustomPricingUnitDetails {
+                /**
+                 * Time at which the object was created. Measured in seconds since the Unix epoch.
+                 */
+                created: number;
+
+                /**
+                 * The name of the custom pricing unit.
+                 */
+                display_name: string;
+
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * A lookup key for the custom pricing unit.
+                 */
+                lookup_key: string | null;
+
+                /**
+                 * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+                 */
+                metadata: Stripe.Metadata;
+
+                /**
+                 * The status of the custom pricing unit.
+                 */
+                status: string;
+              }
+            }
+
             interface Monetary {
               /**
                * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -154,6 +268,8 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
 
           interface CreditsApplied {

package/types/Billing/CreditGrants.d.ts

@@ -91,6 +91,11 @@ declare module 'stripe' {
 
       namespace CreditGrant {
         interface Amount {
+          /**
+           * The custom pricing unit amount.
+           */
+          custom_pricing_unit?: Amount.CustomPricingUnit | null;
+
           /**
            * The monetary amount.
            */
@@ -99,10 +104,61 @@ declare module 'stripe' {
           /**
            * The type of this amount. We currently only support `monetary` billing credits.
            */
-          type: 'monetary';
+          type: Amount.Type;
         }
 
         namespace Amount {
+          interface CustomPricingUnit {
+            /**
+             * The custom pricing unit object.
+             */
+            custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+            /**
+             * Unique identifier for the object.
+             */
+            id: string;
+
+            /**
+             * A positive integer representing the amount.
+             */
+            value: string;
+          }
+
+          namespace CustomPricingUnit {
+            interface CustomPricingUnitDetails {
+              /**
+               * Time at which the object was created. Measured in seconds since the Unix epoch.
+               */
+              created: number;
+
+              /**
+               * The name of the custom pricing unit.
+               */
+              display_name: string;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A lookup key for the custom pricing unit.
+               */
+              lookup_key: string | null;
+
+              /**
+               * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+               */
+              metadata: Stripe.Metadata;
+
+              /**
+               * The status of the custom pricing unit.
+               */
+              status: string;
+            }
+          }
+
           interface Monetary {
             /**
              * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -114,6 +170,8 @@ declare module 'stripe' {
              */
             value: number;
           }
+
+          type Type = 'custom_pricing_unit' | 'monetary';
         }
 
         interface ApplicabilityConfig {
@@ -122,6 +180,11 @@ declare module 'stripe' {
 
         namespace ApplicabilityConfig {
           interface Scope {
+            /**
+             * The billable items that credit grants can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+             */
+            billable_items?: Array<Scope.BillableItem>;
+
             /**
              * The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.
              */
@@ -134,6 +197,13 @@ declare module 'stripe' {
           }
 
           namespace Scope {
+            interface BillableItem {
+              /**
+               * Unique identifier for the object.
+               */
+              id: string | null;
+            }
+
             interface Price {
               /**
                * Unique identifier for the object.

package/types/Billing/CreditGrantsResource.d.ts

@@ -62,6 +62,11 @@ declare module 'stripe' {
 
       namespace CreditGrantCreateParams {
         interface Amount {
+          /**
+           * The custom pricing unit amount.
+           */
+          custom_pricing_unit?: Amount.CustomPricingUnit;
+
           /**
            * The monetary amount.
            */
@@ -70,10 +75,22 @@ declare module 'stripe' {
           /**
            * The type of this amount. We currently only support `monetary` billing credits.
            */
-          type: 'monetary';
+          type: Amount.Type;
         }
 
         namespace Amount {
+          interface CustomPricingUnit {
+            /**
+             * The ID of the custom pricing unit.
+             */
+            id: string;
+
+            /**
+             * A positive integer representing the amount of the credit grant.
+             */
+            value: string;
+          }
+
           interface Monetary {
             /**
              * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
@@ -85,6 +102,8 @@ declare module 'stripe' {
              */
             value: number;
           }
+
+          type Type = 'custom_pricing_unit' | 'monetary';
         }
 
         interface ApplicabilityConfig {
@@ -96,6 +115,11 @@ declare module 'stripe' {
 
         namespace ApplicabilityConfig {
           interface Scope {
+            /**
+             * A list of billable items that the credit grant can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+             */
+            billable_items?: Array<Scope.BillableItem>;
+
             /**
              * The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
              */
@@ -108,6 +132,13 @@ declare module 'stripe' {
           }
 
           namespace Scope {
+            interface BillableItem {
+              /**
+               * The billable item ID this credit grant should apply to.
+               */
+              id: string;
+            }
+
             interface Price {
               /**
                * The price ID this credit grant should apply to.

package/types/Billing/MeterEventSummaries.d.ts

@@ -25,6 +25,13 @@ declare module 'stripe' {
          */
         aggregated_value: number;
 
+        /**
+         * Key-value pairs of dimension values for event summaries with grouping on dimensions.
+         */
+        dimensions?: {
+          [key: string]: string;
+        } | null;
+
         /**
          * End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
          */

package/types/Billing/Meters.d.ts

@@ -28,6 +28,11 @@ declare module 'stripe' {
 
         default_aggregation: Meter.DefaultAggregation;
 
+        /**
+         * Set of keys that will be used to group meter events by.
+         */
+        dimension_payload_keys?: Array<string> | null;
+
         /**
          * The meter's name.
          */

package/types/Billing/MetersResource.d.ts

@@ -24,6 +24,11 @@ declare module 'stripe' {
          */
         customer_mapping?: MeterCreateParams.CustomerMapping;
 
+        /**
+         * Set of keys that will be used to group meter events by. Each key must be present in the event payload.
+         */
+        dimension_payload_keys?: Array<string>;
+
         /**
          * The time window which meter events have been pre-aggregated for, if any.
          */
@@ -132,6 +137,18 @@ declare module 'stripe' {
          */
         start_time: number;
 
+        /**
+         * Key-value pairs used to filter meter events by dimension values. If specified, event summaries will be generated with only matching meter events.
+         */
+        dimension_filters?: {
+          [key: string]: string;
+        };
+
+        /**
+         * List of dimension payload keys to group by. If specified, event summaries will be grouped by the given dimension payload key values.
+         */
+        dimension_group_by_keys?: Array<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */

package/types/Cards.d.ts

@@ -72,6 +72,8 @@ declare module 'stripe' {
        */
       available_payout_methods?: Array<Card.AvailablePayoutMethod> | null;
 
+      benefits?: Card.Benefits;
+
       /**
        * Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
        */
@@ -192,6 +194,18 @@ declare module 'stripe' {
 
       type AvailablePayoutMethod = 'instant' | 'standard';
 
+      interface Benefits {
+        /**
+         * Issuer of this benefit card
+         */
+        issuer: string | null;
+
+        /**
+         * Available benefit programs for this card
+         */
+        programs: Array<string> | null;
+      }
+
       interface Networks {
         /**
          * The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.

package/types/Charges.d.ts

@@ -18,6 +18,11 @@ declare module 'stripe' {
        */
       object: 'charge';
 
+      /**
+       * Funds that are in transit and destined for another balance or another connected account.
+       */
+      allocated_funds?: Stripe.TransitBalance;
+
       /**
        * Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
        */
@@ -868,6 +873,8 @@ declare module 'stripe' {
            */
           authorization_code: string | null;
 
+          benefits?: Card.Benefits;
+
           /**
            * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
            */
@@ -991,6 +998,13 @@ declare module 'stripe' {
         }
 
         namespace Card {
+          interface Benefits {
+            /**
+             * Issuer of the benefit card utilized on this payment
+             */
+            issuer: string | null;
+          }
+
           interface Checks {
             /**
              * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.

package/types/ChargesResource.d.ts

@@ -228,9 +228,7 @@ declare module 'stripe' {
         car_rental?: PaymentDetails.CarRental;
 
         /**
-         * A unique value to identify the customer. This field is available only for card payments.
-         *
-         * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
          */
         customer_reference?: Stripe.Emptyable<string>;
 
@@ -250,11 +248,7 @@ declare module 'stripe' {
         lodging?: PaymentDetails.Lodging;
 
         /**
-         * A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
-         *
-         * Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
-         *
-         * For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
+         * A unique value assigned by the business to identify the transaction.
          */
         order_reference?: Stripe.Emptyable<string>;
 
@@ -1042,9 +1036,7 @@ declare module 'stripe' {
         car_rental?: PaymentDetails.CarRental;
 
         /**
-         * A unique value to identify the customer. This field is available only for card payments.
-         *
-         * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
          */
         customer_reference?: Stripe.Emptyable<string>;
 
@@ -1064,11 +1056,7 @@ declare module 'stripe' {
         lodging?: PaymentDetails.Lodging;
 
         /**
-         * A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
-         *
-         * Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
-         *
-         * For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
+         * A unique value assigned by the business to identify the transaction.
          */
         order_reference?: Stripe.Emptyable<string>;
 

package/types/Checkout/Sessions.d.ts

@@ -69,6 +69,8 @@ declare module 'stripe' {
          */
         cancel_url: string | null;
 
+        checkout_items?: Array<Session.CheckoutItem>;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the
@@ -517,6 +519,62 @@ declare module 'stripe' {
           }
         }
 
+        interface CheckoutItem {
+          type: CheckoutItem.Type;
+
+          rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
+
+          pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
+        }
+
+        namespace CheckoutItem {
+          interface PricingPlanSubscriptionItem {
+            pricing_plan: string;
+
+            pricing_plan_version: string;
+
+            metadata: Stripe.Metadata;
+
+            component_configurations: {
+              [key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
+            };
+
+            pricing_plan_subscription?: string;
+
+            billing_cadence?: string;
+          }
+
+          namespace PricingPlanSubscriptionItem {
+            interface ComponentConfigurations {
+              type: 'license_fee_component';
+
+              license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
+            }
+
+            namespace ComponentConfigurations {
+              interface LicenseFeeComponent {
+                quantity: number;
+              }
+            }
+          }
+
+          interface RateCardSubscriptionItem {
+            rate_card: string;
+
+            metadata: Stripe.Metadata;
+
+            rate_card_version: string;
+
+            billing_cadence?: string;
+
+            rate_card_subscription?: string;
+          }
+
+          type Type =
+            | 'rate_card_subscription_item'
+            | 'pricing_plan_subscription_item';
+        }
+
         interface CollectedInformation {
           /**
            * Customer's business name for this Checkout Session

package/types/Checkout/SessionsResource.d.ts

@@ -39,6 +39,8 @@ declare module 'stripe' {
          */
         cancel_url?: string;
 
+        checkout_items?: Array<SessionCreateParams.CheckoutItem>;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the
@@ -495,6 +497,54 @@ declare module 'stripe' {
           }
         }
 
+        interface CheckoutItem {
+          type: CheckoutItem.Type;
+
+          rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
+
+          pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
+        }
+
+        namespace CheckoutItem {
+          interface PricingPlanSubscriptionItem {
+            pricing_plan: string;
+
+            pricing_plan_version?: string;
+
+            metadata?: Stripe.MetadataParam;
+
+            component_configurations?: {
+              [key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
+            };
+          }
+
+          namespace PricingPlanSubscriptionItem {
+            interface ComponentConfigurations {
+              type: 'license_fee_component';
+
+              license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
+            }
+
+            namespace ComponentConfigurations {
+              interface LicenseFeeComponent {
+                quantity: number;
+              }
+            }
+          }
+
+          interface RateCardSubscriptionItem {
+            rate_card: string;
+
+            metadata?: Stripe.MetadataParam;
+
+            rate_card_version?: string;
+          }
+
+          type Type =
+            | 'rate_card_subscription_item'
+            | 'pricing_plan_subscription_item';
+        }
+
         interface ConsentCollection {
           /**
            * Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.

package/types/ConfirmationTokens.d.ts

@@ -431,6 +431,8 @@ declare module 'stripe' {
         }
 
         interface Card {
+          benefits?: Card.Benefits;
+
           /**
            * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
            */
@@ -520,6 +522,18 @@ declare module 'stripe' {
         }
 
         namespace Card {
+          interface Benefits {
+            /**
+             * Issuer of this benefit card
+             */
+            issuer: string | null;
+
+            /**
+             * Available benefit programs for this card
+             */
+            programs: Array<string> | null;
+          }
+
           interface Checks {
             /**
              * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.

package/types/Coupons.d.ts

@@ -143,7 +143,9 @@ declare module 'stripe' {
       }
 
       namespace Script {
-        interface Configuration {}
+        type Configuration = {
+          [key: string]: unknown;
+        };
       }
 
       type Type = 'amount_off' | 'percent_off' | 'script';