List Coupons

This call is used to retrieve a list of all the coupons in the system.

This call supports string filtering (Read More)

Parameter NamesAcceptable ValuesParameter NamesAcceptable Values
applyToAllPlansBooleannameString
descriptionStringstatusActive, Retired

This call supports pagination (Read More)
&pageSize=10&pageNumber=0
This call supports sorting (Read More)
&sortOrder=Ascending or &sortOrder=Descending
&sortExpression=expression

Examples
curl -X GET "https://secure.fusebill.com/v1/coupons" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/coupons/");
//Add Content type
request.ContentType = "application/json";
request.ContentLength = 0;
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey);
//Set request method
request.Method = "GET";
//Perform the request
var httpResponse = (HttpWebResponse)request.GetResponse();
//Record the response from our request
var result = "";
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
  result = streamReader.ReadToEnd();
}
#Import library Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/coupons', headers=headers)
print(r.content)
Response
[
  {
    "name": "Senior Discount",
    "description": "65+",
    "eligibilityStartDate": "2019-11-01T04:00:00",
    "eligibilityEndDate": "2020-05-15T03:59:59.997",
    "status": "Active",
    "applyToAllPlans": false,
    "couponCodes": [
      {
        "code": "SD12",
        "timesUsed": 204,
        "remainingUsages": null
      }
    ],
    "id": 2263,
    "uri": "https://secure.fusebill.com/v1/coupons/2263"
  },
  {
    "name": "Youth Discount",
    "description": "Under 20",
    "eligibilityStartDate": "2019-11-01T04:00:00",
    "eligibilityEndDate": "2020-05-15T03:59:59.997",
    "status": "Active",
    "applyToAllPlans": true,
    "couponCodes": [
      {
        "code": "YD09",
        "timesUsed": 120,
        "remainingUsages": 203
      }
    ],
    "id": 2263,
    "uri": "https://secure.fusebill.com/v1/coupons/2263"
  }
]
{
    "ErrorId": 0,
    "HttpStatusCode": 400,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Bad request, the query is not valid.  Please check your request and try again."
        }
    ]
}
Language
Authorization