API Reference

Customer

Customer entity allows you fetch information about the customer and take customer level actions such as send login link to the customer.

Customer object

{
  "success": true,
  "message": "Customer fetched successfully",
  "data": {
    "id": 89120455,
    "customerShopifyId": 9123847563891,
    "firstName": "Emily",
    "lastName": "Carter",
    "fullName": "Emily Carter",
    "email": "[email protected]",
    "activeSubscriptions": 3,
    "pausedSubscriptions": 0,
    "cancelledSubscriptions": 2,
    "expiredSubscriptions": 1,
    "paymentMethods": [
      {
        "id": 6012930,
        "type": "CustomerCreditCard",
        "card": {
          "brand": "visa",
          "expiryYear": 27,
          "expiryMonth": 9,
          "lastDigits": "4242"
        },
        "payPal": null,
        "status": "safe",
        "source": "Credit card (Stripe)"
      },
      {
        "id": 6012931,
        "type": "CustomerCreditCard",
        "card": {
          "brand": "mastercard",
          "expiryYear": 26,
          "expiryMonth": 12,
          "lastDigits": "5555"
        },
        "payPal": null,
        "status": "safe",
        "source": "Credit card (Shopify Payments)"
      }
    ],
    "addresses": [
      {
        "id": 3100192,
        "firstName": "Emily",
        "lastName": "Carter",
        "company": "Greenleaf Organics",
        "address1": "742 Evergreen Terrace",
        "address2": null,
        "city": "Springfield",
        "province": "Illinois",
        "country": "United States",
        "zip": "62704",
        "phone": "2175551234",
        "provinceCode": "IL",
        "countryCode": "US",
        "isDefault": true
      },
      {
        "id": 3100194,
        "firstName": "Emily",
        "lastName": "Carter",
        "company": null,
        "address1": "1 Market Street",
        "address2": "Suite 500",
        "city": "San Francisco",
        "province": "California",
        "country": "United States",
        "zip": "94105",
        "phone": "4155556789",
        "provinceCode": "CA",
        "countryCode": "US",
        "isDefault": false
      }
    ]
  },
  "code": "SUCCESS",
  "pageInfo": null
}