---
title: "Get usage stats of non-prototype payment links for a gateway account"
method: GET
path: "/v1/api/stats/products"
tags: ["Products"]
---

# Get usage stats of non-prototype payment links for a gateway account

`GET /v1/api/stats/products`

## Query parameters

- `gatewayAccountId` integer
- `used` boolean

## Response `200`

OK

- ProductUsageStat[]
  - `last_payment_date` string, date-time
  - `payment_count` integer
  - `product` Product
    - `_links` Link[]
      - `href` string
      - `method` string
      - `rel` 'self' | 'pay' | 'next' | 'friendly'
    - `amount_hint` string
    - `date_created` string, date-time
    - `description` string
    - `external_id` string
    - `gateway_account_id` integer
    - `language` 'en' | 'cy'
    - `metadata` object
    - `name` string
    - `pay_api_token` string
    - `price` integer
    - `product_name_path` string
    - `reference_enabled` boolean
    - `reference_hint` string
    - `reference_label` string
    - `require_captcha` boolean
    - `return_url` string
    - `service_name_path` string
    - `status` 'ACTIVE' | 'INACTIVE'
    - `type` 'DEMO' | 'PROTOTYPE' | 'ADHOC' | 'AGENT_INITIATED_MOTO'

## Changes

- **2025-07-28** `521f70c3f2d9` — 1 info
  - added the optional property `items/product/date_created` to the response with the `200` status
- **2025-02-18** `8be2dae1b569` — 1 info
  - added the new optional `query` request parameter `used`
- **2023-01-04** `7a993ebe4a85` — 1 info
  - added the optional property `items/product/pay_api_token` to the response with the `200` status
- **2022-08-26** `16f0bb4aa3cf` — 1 warning
  - removed the optional property `items/product/new_payment_link_journey_enabled` from the response with the `200` status
- **2022-04-05** `9ffbc14fb6d4` — 1 info
  - added the optional property `items/product/amount_hint` to the response with the `200` status

[Change history](https://skmtc.dev/government-digital-service/apis/products-api/changes/v1/api/stats/products/get.md)

---

[API](https://skmtc.dev/government-digital-service/apis/products-api.md) · [All operations](https://skmtc.dev/government-digital-service/apis/products-api/llms.txt) · [OpenAPI document](https://skmtc.dev/government-digital-service/apis/products-api/revisions/521f70c3f2d9?raw)