Billing

Retrieve all discount coupons.

get/api/v1/billing/discountcoupons

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/billing/discountcoupons
Auth: one of:
- HTTP bearer
- API key in header Authorization

Query parameters

canRedeemboolean

When true, returns only coupons that can still be redeemed

qstring nullable

Searches coupons by name or code

planUidstring nullable

Returns only coupons that apply to the plan with this unique identifier

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "UniqueIdentifier": "string",
      "Name": "string",
      "IsActive": false,
      "AmountOff": 0,
      "PercentOff": 0,
      "RedeemBy": "string",
      "Duration": 1,
      "DurationInMonths": 0,
      "TimesRedeemed": 0,
      "MaxRedemptions": 0,
      "DiscountCouponPlans": [],
      "ApplyToAddOns": false,
      "IsInUse": false,
      "PlanUids": "string"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.