Anchor to section titled 'undefined'

CustomerShopPayAgreement
object

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

Represents a Shop Pay card instrument for customer payment method.


The billing address of the card.

Whether the card is about to expire.

The expiry month of the card.

The expiry year of the card.

Whether the Shop Pay billing agreement is inactive.

The payment method can be revoked if there are no active subscription contracts.

Anchor to CustomerShopPayAgreement.lastDigits
lastDigits
Learn more about accessing protected customer data
non-null

The last 4 digits of the card.

Anchor to CustomerShopPayAgreement.maskedNumber
maskedNumber
Learn more about accessing protected customer data
non-null

The masked card number with only the last 4 digits displayed.

Anchor to CustomerShopPayAgreement.name
name
Learn more about accessing protected customer data
non-null

The name of the card holder.


Was this section helpful?
Map

Possible types in

CustomerShopPayAgreement