Trigger

trigger Trigger example webhook events to conduct local testing. These test webhook events are based on real API objects and may trigger other webhook events as part of the test (for example, triggering payment_intent.succeeded also triggers payment_intent.created). The event types documentation includes a complete list of webhook events and when they would be triggered. > Events are triggered by issuing HTTP requests against the Stripe API. Because of this, triggering events causes side effects: all necessary API objects will be created in the process. Command: stripe trigger ### Arguments - `

The webhook events we currently support are listed below (or usingstripe help trigger): - account.application.deauthorizedOccurs whenever a user deauthorizes an application. Sent to the related application only. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-account.application.deauthorized). -account.updatedOccurs whenever an account status or property has changed. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-account.updated). -balance.availableOccurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis. This event is not fired for negative transactions. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-balance.available). -charge.capturedOccurs whenever a previously uncaptured charge is captured. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-charge.captured). -charge.dispute.createdOccurs whenever a customer disputes a charge with their bank. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-charge.dispute.created). -charge.failedOccurs whenever a failed charge attempt occurs. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-charge.failed). -charge.refundedOccurs whenever a charge is refunded, including partial refunds. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-charge.refunded). -charge.refund.updatedOccurs whenever a refund is updated, on selected payment methods. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-charge.refund.updated). -charge.succeededOccurs whenever a new charge is created and is successful. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-charge.succeeded). -checkout.session.async_payment_failedOccurs when a payment intent using a delayed payment method fails. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-checkout.session.async_payment_failed). -checkout.session.async_payment_succeededOccurs when a payment intent using a delayed payment method finally succeeds. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-checkout.session.async_payment_succeeded). -checkout.session.completedOccurs when a Checkout Session has been successfully completed. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-checkout.session.completed). -customer.createdOccurs whenever a new customer is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.created). -customer.deletedOccurs whenever a customer is deleted. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.deleted). -customer.source.createdOccurs whenever a new source is created for a customer. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.source.created). -customer.source.updatedOccurs whenever a source's details are changed. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.source.updated). -customer.subscription.createdOccurs whenever a customer is signed up for a new plan. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.subscription.created). -customer.subscription.deletedOccurs whenever a customer's subscription ends. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.subscription.deleted). -customer.subscription.updatedOccurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active). Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.subscription.updated). -customer.updatedOccurs whenever any property of a customer changes. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-customer.updated). -invoice.createdOccurs whenever a new invoice is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.created). -invoice.finalizedOccurs whenever a draft invoice is finalized and updated to be an open invoice. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.finalized). -invoice.paidOccurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.paid). -invoice.payment_action_requiredOccurs whenever an invoice payment attempt requires further user action to complete. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.payment_action_required). -invoice.payment_failedOccurs whenever an invoice payment attempt fails, due either to a declined payment or to the lack of a stored payment method. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.payment_failed). -invoice.payment_succeededOccurs whenever an invoice payment attempt succeeds. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.payment_succeeded). -invoice.updatedOccurs whenever an invoice changes (e.g., the invoice amount). Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-invoice.updated). -issuing_authorization.requestRepresents a synchronous request for authorization. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-issuing_authorization.request). -issuing_card.createdOccurs whenever a card is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-issuing_card.created). -issuing_cardholder.createdOccurs whenever a cardholder is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-issuing_cardholder.created). -payment_intent.amount_capturable_updatedOccurs when a PaymentIntent has funds to be captured. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.amount_capturable_updated). -payment_intent.canceledOccurs when a PaymentIntent is canceled. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.canceled). -payment_intent.createdOccurs when a new PaymentIntent is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.created). -payment_intent.partially_fundedOccurs when funds are applied to a customer_balance PaymentIntent and theamount_remainingchanges. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.partially_funded). -payment_intent.payment_failedOccurs when a PaymentIntent has failed the attempt to create a payment method or a payment. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.payment_failed). -payment_intent.requires_actionOccurs when a PaymentIntent transitions to requires_action state. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.requires_action). -payment_intent.succeededOccurs when a PaymentIntent has successfully completed payment. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_intent.succeeded). -payment_link.createdOccurs when a payment link is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_link.created). -payment_link.updatedOccurs when a payment link is updated. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_link.updated). -payment_method.attachedOccurs whenever a new payment method is attached to a customer. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_method.attached). -payment_method.detachedOccurs whenever a new payment method is detached from a customer. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payment_method.detached). -payout.createdOccurs whenever a payout is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payout.created). -payout.updatedOccurs whenever a payout is updated. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-payout.updated). -plan.createdOccurs whenever a plan is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-plan.created). -plan.deletedOccurs whenever a plan is deleted. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-plan.deleted). -plan.updatedOccurs whenever a plan is updated. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-plan.updated). -price.createdOccurs whenever a price is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-price.created). -price.updatedOccurs whenever a price is updated. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-price.updated). -product.createdOccurs whenever a product is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-product.created). -product.deletedOccurs whenever a product is deleted. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-product.deleted). -product.updatedOccurs whenever a product is updated. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-product.updated). -quote.acceptedOccurs whenever a quote is accepted. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-quote.accepted). -quote.canceledOccurs whenever a quote is canceled. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-quote.canceled). -quote.createdOccurs whenever a quote is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-quote.created). -quote.finalizedOccurs whenever a quote is finalized. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-quote.finalized). -reporting.report_run.succeededOccurs whenever a requestedReportRuncompleted successfully. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-reporting.report_run.succeeded). -setup_intent.canceledOccurs when a SetupIntent is canceled. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-setup_intent.canceled). -setup_intent.createdOccurs when a new SetupIntent is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-setup_intent.created). -setup_intent.setup_failedOccurs when a SetupIntent has failed the attempt to setup a payment method. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-setup_intent.setup_failed). -setup_intent.succeededOccurs when an SetupIntent has successfully setup a payment method. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-setup_intent.succeeded). -subscription_schedule.canceledOccurs whenever a subscription schedule is canceled. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-subscription_schedule.canceled). -subscription_schedule.createdOccurs whenever a subscription schedule is created. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-subscription_schedule.created). -subscription_schedule.releasedOccurs whenever a subscription schedule is released. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-subscription_schedule.released). -subscription_schedule.updatedOccurs whenever a subscription schedule is updated. Read more in our [API documentation](https://docs.stripe.com/api/events/types.md#event_types-subscription_schedule.updated). ### Flags ---stripe-accountSet a header identifying the connected account. ---override [resource]:[path1].[path2]=[value]Override the param atpath1.path2for theresource. Example: --override plan:product.name=overrideName. To index into an array, use bracket notation: --override "checkout_session:line_items[0].quantity=10". In some shells, you may need to wrap the value in quotes to prevent shell interpretation of special characters like brackets. - --add [resource]:[path1].[path2]=[value]Add the parampath1.path2to theresource. Example: --add payment_intent:customer=customerId---remove [resource]:[path1].[path2]Remove the param atpath1.path2from theresource. Example: --remove customer:description---skip [param]Skip specific steps in the trigger. Example:--skip cus_jenny_rosen---editEdit the fixture directly in your default IDE before triggering. Cannot be used with--add, --remove, --override, or --skip`. ### Examples Triggering an event sh stripe trigger invoice.payment_succeeded Setting up fixture for: customer Setting up fixture for: invoiceitem Setting up fixture for: invoice Setting up fixture for: invoice_pay Trigger succeeded! Check dashboard for event details. Listing supported events sh stripe trigger --help Supported events: balance.available charge.captured charge.dispute.created charge.failed charge.refunded charge.succeeded ...