Skip to main content

removeSharedPaymentMethod

Removes a saved (vaulted) off-session payment method from the org; returns true on success. If it was the method backing auto-billing, recharges will fail until another is set up. Requires the 'manage_billing' org permission.

removeSharedPaymentMethod(
  orgId: BigInt!
  paymentMethodId: BigInt!
  idempotencyKey: String
): Boolean!

Arguments​

removeSharedPaymentMethod.orgId ● BigInt! non-null scalar​

Organization id (BigInt) that owns the payment method.

removeSharedPaymentMethod.paymentMethodId ● BigInt! non-null scalar​

Id (BigInt) of the saved payment method to remove (see orgPaymentMethods).

removeSharedPaymentMethod.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​

Boolean scalar​

The Boolean scalar type represents true or false.