@depup/stripe 21.0.0-depup.0

package/types/Billing/CreditGrants.d.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * A credit grant is an API resource that documents the allocation of some billing credits to a customer.
+       *
+       * Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)
+       */
+      interface CreditGrant {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.credit_grant';
+
+        amount: CreditGrant.Amount;
+
+        applicability_config: CreditGrant.ApplicabilityConfig;
+
+        /**
+         * The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
+         */
+        category: CreditGrant.Category;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * ID of the customer receiving the billing credits.
+         */
+        customer: string | Stripe.Customer | Stripe.DeletedCustomer;
+
+        /**
+         * ID of the account representing the customer receiving the billing credits
+         */
+        customer_account: string | null;
+
+        /**
+         * The time when the billing credits become effective-when they're eligible for use.
+         */
+        effective_at: number | null;
+
+        /**
+         * The time when the billing credits expire. If not present, the billing credits don't expire.
+         */
+        expires_at: number | null;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/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;
+
+        /**
+         * A descriptive name shown in dashboard.
+         */
+        name: string | null;
+
+        /**
+         * The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
+         */
+        priority?: number | null;
+
+        /**
+         * ID of the test clock this credit grant belongs to.
+         */
+        test_clock: string | Stripe.TestHelpers.TestClock | null;
+
+        /**
+         * Time at which the object was last updated. Measured in seconds since the Unix epoch.
+         */
+        updated: number;
+
+        /**
+         * The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
+         */
+        voided_at: number | null;
+      }
+
+      namespace CreditGrant {
+        interface Amount {
+          /**
+           * The monetary amount.
+           */
+          monetary: Amount.Monetary | null;
+
+          /**
+           * The type of this amount. We currently only support `monetary` billing credits.
+           */
+          type: 'monetary';
+        }
+
+        namespace Amount {
+          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;
+          }
+        }
+
+        interface ApplicabilityConfig {
+          scope: ApplicabilityConfig.Scope;
+        }
+
+        namespace ApplicabilityConfig {
+          interface Scope {
+            /**
+             * 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`.
+             */
+            price_type?: 'metered';
+
+            /**
+             * The prices that credit grants can apply to. We currently only support `metered` prices. 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 `price_type`.
+             */
+            prices?: Array<Scope.Price>;
+          }
+
+          namespace Scope {
+            interface Price {
+              /**
+               * Unique identifier for the object.
+               */
+              id: string | null;
+            }
+          }
+        }
+
+        type Category = 'paid' | 'promotional';
+      }
+    }
+  }
+}

package/types/Billing/CreditGrantsResource.d.ts

