stripe 16.9.0 → 16.11.0-beta.1

package/types/EventTypes.d.ts

@@ -9,15 +9,27 @@ declare module 'stripe' {
       | AccountExternalAccountDeletedEvent
       | AccountExternalAccountUpdatedEvent
       | AccountUpdatedEvent
+      | AccountNoticeCreatedEvent
+      | AccountNoticeUpdatedEvent
       | ApplicationFeeCreatedEvent
       | ApplicationFeeRefundUpdatedEvent
       | ApplicationFeeRefundedEvent
       | BalanceAvailableEvent
       | BillingAlertTriggeredEvent
+      | BillingMeterErrorReportTriggeredEvent
       | BillingPortalConfigurationCreatedEvent
       | BillingPortalConfigurationUpdatedEvent
       | BillingPortalSessionCreatedEvent
       | CapabilityUpdatedEvent
+      | CapitalFinancingOfferAcceptedEvent
+      | CapitalFinancingOfferCanceledEvent
+      | CapitalFinancingOfferCreatedEvent
+      | CapitalFinancingOfferExpiredEvent
+      | CapitalFinancingOfferFullyRepaidEvent
+      | CapitalFinancingOfferPaidOutEvent
+      | CapitalFinancingOfferRejectedEvent
+      | CapitalFinancingOfferReplacementCreatedEvent
+      | CapitalFinancingTransactionCreatedEvent
       | CashBalanceFundsAvailableEvent
       | ChargeCapturedEvent
       | ChargeDisputeClosedEvent
@@ -58,11 +70,15 @@ declare module 'stripe' {
       | CustomerSourceDeletedEvent
       | CustomerSourceExpiringEvent
       | CustomerSourceUpdatedEvent
+      | CustomerSubscriptionCollectionPausedEvent
+      | CustomerSubscriptionCollectionResumedEvent
       | CustomerSubscriptionCreatedEvent
+      | CustomerSubscriptionCustomEventEvent
       | CustomerSubscriptionDeletedEvent
       | CustomerSubscriptionPausedEvent
       | CustomerSubscriptionPendingUpdateAppliedEvent
       | CustomerSubscriptionPendingUpdateExpiredEvent
+      | CustomerSubscriptionPriceMigrationFailedEvent
       | CustomerSubscriptionResumedEvent
       | CustomerSubscriptionTrialWillEndEvent
       | CustomerSubscriptionUpdatedEvent
@@ -78,8 +94,10 @@ declare module 'stripe' {
       | FinancialConnectionsAccountDisconnectedEvent
       | FinancialConnectionsAccountReactivatedEvent
       | FinancialConnectionsAccountRefreshedBalanceEvent
+      | FinancialConnectionsAccountRefreshedInferredBalancesEvent
       | FinancialConnectionsAccountRefreshedOwnershipEvent
       | FinancialConnectionsAccountRefreshedTransactionsEvent
+      | FinancialConnectionsSessionUpdatedEvent
       | IdentityVerificationSessionCanceledEvent
       | IdentityVerificationSessionCreatedEvent
       | IdentityVerificationSessionProcessingEvent
@@ -93,6 +111,7 @@ declare module 'stripe' {
       | InvoiceMarkedUncollectibleEvent
       | InvoiceOverdueEvent
       | InvoicePaidEvent
+      | InvoicePaymentOverpaidEvent
       | InvoicePaymentActionRequiredEvent
       | InvoicePaymentFailedEvent
       | InvoicePaymentSucceededEvent
@@ -159,10 +178,16 @@ declare module 'stripe' {
       | ProductUpdatedEvent
       | PromotionCodeCreatedEvent
       | PromotionCodeUpdatedEvent
+      | QuoteAcceptFailedEvent
       | QuoteAcceptedEvent
+      | QuoteAcceptingEvent
       | QuoteCanceledEvent
       | QuoteCreatedEvent
+      | QuoteDraftEvent
       | QuoteFinalizedEvent
+      | QuoteReestimateFailedEvent
+      | QuoteReestimatedEvent
+      | QuoteStaleEvent
       | RadarEarlyFraudWarningCreatedEvent
       | RadarEarlyFraudWarningUpdatedEvent
       | RefundCreatedEvent
@@ -190,13 +215,16 @@ declare module 'stripe' {
       | SubscriptionScheduleCompletedEvent
       | SubscriptionScheduleCreatedEvent
       | SubscriptionScheduleExpiringEvent
+      | SubscriptionSchedulePriceMigrationFailedEvent
       | SubscriptionScheduleReleasedEvent
       | SubscriptionScheduleUpdatedEvent
+      | TaxFormUpdatedEvent
       | TaxSettingsUpdatedEvent
       | TaxRateCreatedEvent
       | TaxRateUpdatedEvent
       | TerminalReaderActionFailedEvent
       | TerminalReaderActionSucceededEvent
+      | TerminalReaderActionUpdatedEvent
       | TestHelpersTestClockAdvancingEvent
       | TestHelpersTestClockCreatedEvent
       | TestHelpersTestClockDeletedEvent
@@ -337,6 +365,38 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever an AccountNotice is created.
+     */
+    interface AccountNoticeCreatedEvent extends EventBase {
+      type: 'account_notice.created';
+      data: AccountNoticeCreatedEvent.Data;
+    }
+
+    namespace AccountNoticeCreatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.AccountNotice;
+
+        previous_attributes?: Partial<Stripe.AccountNotice>;
+      }
+    }
+
+    /**
+     * Occurs whenever an AccountNotice is updated.
+     */
+    interface AccountNoticeUpdatedEvent extends EventBase {
+      type: 'account_notice.updated';
+      data: AccountNoticeUpdatedEvent.Data;
+    }
+
+    namespace AccountNoticeUpdatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.AccountNotice;
+
+        previous_attributes?: Partial<Stripe.AccountNotice>;
+      }
+    }
+
     /**
      * Occurs whenever an application fee is created on a charge.
      */
@@ -417,6 +477,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Notifies of errors on a billing meter
+     */
+    interface BillingMeterErrorReportTriggeredEvent extends EventBase {
+      type: 'billing.meter_error_report.triggered';
+      data: BillingMeterErrorReportTriggeredEvent.Data;
+    }
+
+    namespace BillingMeterErrorReportTriggeredEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Billing.MeterErrorReport;
+
+        previous_attributes?: Partial<Stripe.Billing.MeterErrorReport>;
+      }
+    }
+
     /**
      * Occurs whenever a portal configuration is created.
      */
