docs

Get customer by external ID

Retrieves a customer by the `externalId` you gave it, such as the user ID in your system. Same response as `GET /customers/:id`.

GET
/customers/external/{externalId}

Retrieves a customer by the externalId you gave it, such as the user ID in your system. Same response as GET /customers/:id.

AuthorizationBearer <token>

API key for merchant integrations. Send as Authorization: Bearer <your key>.

In: header

Path Parameters

externalId*string

Your own ID for the customer

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/customers/external/string"
{  "id": "cus_abc123xyz",  "object": "customer",  "type": "registered",  "createdAt": "string",  "updatedAt": "string",  "name": "string",  "email": "string",  "phone": "string",  "address": {    "line1": "string",    "line2": "string",    "city": "string",    "state": "string",    "postalCode": "string",    "country": "string",    "property1": null,    "property2": null  },  "externalId": "user_8412",  "locale": "ar",  "taxIds": [    {      "type": "eg_tin",      "value": "string"    }  ],  "currency": "EGP",  "balance": -5000,  "guestFingerprint": {    "emails": [      "string"    ],    "phones": [      "string"    ],    "cardFingerprints": [      {}    ]  },  "metadata": {    "property1": null,    "property2": null  },  "merchantId": "string"}