stripe 16.13.0-beta.1 → 17.1.0

package/types/V2/BillingResource.d.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      class BillingResource {
+        meterEventSession: Stripe.V2.Billing.MeterEventSessionResource;
+        meterEventAdjustments: Stripe.V2.Billing.MeterEventAdjustmentsResource;
+        meterEventStream: Stripe.V2.Billing.MeterEventStreamResource;
+        meterEvents: Stripe.V2.Billing.MeterEventsResource;
+      }
+    }
+  }
+}

package/types/V2/Core/EventsResource.d.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec
+
+/// <reference path='../EventTypes.d.ts' />
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Core {
+        interface EventRetrieveParams {}
+      }
+
+      namespace Core {
+        interface EventListParams {
+          /**
+           * Primary object ID used to retrieve related events.
+           */
+          object_id: string;
+
+          /**
+           * The page size.
+           */
+          limit?: number;
+
+          /**
+           * The requested page number.
+           */
+          page?: string;
+        }
+      }
+
+      namespace Core {
+        class EventsResource {
+          /**
+           * Retrieves the details of an event.
+           */
+          retrieve(
+            id: string,
+            params?: EventRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Event>>;
+
+          /**
+           * List events, going back up to 30 days.
+           */
+          list(
+            params: EventListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.Event>;
+        }
+      }
+    }
+  }
+}

package/types/V2/CoreResource.d.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      class CoreResource {
+        events: Stripe.V2.Core.EventsResource;
+      }
+    }
+  }
+}

package/types/V2/EventTypes.d.ts

