stripe 19.2.1 → 19.3.0-alpha.2

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

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      namespace Analytics {
+        /**
+         * The MeterUsageRow object.
+         */
+        interface MeterUsageRow {
+          /**
+           * Unique identifier for the object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value.
+           */
+          object: 'billing.analytics.meter_usage_row';
+
+          /**
+           * A set of key-value pairs representing the dimensions of the meter usage.
+           */
+          dimensions: {
+            [key: string]: string;
+          } | null;
+
+          /**
+           * Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.
+           */
+          ends_at: number;
+
+          /**
+           * The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
+           */
+          meter: string | null;
+
+          /**
+           * Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.
+           */
+          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.
+           */
+          value: number;
+        }
+      }
+    }
+  }
+}

package/types/Billing/CreditBalanceSummary.d.ts

@@ -22,6 +22,11 @@ declare module 'stripe' {
          */
         customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+        /**
+         * The account the balance is for.
+         */
+        customer_account?: string | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -37,6 +42,11 @@ declare module 'stripe' {
 
         namespace Balance {
           interface AvailableBalance {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: AvailableBalance.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -45,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).
@@ -60,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.
              */
@@ -71,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).
@@ -86,6 +205,8 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
         }
       }

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -4,15 +4,20 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Billing {
       interface CreditBalanceSummaryRetrieveParams {
+        /**
+         * The filter criteria for the credit balance summary.
+         */
+        filter: CreditBalanceSummaryRetrieveParams.Filter;
+
         /**
          * The customer for which to fetch credit balance summary.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The filter criteria for the credit balance summary.
+         * The account for which to fetch credit balance summary.
          */
-        filter: CreditBalanceSummaryRetrieveParams.Filter;
+        customer_account?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -40,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`.
              */
@@ -52,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/CreditBalanceTransactionsResource.d.ts

@@ -11,15 +11,20 @@ declare module 'stripe' {
       }
 
       interface CreditBalanceTransactionListParams extends PaginationParams {
+        /**
+         * The credit grant for which to fetch credit balance transactions.
+         */
+        credit_grant?: string;
+
         /**
          * The customer for which to fetch credit balance transactions.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The credit grant for which to fetch credit balance transactions.
+         * The account for which to fetch credit balance transactions.
          */
-        credit_grant?: string;
+        customer_account?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -45,7 +50,10 @@ declare module 'stripe' {
          * Retrieve a list of credit balance transactions.
          */
         list(
-          params: CreditBalanceTransactionListParams,
+          params?: CreditBalanceTransactionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditBalanceTransaction>;
+        list(
           options?: RequestOptions
         ): ApiListPromise<Stripe.Billing.CreditBalanceTransaction>;
       }

package/types/Billing/CreditGrants.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
          */
         customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+        /**
+         * ID of the account receiving the billing credits
+         */
+        customer_account?: string | null;
+
         /**
          * The time when the billing credits become effective-when they're eligible for use.
          */
@@ -86,6 +91,11 @@ declare module 'stripe' {
 
       namespace CreditGrant {
         interface Amount {
+          /**
+           * The custom pricing unit amount.
+           */
+          custom_pricing_unit?: Amount.CustomPricingUnit | null;
+
           /**
            * The monetary amount.
            */
@@ -94,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).
@@ -109,6 +170,8 @@ declare module 'stripe' {
              */
             value: number;
           }
+
+          type Type = 'custom_pricing_unit' | 'monetary';
         }
 
         interface ApplicabilityConfig {
@@ -117,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`.
              */
@@ -129,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.