@@ -481,6 +557,150 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever a connected account accepts a financing offer.
+     */
+    interface CapitalFinancingOfferAcceptedEvent extends EventBase {
+      type: 'capital.financing_offer.accepted';
+      data: CapitalFinancingOfferAcceptedEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferAcceptedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a financing offer is canceled.
+     */
+    interface CapitalFinancingOfferCanceledEvent extends EventBase {
+      type: 'capital.financing_offer.canceled';
+      data: CapitalFinancingOfferCanceledEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferCanceledEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a new financing offer is created for a connected account.
+     */
+    interface CapitalFinancingOfferCreatedEvent extends EventBase {
+      type: 'capital.financing_offer.created';
+      data: CapitalFinancingOfferCreatedEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferCreatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a financing offer expires.
+     */
+    interface CapitalFinancingOfferExpiredEvent extends EventBase {
+      type: 'capital.financing_offer.expired';
+      data: CapitalFinancingOfferExpiredEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferExpiredEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a financing offer is fully repaid.
+     */
+    interface CapitalFinancingOfferFullyRepaidEvent extends EventBase {
+      type: 'capital.financing_offer.fully_repaid';
+      data: CapitalFinancingOfferFullyRepaidEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferFullyRepaidEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a financing offer is paid out.
+     */
+    interface CapitalFinancingOfferPaidOutEvent extends EventBase {
+      type: 'capital.financing_offer.paid_out';
+      data: CapitalFinancingOfferPaidOutEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferPaidOutEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a financing offer is rejected.
+     */
+    interface CapitalFinancingOfferRejectedEvent extends EventBase {
+      type: 'capital.financing_offer.rejected';
+      data: CapitalFinancingOfferRejectedEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferRejectedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a replacement for a financing offer has been created.
+     */
+    interface CapitalFinancingOfferReplacementCreatedEvent extends EventBase {
+      type: 'capital.financing_offer.replacement_created';
+      data: CapitalFinancingOfferReplacementCreatedEvent.Data;
+    }
+
+    namespace CapitalFinancingOfferReplacementCreatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingOffer;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingOffer>;
+      }
+    }
+
+    /**
+     * Occurs whenever a financing transaction is created.
+     */
+    interface CapitalFinancingTransactionCreatedEvent extends EventBase {
+      type: 'capital.financing_transaction.created';
+      data: CapitalFinancingTransactionCreatedEvent.Data;
+    }
+
+    namespace CapitalFinancingTransactionCreatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Capital.FinancingTransaction;
+
+        previous_attributes?: Partial<Stripe.Capital.FinancingTransaction>;
+      }
+    }
+
     /**
      * Occurs whenever there is a positive remaining cash balance after Stripe automatically reconciles new funds into the cash balance. If you enabled manual reconciliation, this webhook will fire whenever there are new funds into the cash balance.
      */
@@ -1121,6 +1341,38 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever collection is paused on a customer's subscription. Only applies when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is paused, not when subscriptions enter `status=paused`.
+     */
+    interface CustomerSubscriptionCollectionPausedEvent extends EventBase {
+      type: 'customer.subscription.collection_paused';
+      data: CustomerSubscriptionCollectionPausedEvent.Data;
+    }
+
+    namespace CustomerSubscriptionCollectionPausedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Subscription;
+
+        previous_attributes?: Partial<Stripe.Subscription>;
+      }
+    }
+
+    /**
+     * Occurs whenever collection is resumed on a customer's subscription that is currently paused. Only applies when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed, not when subscriptions exit `status=paused`.
+     */
+    interface CustomerSubscriptionCollectionResumedEvent extends EventBase {
+      type: 'customer.subscription.collection_resumed';
+      data: CustomerSubscriptionCollectionResumedEvent.Data;
+    }
+
+    namespace CustomerSubscriptionCollectionResumedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Subscription;
+
+        previous_attributes?: Partial<Stripe.Subscription>;
+      }
+    }
+
     /**
      * Occurs whenever a customer is signed up for a new plan.
      */
