☺️Customers

Retrieve Customer Payment Methods

Fetches payment methods associated with a given customer, including credit cards and Shop Pay agreements.

GEThttp://localhost:3002/payment-methods/customer-payment-methods

Query parameters

Response

200400

Successfully retrieved the customer's payment methods.

Body

application/json

customerobject

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/payment-methods/customer-payment-methods?customerId=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "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": "2024-09-19T21:47:50.375Z",
        "revokedReason": "text",
        "instrument": {
          "__typename": "text",
          "billingAddress": {
            "address1": "text",
            "city": "text",
            "country": "text",
            "countryCode": "text",
            "province": "text",
            "provinceCode": "text",
            "zip": "text"
          },
          "brand": "text",
          "expiresSoon": false,
          "isRevocable": false,
          "lastDigits": "text",
          "name": "text",
          "maskedNumber": "text",
          "firstDigits": "text",
          "virtualLastDigits": "text",
          "source": "text"
        }
      }
    ]
  }
}

Delete a Customer Payment Method

Deletes a specific customer payment method by its ID.

DELETEhttp://localhost:3002/payment-methods/{paymentMethodId}

Path parameters

paymentMethodId*string

The unique identifier of the payment method to be deleted.

Response

200400

Successfully deleted the payment method.

Body

application/json

revokedCustomerPaymentMethodIdstring

The ID of the revoked payment method.

userErrorsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/payment-methods/{paymentMethodId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "revokedCustomerPaymentMethodId": "text",
  "userErrors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}