Choose a version:

CustomerShopPayAgreement

object

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

Represents a Shop Pay card instrument for customer payment method.

Anchor to FieldsFields

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?