---
title: "Pages the prices of the store's products, or of one product."
---

> 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 › price

`GET /v1/stores/{store}/products/{product}/prices`

## Authentication

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

## Path parameters

- `store` (`listProductPrices.path.store`; string, required) — The store's id.
- `product` (`listProductPrices.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `filter` (`listProductPrices.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listProductPrices.query.sort`; string, optional)
  - one of `"product"`
- `direction` (`listProductPrices.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listProductPrices.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listProductPrices.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listProductPrices.query.count`; boolean, optional)

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/prices';
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>/products/<product>/prices"

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

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

print(response.text)
```

## Responses

### 200

Pages the prices of the store's products, or of one product.

#### Example

```json
{
  "items": [
    {
      "product": {
        "id": "string",
        "slug": "string",
        "path": "string",
        "url": "string",
        "title": "string",
        "category": "string",
        "deleted": true
      },
      "tier": {
        "id": "string",
        "name": "string"
      },
      "in_use": {
        "orders": 0,
        "subscriptions": 0,
        "checkouts": 0,
        "automations": 0,
        "discounts": 0
      },
      "id": "string",
      "product_id": "string",
      "tier_id": "string",
      "currency": "string",
      "exponent": 0,
      "amount": 0,
      "kind": "string",
      "period": {
        "unit": "string",
        "multiplier": 0
      },
      "highlighted": true,
      "title": "string",
      "description": "string",
      "settings": {
        "autorenew": true,
        "renewal_discount": 100,
        "upgrade_multiplier": 1,
        "refund_policy": "string",
        "property1": true,
        "property2": true
      },
      "archived_at": "string",
      "created_at": "string"
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listProductPrices.response.200.items`; array<object>, required)
  - `product` (`listProductPrices.response.200.items.product`; any of, required)
    - any of: `object`, `null`
  - `tier` (`listProductPrices.response.200.items.tier`; any of, required)
    - any of: `object`, `null`
  - `in_use` (`listProductPrices.response.200.items.in_use`; object, required)
    - `orders` (`listProductPrices.response.200.items.in_use.orders`; number, required)
    - `subscriptions` (`listProductPrices.response.200.items.in_use.subscriptions`; number, required)
    - `checkouts` (`listProductPrices.response.200.items.in_use.checkouts`; number, required)
    - `automations` (`listProductPrices.response.200.items.in_use.automations`; number, required)
    - `discounts` (`listProductPrices.response.200.items.in_use.discounts`; number, required)
  - `id` (`listProductPrices.response.200.items.id`; string, required)
  - `product_id` (`listProductPrices.response.200.items.product_id`; string, required)
  - `tier_id` (`listProductPrices.response.200.items.tier_id`; string, required)
  - `currency` (`listProductPrices.response.200.items.currency`; string, required)
  - `exponent` (`listProductPrices.response.200.items.exponent`; any of, required)
    - any of: `number`, `null`
  - `amount` (`listProductPrices.response.200.items.amount`; number, required)
  - `kind` (`listProductPrices.response.200.items.kind`; string, required)
  - `period` (`listProductPrices.response.200.items.period`; any of, required)
    - any of: `object`, `null`
  - `highlighted` (`listProductPrices.response.200.items.highlighted`; boolean, required)
  - `title` (`listProductPrices.response.200.items.title`; any of, required)
    - any of: `string`, `null`
  - `description` (`listProductPrices.response.200.items.description`; any of, required)
    - any of: `string`, `null`
  - `settings` (`listProductPrices.response.200.items.settings`; object, required)
    - `autorenew` (`listProductPrices.response.200.items.settings.autorenew`; boolean, optional) — Recurring only; false stops the renewal, absent renews.
    - `renewal_discount` (`listProductPrices.response.200.items.settings.renewal_discount`; integer, optional) — Recurring only, a percent off every renewal.
      - min 0; max 100
    - `upgrade_multiplier` (`listProductPrices.response.200.items.settings.upgrade_multiplier`; number, optional) — One-time only, a factor on the difference paid to move up a tier.
      - min 1; max 10
    - `refund_policy` (`listProductPrices.response.200.items.settings.refund_policy`; string, optional) — Overrides the product's.
  - `archived_at` (`listProductPrices.response.200.items.archived_at`; any of, required)
    - any of: `string`, `null`
  - `created_at` (`listProductPrices.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
- `cursor` (`listProductPrices.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listProductPrices.response.200.total`; number, optional)
- `facets` (`listProductPrices.response.200.facets`; map<map<number>>, optional)

### 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` (`listProductPrices.response.default.type`; string, required)
  - format `uri`
- `title` (`listProductPrices.response.default.title`; string, required)
- `status` (`listProductPrices.response.default.status`; integer, required)
- `detail` (`listProductPrices.response.default.detail`; string, required)
- `code` (`listProductPrices.response.default.code`; string, optional)
- `context` (`listProductPrices.response.default.context`; object, optional)
- `reached_core` (`listProductPrices.response.default.reached_core`; boolean, optional)
- `core_answer` (`listProductPrices.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/list-product-prices/index.md
