---
title: "Redemption count and discount given by a coupon"
description: "Per invoice currency, non-voided invoices only."
canonical_url: "https://twominutebilling.com/help/developers/api-reference/catalog/redemption-count-and-discount-given-by-a-coupon"
---
# Redemption count and discount given by a coupon

> Per invoice currency, non-voided invoices only.

<api-operation method="GET" path="/v1/businesses/{biz}/coupons/{cpn}/stats">
<template v-slot:docs="">

discount_gross is the discount taken off invoices; discount_reversed is the share of it credited back by non-voided credit notes; discount_given = gross − reversed.

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        cpn
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      The coupon's id (a slug id, e.g. <code>
        welcome-10
      </code>
      
      ).
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        coupon_stats
      </code>
      
      . One of <code>
        coupon_stats
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        coupon
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The coupon's id (a slug id, e.g. <code>
        welcome-10
      </code>
      
      ).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        redemptions
      </code>
    </td>
    
    <td>
      <code>
        integer
      </code>
    </td>
    
    <td>
      Every application, set codes included; removed ones still count
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        discount_given
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      Net of credit notes: discount_gross − discount_reversed
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        discount_gross
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      Discount taken off non-voided invoices
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        discount_reversed
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      Share of the discount reversed by non-voided credit notes: a note item linked to an invoice line reverses that line's discount pro rata; an unlinked note reverses the invoice's discount by its share of the invoice total
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Success
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        404
      </code>
    </td>
    
    <td>
      No such coupon
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/coupons/welcome-10/stats" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">
<code-group>

```json [200 OK]
{
  "object": "coupon_stats",
  "coupon": "welcome-10",
  "redemptions": 1,
  "discount_given": [
    {
      "currency": "USD",
      "amount_minor": 2900
    }
  ],
  "discount_gross": [
    {
      "currency": "USD",
      "amount_minor": 2900
    }
  ],
  "discount_reversed": [
    {
      "currency": "USD",
      "amount_minor": 2900
    }
  ]
}
```

```json [404 Not Found]
{
  "error": {
    "type": "invalid_request_error",
    "message": "No such coupon"
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.