---
title: "Reads one customer."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › customer

`GET /v1/stores/{store}/customers/{customer}`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `customer:read`

## Path parameters

- `store` (`getCustomer.path.store`; string, required) — The store's id.
- `customer` (`getCustomer.path.customer`; string, required)
  - minLength 1

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/customers/<customer>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/customers/<customer>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/customers/<customer>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads one customer.

#### Example

```json
{
  "orders": {
    "items": [
      {
        "id": "string",
        "number": 0,
        "customer_id": "string",
        "currency": "string",
        "exponent": 0,
        "amount": 0,
        "discount": 0,
        "total": 0,
        "free": true,
        "fees": 0,
        "source": "string",
        "source_key": "string",
        "statements": {
          "coupon": "string",
          "customer_status": "string",
          "method": "string",
          "method_details": {
            "brand": "string",
            "last4": "string"
          },
          "refund_waiver": {
            "policy": "string",
            "accepted_at": "string"
          },
          "under_minimum": {
            "processor": "stripe",
            "minimum": 0,
            "amount": 0
          },
          "property1": true,
          "property2": true
        },
        "note": "string",
        "occurred_at": "string",
        "recorded_at": "string"
      }
    ],
    "total": 0
  },
  "subscriptions": {
    "items": [
      {
        "display_status": "string",
        "product": {
          "id": "string",
          "slug": "string",
          "path": "string",
          "url": "string",
          "title": "string",
          "category": "string",
          "deleted": true
        },
        "id": "string",
        "customer_id": "string",
        "product_id": "string",
        "plan_id": "string",
        "processor": "string",
        "external_ref": "string",
        "account_ref": "string",
        "status": "string",
        "cancel_at_period_end": true,
        "instrument_ref": "string",
        "cancel_reason": "string",
        "created_at": "string",
        "ended_at": "string"
      }
    ],
    "total": 0
  },
  "grants": {
    "items": [
      {
        "token_id": "string",
        "product": {
          "id": "string",
          "slug": "string",
          "path": "string",
          "url": "string",
          "title": "string",
          "category": "string",
          "deleted": true
        },
        "id": "string",
        "customer_id": "string",
        "product_id": "string",
        "tier_id": "string",
        "source_kind": "string",
        "source_ref": "string",
        "grant_reason": "string",
        "settlement_id": "string",
        "valid_from": "string",
        "ends_at": "string",
        "end_reason": "string",
        "status": "string",
        "revocable": true,
        "granted_by": "string",
        "occurred_at": "string",
        "recorded_at": "string"
      }
    ],
    "total": 0
  },
  "entitlements": {
    "items": [
      {
        "customer_id": "string",
        "product_id": "string",
        "tier_rank": 0,
        "expires_at": "string",
        "tier_expires_at": "string",
        "next_change_at": "string",
        "rebuilt_at": "string"
      }
    ],
    "total": 0
  },
  "reviews": {
    "items": [
      {
        "product": {
          "id": "string",
          "slug": "string",
          "path": "string",
          "url": "string",
          "title": "string",
          "category": "string",
          "deleted": true
        },
        "id": "string",
        "product_id": "string",
        "customer_id": "string",
        "order_item_id": "string",
        "rating": 0,
        "username": "string",
        "notes": "string",
        "reply": "string",
        "replied_at": "string",
        "hidden_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0
  },
  "attempts": {
    "items": [
      {
        "id": "string",
        "product_id": "string",
        "quiz_id": "string",
        "customer_id": "string",
        "attempt": 0,
        "status": "string",
        "answers": {
          "property1": {
            "answer": true,
            "correct": true,
            "weight": 0,
            "dropped": true,
            "property1": true,
            "property2": true
          },
          "property2": {
            "answer": true,
            "correct": true,
            "weight": 0,
            "dropped": true,
            "property1": true,
            "property2": true
          }
        },
        "score": 0,
        "correct": 0,
        "started_at": "string",
        "finished_at": "string"
      }
    ],
    "total": 0
  },
  "certificates": {
    "items": [
      {
        "id": "string",
        "product_id": "string",
        "certificate_id": "string",
        "customer_id": "string",
        "score": 0,
        "attempt": 0,
        "issued_at": "string",
        "revoked_at": "string"
      }
    ],
    "total": 0
  },
  "feeds": {
    "items": [
      {
        "id": "string",
        "customer_id": "string",
        "product_id": "string",
        "product": {
          "id": "string",
          "slug": "string",
          "path": "string",
          "url": "string",
          "title": "string",
          "category": "string",
          "deleted": true
        },
        "readers": 0,
        "reader_limit": 0,
        "reader_limit_set": true,
        "created_at": "string",
        "revoked_at": "string",
        "revoked_reason": "string"
      }
    ],
    "total": 0,
    "blocked": [
      {
        "product_id": "string",
        "product": {
          "id": "string",
          "slug": "string",
          "path": "string",
          "url": "string",
          "title": "string",
          "category": "string",
          "deleted": true
        },
        "blocked_at": "string"
      }
    ]
  },
  "contacts": [
    {
      "kind": "string",
      "value": "string",
      "verified_at": "string"
    }
  ],
  "totals": {
    "orders": 0,
    "spent": [
      {
        "currency": "string",
        "exponent": 0,
        "amount": 0,
        "gross": 0,
        "refunded": 0
      }
    ],
    "active_subscriptions": 0
  },
  "id": "string",
  "display_name": "string",
  "locale": "string",
  "country": "string",
  "erased_at": "string",
  "invited_at": "string",
  "created_at": "string"
}
```

