---
title: "Get coupon usage"
method: GET
path: "/api/rnb/pvt/coupon/usage/{couponCode}"
tags: ["Coupons"]
---

# Get coupon usage

`GET /api/rnb/pvt/coupon/usage/{couponCode}`

Retrieves information about the coupon usage.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Rates and Benefits | Promotions | **Manage benefits and rates** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `couponCode` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `hostName` string — Name of the store.
  - `couponCode` string — Coupon code.
  - `profileUsages` object — Object with information where and when the coupon was used.
    - `profileId` object — Profile ID.
      - `orderUsage` object[] — Array with all the orders that the coupon was used.
        - `orderId` string — Order ID.
        - `usageDateUtc` string — Date and time when the coupon was used in the order in UTC format.

---

[API](https://skmtc.net/vtex/apis/promotions-taxes-api.md) · [All operations](https://skmtc.net/vtex/apis/promotions-taxes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/promotions-taxes-api/versions/6ad1b4bbb46f/schema)