StripeResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Stripe v13.5.0

interface StripeResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  webhookSigningSecret: string;
  withApiKey(apiKey: ParameterResource): StripeResource;
  withListen(
      forwardTo: IResourceWithEndpoints,
      webhookPath?: string,
      events?: string[]): StripeResource;
  withListenExternalService(
      forwardTo: ExternalServiceResource,
      webhookPath?: string,
      events?: string[]): StripeResource;
}

5 members

Properties

propertywebhookSigningSecretstringget · set

Gets the webhook signing secret retrieved from the Stripe CLI.

Methods

methodwithApiKeybuilder

Configures the Stripe CLI to use a specific API key from a parameter.

withApiKey(apiKey: ParameterResource): StripeResource

Parameters

apiKeyParameterResource

Returns

StripeResource

methodwithListenbuilder

Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.

withListen(
    forwardTo: IResourceWithEndpoints,
    webhookPath?: string,
    events?: string[]): StripeResource

Parameters

forwardToIResourceWithEndpoints

webhookPathstringoptional= /webhooks/stripe

eventsstring[]optional

Returns

StripeResource

methodwithListenExternalServicebuilder

Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.

withListenExternalService(
    forwardTo: ExternalServiceResource,
    webhookPath?: string,
    events?: string[]): StripeResource

Parameters

forwardToExternalServiceResource

webhookPathstringoptional= /webhooks/stripe

eventsstring[]optional

Returns

StripeResource