• HTTP
  • Java
  • .NET
  • PHP
  • Python
  • Ruby
  • TypeScript
  • Go
Get SDK

Read Coupon Usage

API Docs by APIMATIC
Advanced Billing APIAPI EndpointsCoupons

Read Coupon Usage
#

This request will provide details about the coupon usage as an array of data hashes, one per product.

GET /product_families/{product_family_id}/coupons/{coupon_id}/usage.json
Authentication

This endpoint requires BasicAuth

BasicAuth
BasicAuth
Required

Set authorization parameters for BasicAuth

Required
string

The username to use with basic authentication

  • is a required field
Required
string

The password to use with basic authentication

  • is a required field

API Code Playground

Endpoint Arguments
Parameters
Required
Required
Number
Template

The Advanced Billing id of the product family to which the coupon belongs

Required
Number
Template

The Advanced Billing id of the coupon

Responses

  • 200

OK

application/json

Type

array<Coupon Usage>

[
  {
    "name": "No cost product",
    "id": 3903594,
    "signups": 0,
    "savings": 0,
    "savings_in_cents": 0,
    "revenue": 0,
    "revenue_in_cents": 0
  },
  {
    "name": "Product that expires",
    "id": 3853680,
    "signups": 0,
    "savings": 0,
    "savings_in_cents": 0,
    "revenue": 0,
    "revenue_in_cents": 0
  },
  {
    "name": "Trial Product",
    "id": 3861800,
    "signups": 1,
    "savings": 30,
    "savings_in_cents": 3000,
    "revenue": 20,
    "revenue_in_cents": 2000
  }
]
  • HTTP
  • Java
  • .NET
  • PHP
  • Python
  • Ruby
  • TypeScript
  • Go
  • Request
  • Response
curl -X GET \
  --url 'https://subdomain.chargify.com/product_families/140/coupons/162/usage.json'  \
  -H 'Accept: application/json'