Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

StripeResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Stripe v13.6.1

Represents a Stripe CLI container resource for local webhook forwarding and testing.

type StripeResource interface {
IComputeResource
Resource
ResourceWithArgs
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyWebhookSigningSecret*stringget · set
Gets the webhook signing secret retrieved from the Stripe CLI.
WebhookSigningSecret() (*string, error)
SetWebhookSigningSecret(value *string) StripeResource

Methods

methodWithApiKeybuilder
Configures the Stripe CLI to use a specific API key from a parameter.
WithApiKey(apiKey ParameterResource) StripeResource
apiKeyParameterResourceThe parameter containing the Stripe API key to use.
StripeResource

A reference to the IResourceBuilder.

Returns a handle; failures surface later via Err().

methodWithListenbuilder
Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.
WithListen(
forwardTo ResourceWithEndpoints,
options ...*WithListenOptions,
) StripeResource
forwardToResourceWithEndpointsThe resource to forward webhooks to.
options...*WithListenOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithListenOptions argument.

WebhookPath*stringThe path to the webhook endpoint.
Events[]stringOptional collection of specific webhook events to listen for (e.g., ["payment_intent.created", "charge.succeeded"]). If not specified, all events are forwarded.
StripeResource

A reference to the IResourceBuilder.

Returns a handle; failures surface later via Err().

Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.
WithListenExternalService(
forwardTo ExternalServiceResource,
options ...*WithListenExternalServiceOptions,
) StripeResource
forwardToExternalServiceResourceThe resource to forward webhooks to.
options...*WithListenExternalServiceOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithListenExternalServiceOptions argument.

WebhookPath*stringThe path to the webhook endpoint.
Events[]stringOptional collection of specific webhook events to listen for (e.g., ["payment_intent.created", "charge.succeeded"]). If not specified, all events are forwarded.
StripeResource

A reference to the IResourceBuilder.

Returns a handle; failures surface later via Err().