Choose a version:

customerPaymentMethodRemoteCreditCardCreate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Deprecated. This will be removed in 2025-01. Use customerPaymentMethodRemoteCreate instead.

Create a payment method from a credit card stored by Stripe.

Arguments

Anchor to customerIdcustomerId •ID! required: The ID of the customer.
Anchor to stripeCustomerIdstripeCustomerId •String! required: The Stripe Customer ID.
Anchor to stripePaymentMethodIdstripePaymentMethodId •String: The Stripe Payment Method ID. Starting on 2025, stripe_payment_method_id will become mandatory for all API versions.

Was this section helpful?

Anchor to CustomerPaymentMethodRemoteCreditCardCreatePayload returnsCustomerPaymentMethodRemoteCreditCardCreatePayload returns

Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: The customer payment method.
Anchor to userErrorsuserErrors •[CustomerPaymentMethodUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation customerPaymentMethodRemoteCreditCardCreate($customerId: ID!, $stripeCustomerId: String!, $stripePaymentMethodId: String) {

customerPaymentMethodRemoteCreditCardCreate(customerId: $customerId, stripeCustomerId: $stripeCustomerId, stripePaymentMethodId: $stripePaymentMethodId) {

customerPaymentMethod {

# CustomerPaymentMethod fields

}

userErrors {

field

message

}

Input

{

"customerId": "gid://shopify/<objectName>/10079785100",

"stripeCustomerId": "<your-stripeCustomerId>",

"stripePaymentMethodId": "<your-stripePaymentMethodId>"

}

{
  "customerId": "gid://shopify/<objectName>/10079785100",
  "stripeCustomerId": "<your-stripeCustomerId>",
  "stripePaymentMethodId": "<your-stripePaymentMethodId>"
}