Skip to main content

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Choose a version:

PaymentInstrument

union

Requires read_payment_mandate access scope.

All possible instrument outputs for Payment Mandates.

Anchor to Possible typesPossible types

VaultCreditCard

•

OBJECT

Represents a credit card payment instrument.

billingAddress• CustomerCreditCardBillingAddress: The billing address of the card.
brand• String! non-null: The brand for the card.
expired• Boolean! non-null: Whether the card has been expired.
expiryMonth• Int! non-null: The expiry month of the card.
expiryYear• Int! non-null: The expiry year of the card.
lastDigits• String! non-null: The last four digits for the card.
name• String! non-null: The name of the card holder.

VaultPaypalBillingAgreement

•

OBJECT

Represents a paypal billing agreement payment instrument.

inactive• Boolean! non-null: Whether the paypal billing agreement is inactive.
name• String! non-null: The paypal account name.
paypalAccountEmail• String! non-null: The paypal account email address.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to PaymentMandate.paymentInstrument PaymentMandate.paymentInstrument • OBJECT: The outputs details of the payment instrument.

Was this section helpful?