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

package/types/ApplicationFees.d.ts

@@ -98,10 +98,15 @@ declare module 'stripe' {
          * Type of object that created the application fee.
          */
         type: FeeSource.Type;
+
+        /**
+         * Transfer ID that created this application fee.
+         */
+        transfer?: string;
       }
 
       namespace FeeSource {
-        type Type = 'charge' | 'payout';
+        type Type = 'charge' | 'payout' | 'transfer';
       }
     }
   }

package/types/Balance.d.ts

@@ -44,6 +44,8 @@ declare module 'stripe' {
       pending: Array<Balance.Pending>;
 
       refund_and_dispute_prefunding?: Balance.RefundAndDisputePrefunding;
+
+      transit_balances_total?: Balance.TransitBalancesTotal;
     }
 
     namespace Balance {
@@ -338,6 +340,86 @@ declare module 'stripe' {
           }
         }
       }
+
+      interface TransitBalancesTotal {
+        /**
+         * Funds that are available for use.
+         */
+        available: Array<TransitBalancesTotal.Available>;
+
+        /**
+         * Funds that are pending
+         */
+        pending: Array<TransitBalancesTotal.Pending>;
+      }
+
+      namespace TransitBalancesTotal {
+        interface Available {
+          /**
+           * Balance amount.
+           */
+          amount: number;
+
+          /**
+           * 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).
+           */
+          currency: string;
+
+          source_types?: Available.SourceTypes;
+        }
+
+        namespace Available {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+
+        interface Pending {
+          /**
+           * Balance amount.
+           */
+          amount: number;
+
+          /**
+           * 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).
+           */
+          currency: string;
+
+          source_types?: Pending.SourceTypes;
+        }
+
+        namespace Pending {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+      }
     }
   }
 }

package/types/BalanceTransactions.d.ts

