Skip to main content

setupSharedPaymentMethod

Begins vaulting a card for off-session auto-billing. Returns a Stripe SetupIntent client secret the browser confirms; no charge is made here. Requires the 'manage_billing' org permission.

setupSharedPaymentMethod(
  orgId: BigInt!
  idempotencyKey: String
): PaymentMethodSetup!

Arguments​

setupSharedPaymentMethod.orgId ● BigInt! non-null scalar​

Organization id (BigInt) to vault a payment method for.

setupSharedPaymentMethod.idempotencyKey ● String scalar​

Optional idempotency key. Recommended for retries: replaying with the same key and identical arguments returns the first result instead of re-applying; the same key with different arguments returns IDEMPOTENCY_CONFLICT. Keys expire after 24h.

Type​

PaymentMethodSetup object​

Stripe SetupIntent handle the browser uses to vault a card for auto-billing.