@@ -0,0 +1,214 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe.V2 {
+    export type Event =
+      | Stripe.Events.V1BillingMeterErrorReportTriggeredEvent
+      | Stripe.Events.V1BillingMeterNoMeterFoundEvent;
+  }
+
+  namespace Stripe.Events {
+    /**
+     * This event occurs when there are invalid async usage events for a given meter.
+     */
+    export interface V1BillingMeterErrorReportTriggeredEvent
+      extends V2.EventBase {
+      type: 'v1.billing.meter.error_report_triggered';
+      // Retrieves data specific to this event.
+      data: V1BillingMeterErrorReportTriggeredEvent.Data;
+      // Retrieves the object associated with the event.
+      related_object: Event.RelatedObject;
+    }
+
+    namespace V1BillingMeterErrorReportTriggeredEvent {
+      export interface Data {
+        /**
+         * Extra field included in the event's `data` when fetched from /v2/events.
+         */
+        developer_message_summary: string;
+
+        /**
+         * This contains information about why meter error happens.
+         */
+        reason: Data.Reason;
+
+        /**
+         * The end of the window that is encapsulated by this summary.
+         */
+        validation_end: string;
+
+        /**
+         * The start of the window that is encapsulated by this summary.
+         */
+        validation_start: string;
+      }
+
+      namespace Data {
+        export interface Reason {
+          /**
+           * The total error count within this window.
+           */
+          error_count: number;
+
+          /**
+           * The error details.
+           */
+          error_types: Array<Reason.ErrorType>;
+        }
+
+        namespace Reason {
+          export interface ErrorType {
+            /**
+             * Open Enum.
+             */
+            code: ErrorType.Code;
+
+            /**
+             * The number of errors of this type.
+             */
+            error_count: number;
+
+            /**
+             * A list of sample errors of this type.
+             */
+            sample_errors: Array<ErrorType.SampleError>;
+          }
+
+          namespace ErrorType {
+            export type Code =
+              | 'archived_meter'
+              | 'meter_event_customer_not_found'
+              | 'meter_event_dimension_count_too_high'
+              | 'meter_event_invalid_value'
+              | 'meter_event_no_customer_defined'
+              | 'missing_dimension_payload_keys'
+              | 'no_meter'
+              | 'timestamp_in_future'
+              | 'timestamp_too_far_in_past';
+
+            export interface SampleError {
+              /**
+               * The error message.
+               */
+              error_message: string;
+
+              /**
+               * The request causes the error.
+               */
+              request: SampleError.Request;
+            }
+
+            namespace SampleError {
+              export interface Request {
+                /**
+                 * The request idempotency key.
+                 */
+                identifier: string;
+              }
+            }
+          }
+        }
+      }
+    }
+
+    /**
+     * This event occurs when async usage events have missing or invalid meter ids.
+     */
+    export interface V1BillingMeterNoMeterFoundEvent extends V2.EventBase {
+      type: 'v1.billing.meter.no_meter_found';
+      // Retrieves data specific to this event.
+      data: V1BillingMeterNoMeterFoundEvent.Data;
+    }
+
+    namespace V1BillingMeterNoMeterFoundEvent {
+      export interface Data {
+        /**
+         * Extra field included in the event's `data` when fetched from /v2/events.
+         */
+        developer_message_summary: string;
+
+        /**
+         * This contains information about why meter error happens.
+         */
+        reason: Data.Reason;
+
+        /**
+         * The end of the window that is encapsulated by this summary.
+         */
+        validation_end: string;
+
+        /**
+         * The start of the window that is encapsulated by this summary.
+         */
+        validation_start: string;
+      }
+
+      namespace Data {
+        export interface Reason {
+          /**
+           * The total error count within this window.
+           */
+          error_count: number;
+
+          /**
+           * The error details.
+           */
+          error_types: Array<Reason.ErrorType>;
+        }
+
+        namespace Reason {
+          export interface ErrorType {
+            /**
+             * Open Enum.
+             */
+            code: ErrorType.Code;
+
+            /**
+             * The number of errors of this type.
+             */
+            error_count: number;
+
+            /**
+             * A list of sample errors of this type.
+             */
+            sample_errors: Array<ErrorType.SampleError>;
+          }
+
+          namespace ErrorType {
+            export type Code =
+              | 'archived_meter'
+              | 'meter_event_customer_not_found'
+              | 'meter_event_dimension_count_too_high'
+              | 'meter_event_invalid_value'
+              | 'meter_event_no_customer_defined'
+              | 'missing_dimension_payload_keys'
+              | 'no_meter'
+              | 'timestamp_in_future'
+              | 'timestamp_too_far_in_past';
+
+            export interface SampleError {
+              /**
+               * The error message.
+               */
+              error_message: string;
+
+              /**
+               * The request causes the error.
+               */
+              request: SampleError.Request;
+            }
+
+            namespace SampleError {
+              export interface Request {
+                /**
+                 * The request idempotency key.
+                 */
+                identifier: string;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Events.d.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Event {
+        interface Reason {
+          /**
+           * Event reason type.
+           */
+          type: 'request';
+
+          /**
+           * Information on the API request that instigated the event.
+           */
+          request: Reason.Request | null;
+        }
+
+        namespace Reason {
+          interface Request {
+            /**
+             * ID of the API request that caused the event.
+             */
+            id: string;
+
+            /**
+             * The idempotency key transmitted during the request.
+             */
+            idempotency_key: string;
+          }
+        }
+      }
+
+      /**
+       * The Event object.
+       */
+      interface EventBase {
+        /**
+         * Unique identifier for the event.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value of the object field.
+         */
+        object: 'v2.core.event';
+
+        /**
+         * Authentication context needed to fetch the event or related object.
+         */
+        context: string | null;
+
+        /**
+         * Time at which the object was created.
+         */
+        created: string;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * Reason for the event.
+         */
+        reason: Event.Reason | null;
+
+        /**
+         * The type of the event.
+         */
+        type: string;
+      }
+    }
+  }
+}

package/types/V2Resource.d.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    class V2Resource {
+      billing: Stripe.V2.BillingResource;
+      core: Stripe.V2.CoreResource;
+    }
+  }
+}

package/types/WebhookEndpointsResource.d.ts

@@ -142,7 +142,8 @@ declare module 'stripe' {
         | '2023-08-16'
         | '2023-10-16'
         | '2024-04-10'
-        | '2024-06-20';
+        | '2024-06-20'
+        | '2024-09-30.acacia';
 
       type EnabledEvent =
         | '*'
@@ -152,27 +153,15 @@ declare module 'stripe' {
         | 'account.external_account.deleted'
         | 'account.external_account.updated'
         | 'account.updated'
-        | 'account_notice.created'
-        | 'account_notice.updated'
         | 'application_fee.created'
         | 'application_fee.refund.updated'
         | 'application_fee.refunded'
         | 'balance.available'
         | 'billing.alert.triggered'
-        | 'billing.meter_error_report.triggered'
         | 'billing_portal.configuration.created'
         | 'billing_portal.configuration.updated'
         | 'billing_portal.session.created'
         | 'capability.updated'
-        | 'capital.financing_offer.accepted'
-        | 'capital.financing_offer.canceled'
-        | 'capital.financing_offer.created'
-        | 'capital.financing_offer.expired'
-        | 'capital.financing_offer.fully_repaid'
-        | 'capital.financing_offer.paid_out'
-        | 'capital.financing_offer.rejected'
-        | 'capital.financing_offer.replacement_created'
-        | 'capital.financing_transaction.created'
         | 'cash_balance.funds_available'
         | 'charge.captured'
         | 'charge.dispute.closed'
@@ -213,15 +202,11 @@ declare module 'stripe' {
         | 'customer.source.deleted'
         | 'customer.source.expiring'
         | 'customer.source.updated'
-        | 'customer.subscription.collection_paused'
-        | 'customer.subscription.collection_resumed'
         | 'customer.subscription.created'
-        | 'customer.subscription.custom_event'
         | 'customer.subscription.deleted'
         | 'customer.subscription.paused'
         | 'customer.subscription.pending_update_applied'
         | 'customer.subscription.pending_update_expired'
-        | 'customer.subscription.price_migration_failed'
         | 'customer.subscription.resumed'
         | 'customer.subscription.trial_will_end'
         | 'customer.subscription.updated'
@@ -237,10 +222,8 @@ declare module 'stripe' {
         | 'financial_connections.account.disconnected'
         | 'financial_connections.account.reactivated'
         | 'financial_connections.account.refreshed_balance'
-        | 'financial_connections.account.refreshed_inferred_balances'
         | 'financial_connections.account.refreshed_ownership'
         | 'financial_connections.account.refreshed_transactions'
-        | 'financial_connections.session.updated'
         | 'identity.verification_session.canceled'
         | 'identity.verification_session.created'
         | 'identity.verification_session.processing'
@@ -254,7 +237,6 @@ declare module 'stripe' {
         | 'invoice.marked_uncollectible'
         | 'invoice.overdue'
         | 'invoice.paid'
-        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
         | 'invoice.payment_failed'
         | 'invoice.payment_succeeded'
@@ -278,14 +260,10 @@ declare module 'stripe' {
         | 'issuing_dispute.funds_rescinded'
         | 'issuing_dispute.submitted'
         | 'issuing_dispute.updated'
-        | 'issuing_dispute_settlement_detail.created'
-        | 'issuing_dispute_settlement_detail.updated'
         | 'issuing_personalization_design.activated'
         | 'issuing_personalization_design.deactivated'
         | 'issuing_personalization_design.rejected'
         | 'issuing_personalization_design.updated'
-        | 'issuing_settlement.created'
-        | 'issuing_settlement.updated'
         | 'issuing_token.created'
         | 'issuing_token.updated'
         | 'issuing_transaction.created'
@@ -325,16 +303,10 @@ declare module 'stripe' {
         | 'product.updated'
         | 'promotion_code.created'
         | 'promotion_code.updated'
-        | 'quote.accept_failed'
         | 'quote.accepted'
-        | 'quote.accepting'
         | 'quote.canceled'
         | 'quote.created'
-        | 'quote.draft'
         | 'quote.finalized'
-        | 'quote.reestimate_failed'
-        | 'quote.reestimated'
-        | 'quote.stale'
         | 'radar.early_fraud_warning.created'
         | 'radar.early_fraud_warning.updated'
         | 'refund.created'
@@ -362,16 +334,13 @@ declare module 'stripe' {
         | 'subscription_schedule.completed'
         | 'subscription_schedule.created'
         | 'subscription_schedule.expiring'
-        | 'subscription_schedule.price_migration_failed'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
-        | 'tax.form.updated'
         | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'
         | 'terminal.reader.action_failed'
         | 'terminal.reader.action_succeeded'
-        | 'terminal.reader.action_updated'
         | 'test_helpers.test_clock.advancing'
         | 'test_helpers.test_clock.created'
         | 'test_helpers.test_clock.deleted'
@@ -465,27 +434,15 @@ declare module 'stripe' {
         | 'account.external_account.deleted'
         | 'account.external_account.updated'
         | 'account.updated'
-        | 'account_notice.created'
-        | 'account_notice.updated'
         | 'application_fee.created'
         | 'application_fee.refund.updated'
         | 'application_fee.refunded'
         | 'balance.available'
         | 'billing.alert.triggered'
-        | 'billing.meter_error_report.triggered'
         | 'billing_portal.configuration.created'
         | 'billing_portal.configuration.updated'
         | 'billing_portal.session.created'
         | 'capability.updated'
-        | 'capital.financing_offer.accepted'
-        | 'capital.financing_offer.canceled'
-        | 'capital.financing_offer.created'
-        | 'capital.financing_offer.expired'
-        | 'capital.financing_offer.fully_repaid'
-        | 'capital.financing_offer.paid_out'
-        | 'capital.financing_offer.rejected'
-        | 'capital.financing_offer.replacement_created'
-        | 'capital.financing_transaction.created'
         | 'cash_balance.funds_available'
         | 'charge.captured'
         | 'charge.dispute.closed'
@@ -526,15 +483,11 @@ declare module 'stripe' {
         | 'customer.source.deleted'
         | 'customer.source.expiring'
         | 'customer.source.updated'
-        | 'customer.subscription.collection_paused'
-        | 'customer.subscription.collection_resumed'
         | 'customer.subscription.created'
-        | 'customer.subscription.custom_event'
         | 'customer.subscription.deleted'
         | 'customer.subscription.paused'
         | 'customer.subscription.pending_update_applied'
         | 'customer.subscription.pending_update_expired'
-        | 'customer.subscription.price_migration_failed'
         | 'customer.subscription.resumed'
         | 'customer.subscription.trial_will_end'
         | 'customer.subscription.updated'
@@ -550,10 +503,8 @@ declare module 'stripe' {
         | 'financial_connections.account.disconnected'
         | 'financial_connections.account.reactivated'
         | 'financial_connections.account.refreshed_balance'
-        | 'financial_connections.account.refreshed_inferred_balances'
         | 'financial_connections.account.refreshed_ownership'
         | 'financial_connections.account.refreshed_transactions'
-        | 'financial_connections.session.updated'
         | 'identity.verification_session.canceled'
         | 'identity.verification_session.created'
         | 'identity.verification_session.processing'
@@ -567,7 +518,6 @@ declare module 'stripe' {
         | 'invoice.marked_uncollectible'
         | 'invoice.overdue'
         | 'invoice.paid'
-        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
         | 'invoice.payment_failed'
         | 'invoice.payment_succeeded'
@@ -591,14 +541,10 @@ declare module 'stripe' {
         | 'issuing_dispute.funds_rescinded'
         | 'issuing_dispute.submitted'
         | 'issuing_dispute.updated'
-        | 'issuing_dispute_settlement_detail.created'
-        | 'issuing_dispute_settlement_detail.updated'
         | 'issuing_personalization_design.activated'
         | 'issuing_personalization_design.deactivated'
         | 'issuing_personalization_design.rejected'
         | 'issuing_personalization_design.updated'
-        | 'issuing_settlement.created'
-        | 'issuing_settlement.updated'
         | 'issuing_token.created'
         | 'issuing_token.updated'
         | 'issuing_transaction.created'
@@ -638,16 +584,10 @@ declare module 'stripe' {
         | 'product.updated'
         | 'promotion_code.created'
         | 'promotion_code.updated'
-        | 'quote.accept_failed'
         | 'quote.accepted'
-        | 'quote.accepting'
         | 'quote.canceled'
         | 'quote.created'
-        | 'quote.draft'
         | 'quote.finalized'
-        | 'quote.reestimate_failed'
-        | 'quote.reestimated'
-        | 'quote.stale'
         | 'radar.early_fraud_warning.created'
         | 'radar.early_fraud_warning.updated'
         | 'refund.created'
@@ -675,16 +615,13 @@ declare module 'stripe' {
         | 'subscription_schedule.completed'
         | 'subscription_schedule.created'
         | 'subscription_schedule.expiring'
-        | 'subscription_schedule.price_migration_failed'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
-        | 'tax.form.updated'
         | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'
         | 'terminal.reader.action_failed'
         | 'terminal.reader.action_succeeded'
-        | 'terminal.reader.action_updated'
         | 'test_helpers.test_clock.advancing'
         | 'test_helpers.test_clock.created'
         | 'test_helpers.test_clock.deleted'