@@ -94,7 +94,8 @@ declare module 'stripe' {
       type BalanceType =
         | 'issuing'
         | 'payments'
-        | 'refund_and_dispute_prefunding';
+        | 'refund_and_dispute_prefunding'
+        | 'transit';
 
       interface FeeDetail {
         /**

package/types/Billing/AlertTriggereds.d.ts

@@ -22,11 +22,26 @@ declare module 'stripe' {
          */
         created: number;
 
+        /**
+         * Currency for the threshold value
+         */
+        currency?: string | null;
+
+        /**
+         * Custom pricing unit for the threshold value
+         */
+        custom_pricing_unit?: string | null;
+
         /**
          * ID of customer for which the alert triggered
          */
         customer: string;
 
+        /**
+         * External customer ID for the customer for which the alert triggered
+         */
+        external_customer_id?: string | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */

package/types/Billing/Alerts.d.ts

@@ -20,7 +20,12 @@ declare module 'stripe' {
         /**
          * Defines the type of the alert.
          */
-        alert_type: 'usage_threshold';
+        alert_type: Alert.AlertType;
+
+        /**
+         * Encapsulates configuration of the alert to monitor billing credit balance.
+         */
+        credit_balance_threshold?: Alert.CreditBalanceThreshold | null;
 
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
@@ -44,6 +49,116 @@ declare module 'stripe' {
       }
 
       namespace Alert {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+
+        interface CreditBalanceThreshold {
+          /**
+           * The filters allow limiting the scope of this credit balance alert. You must specify only a customer filter at this time.
+           */
+          filters: Array<CreditBalanceThreshold.Filter> | null;
+
+          lte: CreditBalanceThreshold.Lte;
+        }
+
+        namespace CreditBalanceThreshold {
+          interface Filter {
+            /**
+             * Limit the scope of the alert to this customer ID
+             */
+            customer: string | Stripe.Customer | null;
+
+            type: Filter.Type;
+          }
+
+          namespace Filter {
+            type Type = 'customer' | 'tenant';
+          }
+
+          interface Lte {
+            /**
+             * The type of this balance. We currently only support `monetary` amounts.
+             */
+            balance_type: Lte.BalanceType;
+
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Lte.CustomPricingUnit | null;
+
+            /**
+             * The monetary amount.
+             */
+            monetary: Lte.Monetary | null;
+          }
+
+          namespace Lte {
+            type BalanceType = 'custom_pricing_unit' | 'monetary';
+
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive decimal string 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).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+        }
+
         type Status = 'active' | 'archived' | 'inactive';
 
         interface UsageThreshold {

package/types/Billing/AlertsResource.d.ts

@@ -7,13 +7,18 @@ declare module 'stripe' {
         /**
          * The type of alert to create.
          */
-        alert_type: 'usage_threshold';
+        alert_type: AlertCreateParams.AlertType;
 
         /**
          * The title of the alert.
          */
         title: string;
 
+        /**
+         * The configuration of the credit balance threshold.
+         */
+        credit_balance_threshold?: AlertCreateParams.CreditBalanceThreshold;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -26,6 +31,139 @@ declare module 'stripe' {
       }
 
       namespace AlertCreateParams {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+
+        interface CreditBalanceThreshold {
+          /**
+           * The filters allows limiting the scope of this credit balance alert. You must specify a customer filter at this time.
+           */
+          filters?: Array<CreditBalanceThreshold.Filter>;
+
+          /**
+           * Defines at which value the alert will fire.
+           */
+          lte: CreditBalanceThreshold.Lte;
+        }
+
+        namespace CreditBalanceThreshold {
+          interface Filter {
+            /**
+             * The credit grants for which to configure the credit balance alert.
+             */
+            credit_grants?: Filter.CreditGrants;
+
+            /**
+             * Limit the scope to this credit balance alert only to this customer.
+             */
+            customer?: string;
+
+            /**
+             * What type of filter is being applied to this credit balance alert.
+             */
+            type: Filter.Type;
+          }
+
+          namespace Filter {
+            interface CreditGrants {
+              /**
+               * The applicability configuration for this credit grants filter.
+               */
+              applicability_config: CreditGrants.ApplicabilityConfig;
+            }
+
+            namespace CreditGrants {
+              interface ApplicabilityConfig {
+                /**
+                 * Specify the scope of this applicability config.
+                 */
+                scope: ApplicabilityConfig.Scope;
+              }
+
+              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`.
+                   */
+                  price_type?: 'metered';
+
+                  /**
+                   * A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
+                   */
+                  prices?: Array<Scope.Price>;
+                }
+
+                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.
+                     */
+                    id: string;
+                  }
+                }
+              }
+            }
+
+            type Type = 'customer' | 'tenant';
+          }
+
+          interface Lte {
+            /**
+             * Specify the type of this balance. We currently only support `monetary` billing credits.
+             */
+            balance_type: Lte.BalanceType;
+
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Lte.CustomPricingUnit;
+
+            /**
+             * The monetary amount.
+             */
+            monetary?: Lte.Monetary;
+          }
+
+          namespace Lte {
+            type BalanceType = 'custom_pricing_unit' | 'monetary';
+
+            interface CustomPricingUnit {
+              /**
+               * The ID of the custom pricing unit.
+               */
+              id: string;
+
+              /**
+               * A positive decimal string representing the amount of the custom pricing unit threshold.
+               */
+              value: string;
+            }
+
+            interface Monetary {
+              /**
+               * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
+               */
+              currency: string;
+
+              /**
+               * An integer representing the amount of the threshold.
+               */
+              value: number;
+            }
+          }
+        }
+
         interface UsageThreshold {
           /**
            * The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
@@ -74,7 +212,12 @@ declare module 'stripe' {
         /**
          * Filter results to only include this type of alert.
          */
-        alert_type?: 'usage_threshold';
+        alert_type?: AlertListParams.AlertType;
+
+        /**
+         * Filter results to only include alerts for the given customer.
+         */
+        customer?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -87,6 +230,10 @@ declare module 'stripe' {
         meter?: string;
       }
 
+      namespace AlertListParams {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+      }
+
       interface AlertActivateParams {
         /**
          * Specifies which fields in the response should be expanded.

package/types/Billing/Analytics/MeterUsageResource.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
             tenant_filters?: {
               [key: string]: string;
             };
+
+            /**
+             * List of high cardinality tenant dimension keys to group by. If specified, usage events will be grouped by the given tenant dimension key's values.
+             */
+            tenant_group_by_keys?: Array<string>;
           }
 
           type Timezone =

package/types/Billing/Analytics/MeterUsageRows.d.ts

@@ -40,6 +40,13 @@ declare module 'stripe' {
            */
           starts_at: number;
 
+          /**
+           * A set of key-value pairs representing the tenants of the meter usage.
+           */
+          tenants?: {
+            [key: string]: string;
+          } | null;
+
           /**
            * The aggregated meter usage value for the specified bucket.
            */

package/types/Billing/CreditBalanceSummary.d.ts

@@ -42,6 +42,11 @@ declare module 'stripe' {
 
         namespace Balance {
           interface AvailableBalance {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: AvailableBalance.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -50,10 +55,61 @@ declare module 'stripe' {
             /**
              * The type of this amount. We currently only support `monetary` billing credits.
              */
-            type: 'monetary';
+            type: AvailableBalance.Type;
           }
 
           namespace AvailableBalance {
+            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).
@@ -65,9 +121,16 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
 
           interface LedgerBalance {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: LedgerBalance.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -76,10 +139,61 @@ declare module 'stripe' {
             /**
              * The type of this amount. We currently only support `monetary` billing credits.
              */
-            type: 'monetary';
+            type: LedgerBalance.Type;
           }
 
           namespace LedgerBalance {
+            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).
@@ -91,6 +205,8 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
         }
       }

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -45,6 +45,11 @@ declare module 'stripe' {
 
         namespace Filter {
           interface ApplicabilityScope {
+            /**
+             * 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<ApplicabilityScope.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`.
              */
@@ -57,6 +62,13 @@ declare module 'stripe' {
           }
 
           namespace ApplicabilityScope {
+            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.