StripeExtensions Methods
Class Methods 5 members
Extension methods for adding Stripe CLI to a
Hosting.IDistributedApplicationBuilder. AddStripe(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>) Section titled AddStripe(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>) extension IResourceBuilder<StripeResource> Adds the Stripe CLI to the application model for local webhook forwarding.
public static class StripeExtensions{ public static IResourceBuilder<StripeResource> AddStripe( this IDistributedApplicationBuilder builder, string name, IResourceBuilder<ParameterResource> apiKey) { // ... }}Parameters
builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to add the resource to. name string The name of the resource. apiKey IResourceBuilder<ParameterResource> The parameter builder providing the Stripe API key. Returns
IResourceBuilder<StripeResource> A reference to the ApplicationModel.IResourceBuilder`1. WithApiKey(IResourceBuilder<StripeResource>, IResourceBuilder<ParameterResource>) Section titled WithApiKey(IResourceBuilder<StripeResource>, IResourceBuilder<ParameterResource>) extension IResourceBuilder<StripeResource> Configures the Stripe CLI to use a specific API key from a parameter.
public static class StripeExtensions{ public static IResourceBuilder<StripeResource> WithApiKey( this IResourceBuilder<StripeResource> builder, IResourceBuilder<ParameterResource> apiKey) { // ... }}Parameters
builder IResourceBuilder<StripeResource> The resource builder. apiKey IResourceBuilder<ParameterResource> The parameter containing the Stripe API key to use. Returns
IResourceBuilder<StripeResource> A reference to the ApplicationModel.IResourceBuilder`1. WithListen(IResourceBuilder<StripeResource>, IResourceBuilder<IResourceWithEndpoints>, string, IEnumerable<string>) Section titled WithListen(IResourceBuilder<StripeResource>, IResourceBuilder<IResourceWithEndpoints>, string, IEnumerable<string>) extension IResourceBuilder<StripeResource> Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.
public static class StripeExtensions{ public static IResourceBuilder<StripeResource> WithListen( this IResourceBuilder<StripeResource> builder, IResourceBuilder<IResourceWithEndpoints> forwardTo, string webhookPath = "/webhooks/stripe", IEnumerable<string>? events = null) { // ... }}Parameters
builder IResourceBuilder<StripeResource> The resource builder. forwardTo IResourceBuilder<IResourceWithEndpoints> The resource to forward webhooks to. webhookPath string optional The path to the webhook endpoint. events IEnumerable<string> optional Optional collection of specific webhook events to listen for (e.g., ["payment_intent.created", "charge.succeeded"]). If not specified, all events are forwarded. Returns
IResourceBuilder<StripeResource> A reference to the ApplicationModel.IResourceBuilder`1. WithListen(IResourceBuilder<StripeResource>, IResourceBuilder<ExternalServiceResource>, string, IEnumerable<string>) Section titled WithListen(IResourceBuilder<StripeResource>, IResourceBuilder<ExternalServiceResource>, string, IEnumerable<string>) extension IResourceBuilder<StripeResource> Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.
public static class StripeExtensions{ public static IResourceBuilder<StripeResource> WithListen( this IResourceBuilder<StripeResource> builder, IResourceBuilder<ExternalServiceResource> forwardTo, string webhookPath = "/webhooks/stripe", IEnumerable<string>? events = null) { // ... }}Parameters
builder IResourceBuilder<StripeResource> The resource builder. forwardTo IResourceBuilder<ExternalServiceResource> The resource to forward webhooks to. webhookPath string optional The path to the webhook endpoint. events IEnumerable<string> optional Optional collection of specific webhook events to listen for (e.g., ["payment_intent.created", "charge.succeeded"]). If not specified, all events are forwarded. Returns
IResourceBuilder<StripeResource> A reference to the ApplicationModel.IResourceBuilder`1. WithReference(IResourceBuilder<TDestination>, IResourceBuilder<StripeResource>, string) Section titled WithReference(IResourceBuilder<TDestination>, IResourceBuilder<StripeResource>, string) extension IResourceBuilder<TDestination> Adds a reference to a Stripe CLI resource for accessing its webhook signing secret.
public static class StripeExtensions{ public static IResourceBuilder<TDestination> WithReference<TDestination>( this IResourceBuilder<TDestination> builder, IResourceBuilder<StripeResource> source, string webhookSigningSecretEnvVarName = "STRIPE_WEBHOOK_SECRET") { // ... }}Parameters
builder IResourceBuilder<TDestination> The resource builder. source IResourceBuilder<StripeResource> The Stripe CLI resource to reference. webhookSigningSecretEnvVarName string optional Optional environment variable name to use for the webhook signing secret. Defaults to "STRIPE_WEBHOOK_SECRET". Returns
IResourceBuilder<TDestination> A reference to the ApplicationModel.IResourceBuilder`1.