Stripe.Payment Methods reference

ApplePayDomain

Source: src/Stripe/ApplePayDomain.ts

A Stripe Apple Pay Domain — a hostname registered so Apple Pay can be offered on that origin. Existence-only: there is nothing to update in place; changing domainName replaces the registration. Destroy deletes it.

Apple Pay domains have no metadata. Account-wide list() (nuke) enumerates every domain on the account.

In test mode, Stripe does not require the Apple domain-association file. Live mode requires /.well-known/apple-developer-merchantid-domain-association on the hostname before registration succeeds.

ApplePayDomain: Registering a Domain

const pay = yield* Stripe.ApplePayDomain("checkout", {
  domainName: "pay.example.com",
});

ApplePayDomain: Replacing a Domain

const pay = yield* Stripe.ApplePayDomain("checkout", {
  domainName: "checkout.example.com",
});

ApplePayDomain: Deleting a Domain

// stack.destroy() / resource removal deletes the Apple Pay domain
const pay = yield* Stripe.ApplePayDomain("checkout", {
  domainName: "pay.example.com",
});

PaymentMethodConfiguration

Source: src/Stripe/PaymentMethodConfiguration.ts

A Stripe Payment Method Configuration — which payment methods Checkout, PaymentIntents, and SetupIntents show when payment method types are not set explicitly. name and per-method displayPreference update in place. parent is create-only and changing it replaces the configuration.

Payment method configurations have no metadata field and cannot be hard-deleted. Destroying this resource deactivates it (active: false). Identity is the Stripe id plus the unique name.

PaymentMethodConfiguration: Creating a Configuration

Named checkout configuration

const checkout = yield* Stripe.PaymentMethodConfiguration("checkout", {
  name: "Checkout",
  card: { displayPreference: { preference: "on" } },
  link: { displayPreference: { preference: "on" } },
});

Cards only

const cards = yield* Stripe.PaymentMethodConfiguration("cards", {
  name: "Cards only",
  card: { displayPreference: { preference: "on" } },
  link: { displayPreference: { preference: "off" } },
  applePay: { displayPreference: { preference: "off" } },
  googlePay: { displayPreference: { preference: "off" } },
});

PaymentMethodConfiguration: Updating a Configuration

const checkout = yield* Stripe.PaymentMethodConfiguration("checkout", {
  name: "Checkout (updated)",
  card: { displayPreference: { preference: "on" } },
  usBankAccount: { displayPreference: { preference: "on" } },
});

PaymentMethodConfiguration: Deactivating a Configuration

// stack.destroy() / resource removal sets active: false
const checkout = yield* Stripe.PaymentMethodConfiguration("checkout", {
  name: "Checkout",
});

PaymentMethodDomain

Source: src/Stripe/PaymentMethodDomain.ts

A Stripe Payment Method Domain — a web domain registered so Stripe Elements and Embedded Checkout can show domain-gated payment methods (Apple Pay, Google Pay, Link, PayPal, Klarna, Amazon Pay). enabled updates in place. domainName is create-only and changing it replaces the domain.

Payment method domains have no metadata field and cannot be hard-deleted. Destroying this resource disables it (enabled: false). Disabled domains still occupy their domainName, so a later deploy with the same name re-enables the existing domain.

PaymentMethodDomain: Creating a Domain

Generated domain name

const domain = yield* Stripe.PaymentMethodDomain("checkout");

Named domain

const domain = yield* Stripe.PaymentMethodDomain("checkout", {
  domainName: "checkout.example.com",
});

PaymentMethodDomain: Updating a Domain

const domain = yield* Stripe.PaymentMethodDomain("checkout", {
  domainName: "checkout.example.com",
  enabled: false,
});

PaymentMethodDomain: Deactivating a Domain

// stack.destroy() / resource removal sets enabled: false
const domain = yield* Stripe.PaymentMethodDomain("checkout", {
  domainName: "checkout.example.com",
});

RetrieveApplePayDomain

Source: src/Stripe/RetrieveApplePayDomain.ts

Retrieve a bound Stripe Apple Pay Domain over HTTP.

RetrieveApplePayDomain: Reading an Apple Pay Domain

const retrieve = yield* Stripe.RetrieveApplePayDomain(pay);
const live = yield* retrieve();

RetrieveApplePayDomainHttp

Source: src/Stripe/RetrieveApplePayDomainHttp.ts Kind: Layer · Provides: Stripe.RetrieveApplePayDomain

HTTP implementation of RetrieveApplePayDomain. Provide it on the Function or Worker Effect.

RetrievePaymentMethodConfiguration

Source: src/Stripe/RetrievePaymentMethodConfiguration.ts

Retrieve a bound Stripe Payment Method Configuration over HTTP.

RetrievePaymentMethodConfiguration: Reading a Payment Method Configuration

const retrieve = yield* Stripe.RetrievePaymentMethodConfiguration(checkout);
const live = yield* retrieve();

RetrievePaymentMethodConfigurationHttp

Source: src/Stripe/RetrievePaymentMethodConfigurationHttp.ts Kind: Layer · Provides: Stripe.RetrievePaymentMethodConfiguration

HTTP implementation of RetrievePaymentMethodConfiguration.

RetrievePaymentMethodDomain

Source: src/Stripe/RetrievePaymentMethodDomain.ts

Retrieve a bound Stripe Payment Method Domain over HTTP.

RetrievePaymentMethodDomain: Reading a Payment Method Domain

const retrieve = yield* Stripe.RetrievePaymentMethodDomain(domain);
const live = yield* retrieve();

RetrievePaymentMethodDomainHttp

Source: src/Stripe/RetrievePaymentMethodDomainHttp.ts Kind: Layer · Provides: Stripe.RetrievePaymentMethodDomain

HTTP implementation of RetrievePaymentMethodDomain.