- `orders` (`getCustomer.response.200.orders`; object, required)
  - `items` (`getCustomer.response.200.orders.items`; array<object>, required)
    - `id` (`getCustomer.response.200.orders.items.id`; string, required)
    - `number` (`getCustomer.response.200.orders.items.number`; number, required)
    - `customer_id` (`getCustomer.response.200.orders.items.customer_id`; any of, required)
      - any of: `string`, `null`
    - `currency` (`getCustomer.response.200.orders.items.currency`; string, required)
    - `exponent` (`getCustomer.response.200.orders.items.exponent`; any of, required)
      - any of: `number`, `null`
    - `amount` (`getCustomer.response.200.orders.items.amount`; any of, required)
      - any of: `number`, `null`
    - `discount` (`getCustomer.response.200.orders.items.discount`; any of, required)
      - any of: `number`, `null`
    - `total` (`getCustomer.response.200.orders.items.total`; any of, required)
      - any of: `number`, `null`
    - `free` (`getCustomer.response.200.orders.items.free`; boolean, required)
    - `fees` (`getCustomer.response.200.orders.items.fees`; any of, required)
      - any of: `number`, `null`
    - `source` (`getCustomer.response.200.orders.items.source`; string, required)
    - `source_key` (`getCustomer.response.200.orders.items.source_key`; any of, required)
      - any of: `string`, `null`
    - `statements` (`getCustomer.response.200.orders.items.statements`; object, required)
      - `coupon` (`getCustomer.response.200.orders.items.statements.coupon`; string, optional)
      - `customer_status` (`getCustomer.response.200.orders.items.statements.customer_status`; string, optional) — How well the buyer was known; `fake` is a seeded order.
      - `method` (`getCustomer.response.200.orders.items.statements.method`; string, optional) — The payment method the processor reported.
      - `method_details` (`getCustomer.response.200.orders.items.statements.method_details`; object, optional) — What the method shows, as a saved instrument's display: its brand and last 4 digits.
        - `brand` (`getCustomer.response.200.orders.items.statements.method_details.brand`; any of, required)
          - any of: `string`, `null`
        - `last4` (`getCustomer.response.200.orders.items.statements.method_details.last4`; any of, required)
          - any of: `string`, `null`
      - `refund_waiver` (`getCustomer.response.200.orders.items.statements.refund_waiver`; object, optional) — Carried from the checkout.
        - `policy` (`getCustomer.response.200.orders.items.statements.refund_waiver.policy`; string, required) — The strictest policy among the lines, the one consented to.
        - `accepted_at` (`getCustomer.response.200.orders.items.statements.refund_waiver.accepted_at`; string, required)
      - `under_minimum` (`getCustomer.response.200.orders.items.statements.under_minimum`; object, optional)
        - `processor` (`getCustomer.response.200.orders.items.statements.under_minimum.processor`; string, required)
        - `minimum` (`getCustomer.response.200.orders.items.statements.under_minimum.minimum`; any of, required) — Null when the processor refused the payment as too small rather than core reading its minimum.
          - any of: `number`, `null`
        - `amount` (`getCustomer.response.200.orders.items.statements.under_minimum.amount`; any of, required)
          - any of: `number`, `null`
    - `note` (`getCustomer.response.200.orders.items.note`; any of, required)
      - any of: `string`, `null`
    - `occurred_at` (`getCustomer.response.200.orders.items.occurred_at`; any of, required)
      - any of: `string`, `null`
    - `recorded_at` (`getCustomer.response.200.orders.items.recorded_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.orders.total`; number, required)
