stripe 18.5.0-beta.2 → 18.6.0-alpha.1

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.

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/MeterUsageRows.d.ts

@@ -40,7 +40,7 @@ declare module 'stripe' {
         } | null;
 
         /**
-         * The unique identifier for the meter.
+         * The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
          */
         meter_id: string | null;
       }

package/types/Billing/Meters.d.ts

@@ -39,7 +39,7 @@ declare module 'stripe' {
         event_name: string;
 
         /**
-         * The time window to pre-aggregate meter events for, if any.
+         * The time window which meter events have been pre-aggregated for, if any.
          */
         event_time_window: Meter.EventTimeWindow | null;
 

package/types/Billing/MetersResource.d.ts

@@ -25,7 +25,7 @@ declare module 'stripe' {
         customer_mapping?: MeterCreateParams.CustomerMapping;
 
         /**
-         * The time window to pre-aggregate meter events for, if any.
+         * The time window which meter events have been pre-aggregated for, if any.
          */
         event_time_window?: MeterCreateParams.EventTimeWindow;
 

package/types/BillingPortal/Configurations.d.ts

@@ -62,6 +62,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata | null;
 
+        /**
+         * The name of the configuration.
+         */
+        name: string | null;
+
         /**
          * Time at which the object was last updated. Measured in seconds since the Unix epoch.
          */

package/types/BillingPortal/ConfigurationsResource.d.ts

@@ -33,6 +33,11 @@ declare module 'stripe' {
          * 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          */
         metadata?: Stripe.MetadataParam;
+
+        /**
+         * The name of the configuration.
+         */
+        name?: Stripe.Emptyable<string>;
       }
 
       namespace ConfigurationCreateParams {
@@ -319,6 +324,11 @@ declare module 'stripe' {
          * 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          */
         metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+
+        /**
+         * The name of the configuration.
+         */
+        name?: Stripe.Emptyable<string>;
       }
 
       namespace ConfigurationUpdateParams {