@@ -0,0 +1,248 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface CreditGrantCreateParams {
+        /**
+         * Amount of this credit grant.
+         */
+        amount: CreditGrantCreateParams.Amount;
+
+        /**
+         * Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
+         */
+        applicability_config: CreditGrantCreateParams.ApplicabilityConfig;
+
+        /**
+         * The category of this credit grant. It defaults to `paid` if not specified.
+         */
+        category?: CreditGrantCreateParams.Category;
+
+        /**
+         * ID of the customer receiving the billing credits.
+         */
+        customer?: string;
+
+        /**
+         * ID of the account representing the customer receiving the billing credits.
+         */
+        customer_account?: string;
+
+        /**
+         * The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
+         */
+        effective_at?: number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The time when the billing credits expire. If not specified, the billing credits don't expire.
+         */
+        expires_at?: number;
+
+        /**
+         * Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
+         */
+        metadata?: Stripe.MetadataParam;
+
+        /**
+         * A descriptive name shown in the Dashboard.
+         */
+        name?: string;
+
+        /**
+         * The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
+         */
+        priority?: number;
+      }
+
+      namespace CreditGrantCreateParams {
+        interface Amount {
+          /**
+           * The monetary amount.
+           */
+          monetary?: Amount.Monetary;
+
+          /**
+           * The type of this amount. We currently only support `monetary` billing credits.
+           */
+          type: 'monetary';
+        }
+
+        namespace Amount {
+          interface Monetary {
+            /**
+             * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
+             */
+            currency: string;
+
+            /**
+             * A positive integer representing the amount of the credit grant.
+             */
+            value: number;
+          }
+        }
+
+        interface ApplicabilityConfig {
+          /**
+           * Specify the scope of this applicability config.
+           */
+          scope: ApplicabilityConfig.Scope;
+        }
+
+        namespace ApplicabilityConfig {
+          interface Scope {
+            /**
+             * 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 Price {
+              /**
+               * The price ID this credit grant should apply to.
+               */
+              id: string;
+            }
+          }
+        }
+
+        type Category = 'paid' | 'promotional';
+      }
+
+      interface CreditGrantRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditGrantUpdateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.
+         */
+        expires_at?: Stripe.Emptyable<number>;
+
+        /**
+         * Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
+         */
+        metadata?: Stripe.MetadataParam;
+      }
+
+      interface CreditGrantListParams extends PaginationParams {
+        /**
+         * Only return credit grants for this customer.
+         */
+        customer?: string;
+
+        /**
+         * Only return credit grants for this account representing the customer.
+         */
+        customer_account?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditGrantExpireParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface CreditGrantVoidGrantParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class CreditGrantsResource {
+        /**
+         * Creates a credit grant.
+         */
+        create(
+          params: CreditGrantCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Retrieves a credit grant.
+         */
+        retrieve(
+          id: string,
+          params?: CreditGrantRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Updates a credit grant.
+         */
+        update(
+          id: string,
+          params?: CreditGrantUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Retrieve a list of credit grants.
+         */
+        list(
+          params?: CreditGrantListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditGrant>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditGrant>;
+
+        /**
+         * Expires a credit grant.
+         */
+        expire(
+          id: string,
+          params?: CreditGrantExpireParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+        expire(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+
+        /**
+         * Voids a credit grant.
+         */
+        voidGrant(
+          id: string,
+          params?: CreditGrantVoidGrantParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+        voidGrant(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
+      }
+    }
+  }
+}

package/types/Billing/MeterEventAdjustments.d.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
+       */
+      interface MeterEventAdjustment {
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.meter_event_adjustment';
+
+        /**
+         * Specifies which event to cancel.
+         */
+        cancel: MeterEventAdjustment.Cancel | null;
+
+        /**
+         * The name of the meter event. Corresponds with the `event_name` field on a meter.
+         */
+        event_name: string;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * The meter event adjustment's status.
+         */
+        status: MeterEventAdjustment.Status;
+
+        /**
+         * Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+         */
+        type: 'cancel';
+      }
+
+      namespace MeterEventAdjustment {
+        interface Cancel {
+          /**
+           * Unique identifier for the event.
+           */
+          identifier: string | null;
+        }
+
+        type Status = 'complete' | 'pending';
+      }
+    }
+  }
+}

package/types/Billing/MeterEventAdjustmentsResource.d.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface MeterEventAdjustmentCreateParams {
+        /**
+         * The name of the meter event. Corresponds with the `event_name` field on a meter.
+         */
+        event_name: string;
+
+        /**
+         * Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+         */
+        type: 'cancel';
+
+        /**
+         * Specifies which event to cancel.
+         */
+        cancel?: MeterEventAdjustmentCreateParams.Cancel;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace MeterEventAdjustmentCreateParams {
+        interface Cancel {
+          /**
+           * Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+           */
+          identifier?: string;
+        }
+      }
+
+      class MeterEventAdjustmentsResource {
+        /**
+         * Creates a billing meter event adjustment.
+         */
+        create(
+          params: MeterEventAdjustmentCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.MeterEventAdjustment>>;
+      }
+    }
+  }
+}

package/types/Billing/MeterEventSummaries.d.ts

@@ -0,0 +1,50 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
+       * usage was accrued by a customer for that period.
+       *
+       * Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
+       */
+      interface MeterEventSummary {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        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: number;
+
+        /**
+         * End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
+         */
+        end_time: number;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * The meter associated with this event summary.
+         */
+        meter: string;
+
+        /**
+         * Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.
+         */
+        start_time: number;
+      }
+    }
+  }
+}

package/types/Billing/MeterEvents.d.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      /**
+       * Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
+       */
+      interface MeterEvent {
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'billing.meter_event';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * The name of the meter event. Corresponds with the `event_name` field on a meter.
+         */
+        event_name: string;
+
+        /**
+         * A unique identifier for the event.
+         */
+        identifier: string;
+
+        /**
+         * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+         */
+        livemode: boolean;
+
+        /**
+         * 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://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).
+         */
+        payload: {
+          [key: string]: string;
+        };
+
+        /**
+         * The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
+         */
+        timestamp: number;
+      }
+    }
+  }
+}

package/types/Billing/MeterEventsResource.d.ts

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface MeterEventCreateParams {
+        /**
+         * The name of the meter event. Corresponds with the `event_name` field on a meter.
+         */
+        event_name: string;
+
+        /**
+         * 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/meters/configure#meter-configuration-attributes).
+         */
+        payload: {
+          [key: string]: string;
+        };
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
+         */
+        identifier?: string;
+
+        /**
+         * 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;
+      }
+
+      class MeterEventsResource {
+        /**
+         * Creates a billing meter event.
+         */
+        create(
+          params: MeterEventCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.MeterEvent>>;
+      }
+    }
+  }
+}