- `subscriptions` (`getCustomer.response.200.subscriptions`; object, required)
  - `items` (`getCustomer.response.200.subscriptions.items`; array<object>, required)
    - `display_status` (`getCustomer.response.200.subscriptions.items.display_status`; string, required) — Its status as people read it: `cancelling` while it bills and is set to stop.
    - `product` (`getCustomer.response.200.subscriptions.items.product`; any of, required)
      - any of: `object`, `null`
    - `id` (`getCustomer.response.200.subscriptions.items.id`; string, required)
    - `customer_id` (`getCustomer.response.200.subscriptions.items.customer_id`; string, required)
    - `product_id` (`getCustomer.response.200.subscriptions.items.product_id`; string, required)
    - `plan_id` (`getCustomer.response.200.subscriptions.items.plan_id`; string, required)
    - `processor` (`getCustomer.response.200.subscriptions.items.processor`; any of, required)
      - any of: `string`, `null`
    - `external_ref` (`getCustomer.response.200.subscriptions.items.external_ref`; any of, required)
      - any of: `string`, `null`
    - `account_ref` (`getCustomer.response.200.subscriptions.items.account_ref`; any of, required)
      - any of: `string`, `null`
    - `status` (`getCustomer.response.200.subscriptions.items.status`; string, required)
    - `cancel_at_period_end` (`getCustomer.response.200.subscriptions.items.cancel_at_period_end`; boolean, required)
    - `instrument_ref` (`getCustomer.response.200.subscriptions.items.instrument_ref`; any of, required)
      - any of: `string`, `null`
    - `cancel_reason` (`getCustomer.response.200.subscriptions.items.cancel_reason`; any of, required)
      - any of: `string`, `null`
    - `created_at` (`getCustomer.response.200.subscriptions.items.created_at`; any of, required)
      - any of: `string`, `null`
    - `ended_at` (`getCustomer.response.200.subscriptions.items.ended_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.subscriptions.total`; number, required)
- `grants` (`getCustomer.response.200.grants`; object, required)
  - `items` (`getCustomer.response.200.grants.items`; array<object>, required)
    - `token_id` (`getCustomer.response.200.grants.items.token_id`; any of, required)
      - any of: `string`, `null`
    - `product` (`getCustomer.response.200.grants.items.product`; any of, required)
      - any of: `object`, `null`
    - `id` (`getCustomer.response.200.grants.items.id`; string, required)
    - `customer_id` (`getCustomer.response.200.grants.items.customer_id`; string, required)
    - `product_id` (`getCustomer.response.200.grants.items.product_id`; string, required)
    - `tier_id` (`getCustomer.response.200.grants.items.tier_id`; any of, required)
      - any of: `string`, `null`
    - `source_kind` (`getCustomer.response.200.grants.items.source_kind`; string, required)
    - `source_ref` (`getCustomer.response.200.grants.items.source_ref`; any of, required)
      - any of: `string`, `null`
    - `grant_reason` (`getCustomer.response.200.grants.items.grant_reason`; any of, required)
      - any of: `string`, `null`
    - `settlement_id` (`getCustomer.response.200.grants.items.settlement_id`; any of, required)
      - any of: `string`, `null`
    - `valid_from` (`getCustomer.response.200.grants.items.valid_from`; any of, required)
      - any of: `string`, `null`
    - `ends_at` (`getCustomer.response.200.grants.items.ends_at`; any of, required)
      - any of: `string`, `null`
    - `end_reason` (`getCustomer.response.200.grants.items.end_reason`; any of, required)
      - any of: `string`, `null`
    - `status` (`getCustomer.response.200.grants.items.status`; string, required) — Where it stands now: not begun, standing, or how it ended.
    - `revocable` (`getCustomer.response.200.grants.items.revocable`; boolean, required) — Whether `revokeGrant` may still end it.
    - `granted_by` (`getCustomer.response.200.grants.items.granted_by`; any of, required)
      - any of: `string`, `null`
    - `occurred_at` (`getCustomer.response.200.grants.items.occurred_at`; any of, required)
      - any of: `string`, `null`
    - `recorded_at` (`getCustomer.response.200.grants.items.recorded_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.grants.total`; number, required)
