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.

billingAddress• CustomerCreditCardBillingAddress: The billing address of the card.
brand• String! non-null: The brand of the card.
expiresSoon• Boolean! non-null: Whether the card is about to expire.
expiryMonth• Int! non-null: The expiry month of the card.
expiryYear• Int! non-null: The expiry year of the card.
firstDigits• String: The card's BIN number.
isRevocable• Boolean! non-null: The payment method can be revoked if there are no active subscription contracts.
lastDigits• String! non-null: The last 4 digits of the card.
maskedNumber• String! non-null: The masked card number with only the last 4 digits displayed.
name• String! non-null: The name of the card holder.
source• String: The source of the card if coming from a wallet such as Apple Pay.
virtualLastDigits• String: The last 4 digits of the Device Account Number.

•

OBJECT

Represents a PayPal instrument for customer payment method.

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

•

OBJECT

Represents a Shop Pay card instrument for customer payment method.

billingAddress• CustomerCreditCardBillingAddress: The billing address of the card.
expiresSoon• Boolean! non-null: Whether the card is about to expire.
expiryMonth• Int! non-null: The expiry month of the card.
expiryYear• Int! non-null: The expiry year of the card.
inactive• Boolean! non-null: Whether the Shop Pay billing agreement is inactive.
isRevocable• Boolean! non-null: The payment method can be revoked if there are no active subscription contracts.
lastDigits• String! non-null: The last 4 digits of the card.
maskedNumber• String! non-null: The masked card number with only the last 4 digits displayed.
name• String! non-null: The name of the card holder.

Was this section helpful?

Anchor to CustomerPaymentMethod.instrument CustomerPaymentMethod.instrument • OBJECT: The instrument for this payment method.

Was this section helpful?