Choose a version:

customerPaymentMethod

query

Returns a vaulted customer payment method by its ID, including the instrument type (credit card, PayPal, etc.), billing address, and current status. Optionally includes revoked payment methods. Use this to look up a specific saved payment method for a customer — for example, to check whether a subscription's payment method is still valid or to display stored payment details.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the CustomerPaymentMethod to return.
Anchor to showRevokedshowRevoked •Boolean Default:false: Whether to show the customer's revoked payment method.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CustomerPaymentMethodCustomerPaymentMethod

•CustomerPaymentMethod

A customer's saved payment method. Stores the payment instrument details and billing information for recurring charges.

The payment method supports types included in the CustomerPaymentInstrument union.

Anchor to customercustomer

•Customer

The customer to whom the payment method belongs.

Anchor to idid

•ID!

non-null

The ID of this payment method.

Anchor to instrumentinstrument

•CustomerPaymentInstrument

The instrument for this payment method.

Anchor to mandatesmandates

•PaymentMandateResourceConnection!

non-null

The mandates associated with the payment method.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to revokedAtrevokedAt

•DateTime

The time that the payment method was revoked.

Anchor to revokedReasonrevokedReason

•CustomerPaymentMethodRevocationReason

The revocation reason for this payment method.

Anchor to subscriptionContractssubscriptionContracts

•SubscriptionContractConnection!

non-null

List Subscription Contracts.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Was this section helpful?