- `entitlements` (`getCustomer.response.200.entitlements`; object, required)
  - `items` (`getCustomer.response.200.entitlements.items`; array<object>, required)
    - `customer_id` (`getCustomer.response.200.entitlements.items.customer_id`; string, required)
    - `product_id` (`getCustomer.response.200.entitlements.items.product_id`; string, required)
    - `tier_rank` (`getCustomer.response.200.entitlements.items.tier_rank`; number, required)
    - `expires_at` (`getCustomer.response.200.entitlements.items.expires_at`; any of, required)
      - any of: `string`, `null`
    - `tier_expires_at` (`getCustomer.response.200.entitlements.items.tier_expires_at`; any of, required)
      - any of: `string`, `null`
    - `next_change_at` (`getCustomer.response.200.entitlements.items.next_change_at`; any of, required)
      - any of: `string`, `null`
    - `rebuilt_at` (`getCustomer.response.200.entitlements.items.rebuilt_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.entitlements.total`; number, required)
- `reviews` (`getCustomer.response.200.reviews`; object, required)
  - `items` (`getCustomer.response.200.reviews.items`; array<object>, required)
    - `product` (`getCustomer.response.200.reviews.items.product`; any of, required)
      - any of: `object`, `null`
    - `id` (`getCustomer.response.200.reviews.items.id`; string, required)
    - `product_id` (`getCustomer.response.200.reviews.items.product_id`; string, required)
    - `customer_id` (`getCustomer.response.200.reviews.items.customer_id`; string, required)
    - `order_item_id` (`getCustomer.response.200.reviews.items.order_item_id`; any of, required)
      - any of: `string`, `null`
    - `rating` (`getCustomer.response.200.reviews.items.rating`; number, required)
    - `username` (`getCustomer.response.200.reviews.items.username`; any of, required)
      - any of: `string`, `null`
    - `notes` (`getCustomer.response.200.reviews.items.notes`; any of, required)
      - any of: `string`, `null`
    - `reply` (`getCustomer.response.200.reviews.items.reply`; any of, required)
      - any of: `string`, `null`
    - `replied_at` (`getCustomer.response.200.reviews.items.replied_at`; any of, required)
      - any of: `string`, `null`
    - `hidden_at` (`getCustomer.response.200.reviews.items.hidden_at`; any of, required)
      - any of: `string`, `null`
    - `created_at` (`getCustomer.response.200.reviews.items.created_at`; any of, required)
      - any of: `string`, `null`
    - `updated_at` (`getCustomer.response.200.reviews.items.updated_at`; any of, required) — When the customer last edited it; null until they do.
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.reviews.total`; number, required)
- `attempts` (`getCustomer.response.200.attempts`; object, required)
  - `items` (`getCustomer.response.200.attempts.items`; array<object>, required)
    - `id` (`getCustomer.response.200.attempts.items.id`; string, required)
    - `product_id` (`getCustomer.response.200.attempts.items.product_id`; string, required)
    - `quiz_id` (`getCustomer.response.200.attempts.items.quiz_id`; string, required)
    - `customer_id` (`getCustomer.response.200.attempts.items.customer_id`; string, required)
    - `attempt` (`getCustomer.response.200.attempts.items.attempt`; number, required)
    - `status` (`getCustomer.response.200.attempts.items.status`; string, required)
    - `answers` (`getCustomer.response.200.attempts.items.answers`; map<object>, required)
    - `score` (`getCustomer.response.200.attempts.items.score`; any of, required)
      - any of: `number`, `null`
    - `correct` (`getCustomer.response.200.attempts.items.correct`; any of, required)
      - any of: `number`, `null`
    - `started_at` (`getCustomer.response.200.attempts.items.started_at`; any of, required)
      - any of: `string`, `null`
    - `finished_at` (`getCustomer.response.200.attempts.items.finished_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.attempts.total`; number, required)
- `certificates` (`getCustomer.response.200.certificates`; object, required)
  - `items` (`getCustomer.response.200.certificates.items`; array<object>, required)
    - `id` (`getCustomer.response.200.certificates.items.id`; string, required)
    - `product_id` (`getCustomer.response.200.certificates.items.product_id`; string, required)
    - `certificate_id` (`getCustomer.response.200.certificates.items.certificate_id`; string, required)
    - `customer_id` (`getCustomer.response.200.certificates.items.customer_id`; string, required)
    - `score` (`getCustomer.response.200.certificates.items.score`; any of, required)
      - any of: `number`, `null`
    - `attempt` (`getCustomer.response.200.certificates.items.attempt`; any of, required)
      - any of: `number`, `null`
    - `issued_at` (`getCustomer.response.200.certificates.items.issued_at`; any of, required)
      - any of: `string`, `null`
    - `revoked_at` (`getCustomer.response.200.certificates.items.revoked_at`; any of, required)
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.certificates.total`; number, required)
- `feeds` (`getCustomer.response.200.feeds`; object, required) — Their private feeds, live and stopped, newest first; `listFeeds` pages the rest.
  - `items` (`getCustomer.response.200.feeds.items`; array<object>, required)
    - `id` (`getCustomer.response.200.feeds.items.id`; string, required)
    - `customer_id` (`getCustomer.response.200.feeds.items.customer_id`; string, required)
    - `product_id` (`getCustomer.response.200.feeds.items.product_id`; string, required)
    - `product` (`getCustomer.response.200.feeds.items.product`; any of, required)
      - any of: `object`, `null`
    - `readers` (`getCustomer.response.200.feeds.items.readers`; number, required) — Readers it served in the last 30 days, each shared fetcher for the people it reports.
    - `reader_limit` (`getCustomer.response.200.feeds.items.reader_limit`; number, required) — Readers it serves in 30 days before it moves to a new URL.
    - `reader_limit_set` (`getCustomer.response.200.feeds.items.reader_limit_set`; boolean, required) — Whether the limit is the merchant's own rather than the default.
    - `created_at` (`getCustomer.response.200.feeds.items.created_at`; any of, required)
      - any of: `string`, `null`
    - `revoked_at` (`getCustomer.response.200.feeds.items.revoked_at`; any of, required)
      - any of: `string`, `null`
    - `revoked_reason` (`getCustomer.response.200.feeds.items.revoked_reason`; any of, required) — Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.
      - any of: `string`, `null`
  - `total` (`getCustomer.response.200.feeds.total`; number, required)
  - `blocked` (`getCustomer.response.200.feeds.blocked`; array<object>, required) — The blogs, podcasts and events whose private feed sharing turned off for them, until the merchant turns it on again.
    - `product_id` (`getCustomer.response.200.feeds.blocked.product_id`; string, required)
    - `product` (`getCustomer.response.200.feeds.blocked.product`; any of, required)
      - any of: `object`, `null`
    - `blocked_at` (`getCustomer.response.200.feeds.blocked.blocked_at`; any of, required)
      - any of: `string`, `null`
