Choose a version:

CustomerPaymentInstrument

union

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

All possible instruments for CustomerPaymentMethods.

Anchor to Possible typesPossible types

•OBJECT

Represents a card instrument for customer payment method.

Anchor to billingAddressbillingAddress •CustomerCreditCardBillingAddress: The billing address of the card.
Anchor to brandbrand •String! non-null: The brand of the card.
Anchor to expiresSoonexpiresSoon •Boolean! non-null: Whether the card is about to expire.
Anchor to expiryMonthexpiryMonth •Int! non-null: The expiry month of the card.
Anchor to expiryYearexpiryYear •Int! non-null: The expiry year of the card.
Anchor to firstDigitsfirstDigits •String: The card's BIN number.
Anchor to isRevocableisRevocable •Boolean! non-null: The payment method can be revoked if there are no active subscription contracts.
Anchor to lastDigitslastDigits •String! non-null: The last 4 digits of the card.
Anchor to maskedNumbermaskedNumber •String! non-null: The masked card number with only the last 4 digits displayed.
Anchor to namename •String! non-null: The name of the card holder.
Anchor to sourcesource •String: The source of the card if coming from a wallet such as Apple Pay.
Anchor to virtualLastDigitsvirtualLastDigits •String: The last 4 digits of the Device Account Number.

•OBJECT

Represents a PayPal instrument for customer payment method.

Anchor to billingAddressbillingAddress •CustomerPaymentInstrumentBillingAddress: The billing address of this payment method.
Anchor to inactiveinactive •Boolean! non-null: Whether the PayPal billing agreement is inactive.
Anchor to isRevocableisRevocable •Boolean! non-null: Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts.
Anchor to paypalAccountEmailpaypalAccountEmail •String: The customers's PayPal account email address.

•OBJECT

Represents a Shop Pay card instrument for customer payment method.

Anchor to billingAddressbillingAddress •CustomerCreditCardBillingAddress: The billing address of the card.
Anchor to expiresSoonexpiresSoon •Boolean! non-null: Whether the card is about to expire.
Anchor to expiryMonthexpiryMonth •Int! non-null: The expiry month of the card.
Anchor to expiryYearexpiryYear •Int! non-null: The expiry year of the card.
Anchor to inactiveinactive •Boolean! non-null: Whether the Shop Pay billing agreement is inactive.
Anchor to isRevocableisRevocable •Boolean! non-null: The payment method can be revoked if there are no active subscription contracts.
Anchor to lastDigitslastDigits •String! non-null: The last 4 digits of the card.
Anchor to maskedNumbermaskedNumber •String! non-null: The masked card number with only the last 4 digits displayed.
Anchor to namename •String! non-null: The name of the card holder.

Was this section helpful?

Anchor to CustomerPaymentMethod.instrument CustomerPaymentMethod.instrument •OBJECT: A customer's payment method.

Was this section helpful?