βΊοΈCustomers
Fetches payment methods associated with a given customer, including credit cards and Shop Pay agreements.
Query parameters
customerIdstringRequired
The unique identifier of the customer whose payment methods are being retrieved.
Responses
200
Successfully retrieved the customer's payment methods.
application/json
400
Bad request, such as missing customer ID or invalid query parameters.
application/json
get
GET /payment-methods/customer-payment-methods HTTP/1.1
Host: localhost:3002
Accept: */*
{
"customer": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text",
"phone": "text",
"displayName": "text",
"state": "text",
"image": {
"url": "text",
"id": "text"
},
"subscriptionContracts": [
{
"id": "text",
"status": "text",
"customerPaymentMethod": {
"id": "text"
}
}
],
"paymentMethods": [
{
"id": "text",
"revokedAt": "2025-06-23T05:54:38.384Z",
"revokedReason": "text",
"instrument": {
"__typename": "text",
"billingAddress": {
"address1": "text",
"city": "text",
"country": "text",
"countryCode": "text",
"province": "text",
"provinceCode": "text",
"zip": "text"
},
"brand": "text",
"expiresSoon": true,
"expiryMonth": 1,
"expiryYear": 1,
"isRevocable": true,
"lastDigits": "text",
"name": "text",
"maskedNumber": "text",
"firstDigits": "text",
"virtualLastDigits": "text",
"source": "text"
}
}
]
}
}
Deletes a specific customer payment method by its ID.
Path parameters
paymentMethodIdstringRequired
The unique identifier of the payment method to be deleted.
Responses
200
Successfully deleted the payment method.
application/json
400
Bad request, such as when the payment method ID is invalid or the deletion process encounters an error.
application/json
delete
DELETE /payment-methods/{paymentMethodId} HTTP/1.1
Host: localhost:3002
Accept: */*
{
"revokedCustomerPaymentMethodId": "text",
"userErrors": [
{
"field": "text",
"message": "text"
}
]
}
Last updated
Was this helpful?