updateStoredPaymentInstrument

Example Query

1 mutation ExampleMutation($input: UpdateStoredPaymentInstrumentInput!) {
2   customer {
3     updateStoredPaymentInstrument(input: $input) {
4       storedPaymentInstrument {
5         token
6         paymentMethodId
7         details
8       }
9       defaultStoredPaymentInstrumentToken
10       errors {
11         message
12       }
13     }
14   }
15 }

Variables

1 {
2   "input": {
3     "token": "example",
4     "setAsDefault": true,
5     "billingAddress": {
6       "firstName": "example",
7       "lastName": "example",
8       "email": "example",
9       "company": "example",
10       "address1": "example",
11       "address2": "example",
12       "city": "example",
13       "stateOrProvince": "example",
14       "stateOrProvinceCode": "example",
15       "postalCode": "example"
16     }
17   }
18 }

Example response

1 {
2   "data": {
3     "customer": {
4       "updateStoredPaymentInstrument": {
5         "storedPaymentInstrument": {
6           "token": "example",
7           "paymentMethodId": "example",
8           "details": {
9             "expires": null,
10             "issuerIdentificationNumber": null,
11             "last4": null,
12             "billingAddress": null,
13             "brand": null
14           }
15         },
16         "defaultStoredPaymentInstrumentToken": "example",
17         "errors": [
18           {
19             "message": "example"
20           }
21         ]
22       }
23     }
24   }
25 }

Update a stored payment instrument for the authenticated customer.

Arguments

inputUpdateStoredPaymentInstrumentInputRequired

Input for updating a stored payment instrument.

Returns

an optional UpdateStoredPaymentInstrumentResult

errorslist of UpdateStoredPaymentInstrumentErrors

Errors encountered while updating the stored payment instrument.

storedPaymentInstrumentStoredPaymentInstrumentOptional

The updated stored payment instrument, if successful.

defaultStoredPaymentInstrumentTokenStringOptional

Token of the customer's default stored payment instrument after the update.