Retrieve a Customer
GET
/v1/customers/:id
Retrieves the customer with the given ID.
curl "https://api.lemonsqueezy.com/v1/customers/1" \
-H 'Accept: application/vnd.api+json' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer {api_key}'
Returns
Returns a Customer object.
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://api.lemonsqueezy.com/v1/customers/1"
},
"data": {
"type": "customers",
"id": "1",
"attributes": {
"store_id": 1,
"name": "John Doe",
"email": "[email protected]",
"status": "subscribed",
"city": null,
"region": null,
"country": "US",
"total_revenue_currency": 84332,
"mrr": 1999,
"status_formatted": "Subscribed",
"country_formatted": "United States",
"total_revenue_currency_formatted": "$843.32",
"mrr_formatted": "$19.99",
"urls": {
"customer_portal": "https://my-store.lemonsqueezy.com/billing?expires=1666869343&signature=82ae290ceac8edd4190c82825dd73a8743346d894a8ddbc4898b97eb96d105a5"
},
"created_at": "2022-12-01T13:01:07.000000Z",
"updated_at": "2022-12-09T09:05:21.000000Z",
"test_mode": false
},
"relationships": {
"store": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/customers/1/store",
"self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/store"
}
},
"orders": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/customers/1/orders",
"self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/orders"
}
},
"subscriptions": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/customers/1/subscriptions",
"self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/subscriptions"
}
},
"license-keys": {
"links": {
"related": "https://api.lemonsqueezy.com/v1/customers/1/license-keys",
"self": "https://api.lemonsqueezy.com/v1/customers/1/relationships/license-keys"
}
}
},
"links": {
"self": "https://api.lemonsqueezy.com/v1/customers/1"
}
}
}