Skip to main content
Anchor to CustomerPaymentInstrument

CustomerPaymentInstrument

union

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

All possible instruments for CustomerPaymentMethods.

Anchor to Possible typesPossible types

Anchor to BankAccountBankAccount
•OBJECT

Represents a bank account payment instrument.

Anchor to CustomerCreditCardCustomerCreditCard
•OBJECT

Represents a card instrument for customer payment method.

Anchor to CustomerPaypalBillingAgreementCustomerPaypalBillingAgreement
•OBJECT

Represents a PayPal instrument for customer payment method.

Anchor to CustomerShopPayAgreementCustomerShopPayAgreement
•OBJECT

Represents a Shop Pay card instrument for customer payment method.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to CustomerPaymentMethod.instrumentCustomerPaymentMethod.instrument
•OBJECT

A customer's saved payment method. Stores the payment instrument details and billing information for recurring charges.

The payment method supports types included in the CustomerPaymentInstrument union.

Was this section helpful?