@@ -1137,6 +1389,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * An ad-hoc custom event that is sent based on user configured [Automation](https://docs.stripe.com/billing/automations#send-custom-webhook-event-action).
+     */
+    interface CustomerSubscriptionCustomEventEvent extends EventBase {
+      type: 'customer.subscription.custom_event';
+      data: CustomerSubscriptionCustomEventEvent.Data;
+    }
+
+    namespace CustomerSubscriptionCustomEventEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Subscription;
+
+        previous_attributes?: Partial<Stripe.Subscription>;
+      }
+    }
+
     /**
      * Occurs whenever a customer's subscription ends.
      */
@@ -1201,6 +1469,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever a price migration failed to transition prices on a subscription.
+     */
+    interface CustomerSubscriptionPriceMigrationFailedEvent extends EventBase {
+      type: 'customer.subscription.price_migration_failed';
+      data: CustomerSubscriptionPriceMigrationFailedEvent.Data;
+    }
+
+    namespace CustomerSubscriptionPriceMigrationFailedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Subscription;
+
+        previous_attributes?: Partial<Stripe.Subscription>;
+      }
+    }
+
     /**
      * Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](https://docs.stripe.com/api/subscriptions/resume), not when [payment collection](https://docs.stripe.com/billing/subscriptions/pause) is resumed.
      */
@@ -1445,6 +1729,23 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs when an Account’s `inferred_balances_refresh` status transitions from `pending` to either `succeeded` or `failed`.
+     */
+    interface FinancialConnectionsAccountRefreshedInferredBalancesEvent
+      extends EventBase {
+      type: 'financial_connections.account.refreshed_inferred_balances';
+      data: FinancialConnectionsAccountRefreshedInferredBalancesEvent.Data;
+    }
+
+    namespace FinancialConnectionsAccountRefreshedInferredBalancesEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.FinancialConnections.Account;
+
+        previous_attributes?: Partial<Stripe.FinancialConnections.Account>;
+      }
+    }
+
     /**
      * Occurs when an Account’s `ownership_refresh` status transitions from `pending` to either `succeeded` or `failed`.
      */
@@ -1479,6 +1780,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs when a Financial Connections Session `status` transitions from `pending` to `failed`, `cancelled`, or `completed`.
+     */
+    interface FinancialConnectionsSessionUpdatedEvent extends EventBase {
+      type: 'financial_connections.session.updated';
+      data: FinancialConnectionsSessionUpdatedEvent.Data;
+    }
+
+    namespace FinancialConnectionsSessionUpdatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.FinancialConnections.Session;
+
+        previous_attributes?: Partial<Stripe.FinancialConnections.Session>;
+      }
+    }
+
     /**
      * Occurs whenever a VerificationSession is canceled
      */
@@ -1687,6 +2004,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs when an InvoicePayment transitions to paid with a non-zero amount_overpaid.
+     */
+    interface InvoicePaymentOverpaidEvent extends EventBase {
+      type: 'invoice.payment.overpaid';
+      data: InvoicePaymentOverpaidEvent.Data;
+    }
+
+    namespace InvoicePaymentOverpaidEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.InvoicePayment;
+
+        previous_attributes?: Partial<Stripe.InvoicePayment>;
+      }
+    }
+
     /**
      * Occurs whenever an invoice payment attempt requires further user action to complete.
      */
