Customer Payment Method
Requires access scope. Also: Requires scope.
Anchor to FieldsFields
- Anchor to customercustomer•Customer
The customer to whom the payment method belongs.
- •ID!non-null
The ID of this payment method.
- Anchor to instrumentinstrument•Customer
Payment Instrument The instrument for this payment method.
- Anchor to mandatesmandates•Payment
Mandate Resource Connection! non-null The mandates associated with the payment method.
- Anchor to revokedAtrevoked•Date
At Time The time that the payment method was revoked.
- Anchor to revokedReasonrevoked•Customer
Reason Payment Method Revocation Reason The revocation reason for this payment method.
- Anchor to subscriptionContractssubscription•Subscription
Contracts Contract Connection! non-null List Subscription Contracts.
Anchor to QueriesQueries
- •query
Returns a CustomerPaymentMethod resource by its ID.
Anchor to MutationsMutations
- •mutation
Creates a credit card payment method for a customer using a session id. These values are only obtained through card imports happening from a PCI compliant environment. Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.
- •mutation
Updates the credit card payment method for a customer.
- Anchor to customerPaymentMethodPaypalBillingAgreementCreatecustomer•mutation
Payment Method Paypal Billing Agreement Create Creates a PayPal billing agreement for a customer.
- Anchor to customerPaymentMethodPaypalBillingAgreementUpdatecustomer•mutation
Payment Method Paypal Billing Agreement Update Updates a PayPal billing agreement for a customer.
- •mutation
Creates a customer payment method using identifiers from remote payment gateways like Stripe, Authorize.Net, or Braintree. Imports existing payment methods from external gateways and associates them with
Customerobjects in Shopify.The operation processes payment methods asynchronously. The returned
initially has incomplete details while Shopify validates and processes the remote gateway information. Use thequery to retrieve the payment method status until all details are available or the payment method is revoked.Learn more about migrating customer payment methods from remote gateways.