- `contacts` (`getCustomer.response.200.contacts`; array<object>, required)
  - `kind` (`getCustomer.response.200.contacts.kind`; string, required)
  - `value` (`getCustomer.response.200.contacts.value`; string, required)
  - `verified_at` (`getCustomer.response.200.contacts.verified_at`; any of, required)
    - any of: `string`, `null`
- `totals` (`getCustomer.response.200.totals`; object, required)
  - `orders` (`getCustomer.response.200.totals.orders`; number, required)
  - `spent` (`getCustomer.response.200.totals.spent`; array<object>, required)
    - `currency` (`getCustomer.response.200.totals.spent.currency`; string, required)
    - `exponent` (`getCustomer.response.200.totals.spent.exponent`; any of, required)
      - any of: `number`, `null`
    - `amount` (`getCustomer.response.200.totals.spent.amount`; any of, required)
      - any of: `number`, `null`
    - `gross` (`getCustomer.response.200.totals.spent.gross`; any of, required)
      - any of: `number`, `null`
    - `refunded` (`getCustomer.response.200.totals.spent.refunded`; any of, required)
      - any of: `number`, `null`
  - `active_subscriptions` (`getCustomer.response.200.totals.active_subscriptions`; number, required)
- `id` (`getCustomer.response.200.id`; string, required)
- `display_name` (`getCustomer.response.200.display_name`; any of, required)
  - any of: `string`, `null`
- `locale` (`getCustomer.response.200.locale`; any of, required)
  - any of: `string`, `null`
- `country` (`getCustomer.response.200.country`; any of, required)
  - any of: `string`, `null`
- `erased_at` (`getCustomer.response.200.erased_at`; any of, required)
  - any of: `string`, `null`
- `invited_at` (`getCustomer.response.200.invited_at`; any of, required)
  - any of: `string`, `null`
- `created_at` (`getCustomer.response.200.created_at`; any of, required)
  - any of: `string`, `null`

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`getCustomer.response.default.type`; string, required)
  - format `uri`
- `title` (`getCustomer.response.default.title`; string, required)
- `status` (`getCustomer.response.default.status`; integer, required)
- `detail` (`getCustomer.response.default.detail`; string, required)
- `code` (`getCustomer.response.default.code`; string, optional)
- `context` (`getCustomer.response.default.context`; object, optional)
- `reached_core` (`getCustomer.response.default.reached_core`; boolean, optional)
- `core_answer` (`getCustomer.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/get-customer/index.md