@@ -2743,6 +3076,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever a quote acceptance fails
+     */
+    interface QuoteAcceptFailedEvent extends EventBase {
+      type: 'quote.accept_failed';
+      data: QuoteAcceptFailedEvent.Data;
+    }
+
+    namespace QuoteAcceptFailedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Quote;
+
+        previous_attributes?: Partial<Stripe.Quote>;
+      }
+    }
+
     /**
      * Occurs whenever a quote is accepted.
      */
@@ -2759,6 +3108,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever a quote's status changes to accepting
+     */
+    interface QuoteAcceptingEvent extends EventBase {
+      type: 'quote.accepting';
+      data: QuoteAcceptingEvent.Data;
+    }
+
+    namespace QuoteAcceptingEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Quote;
+
+        previous_attributes?: Partial<Stripe.Quote>;
+      }
+    }
+
     /**
      * Occurs whenever a quote is canceled.
      */
@@ -2791,6 +3156,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs when a quote's status changes from stale to draft
+     */
+    interface QuoteDraftEvent extends EventBase {
+      type: 'quote.draft';
+      data: QuoteDraftEvent.Data;
+    }
+
+    namespace QuoteDraftEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Quote;
+
+        previous_attributes?: Partial<Stripe.Quote>;
+      }
+    }
+
     /**
      * Occurs whenever a quote is finalized.
      */
@@ -2807,6 +3188,54 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever a quote reestimate fails
+     */
+    interface QuoteReestimateFailedEvent extends EventBase {
+      type: 'quote.reestimate_failed';
+      data: QuoteReestimateFailedEvent.Data;
+    }
+
+    namespace QuoteReestimateFailedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Quote;
+
+        previous_attributes?: Partial<Stripe.Quote>;
+      }
+    }
+
+    /**
+     * Occurs whenever an async job to compute preview subscription schedules/upcoming invoices for the quote has completed.
+     */
+    interface QuoteReestimatedEvent extends EventBase {
+      type: 'quote.reestimated';
+      data: QuoteReestimatedEvent.Data;
+    }
+
+    namespace QuoteReestimatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Quote;
+
+        previous_attributes?: Partial<Stripe.Quote>;
+      }
+    }
+
+    /**
+     * Occurs whenever a quote's status changes to stale
+     */
+    interface QuoteStaleEvent extends EventBase {
+      type: 'quote.stale';
+      data: QuoteStaleEvent.Data;
+    }
+
+    namespace QuoteStaleEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Quote;
+
+        previous_attributes?: Partial<Stripe.Quote>;
+      }
+    }
+
     /**
      * Occurs whenever an early fraud warning is created.
      */
@@ -3239,6 +3668,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever a price migration failed to transition prices on a subscription schedule.
+     */
+    interface SubscriptionSchedulePriceMigrationFailedEvent extends EventBase {
+      type: 'subscription_schedule.price_migration_failed';
+      data: SubscriptionSchedulePriceMigrationFailedEvent.Data;
+    }
+
+    namespace SubscriptionSchedulePriceMigrationFailedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.SubscriptionSchedule;
+
+        previous_attributes?: Partial<Stripe.SubscriptionSchedule>;
+      }
+    }
+
     /**
      * Occurs whenever a new subscription schedule is released.
      */
@@ -3271,6 +3716,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs when a tax form is updated.
+     */
+    interface TaxFormUpdatedEvent extends EventBase {
+      type: 'tax.form.updated';
+      data: TaxFormUpdatedEvent.Data;
+    }
+
+    namespace TaxFormUpdatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Tax.Form;
+
+        previous_attributes?: Partial<Stripe.Tax.Form>;
+      }
+    }
+
     /**
      * Occurs whenever tax settings is updated.
      */
@@ -3351,6 +3812,22 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs whenever an action sent to a Terminal reader is updated.
+     */
+    interface TerminalReaderActionUpdatedEvent extends EventBase {
+      type: 'terminal.reader.action_updated';
+      data: TerminalReaderActionUpdatedEvent.Data;
+    }
+
+    namespace TerminalReaderActionUpdatedEvent {
+      interface Data extends Stripe.Event.Data {
+        object: Stripe.Terminal.Reader;
+
+        previous_attributes?: Partial<Stripe.Terminal.Reader>;
+      }
+    }
+
     /**
      * Occurs whenever a test clock starts advancing.
      */