Billing

Retrieve the redemptions of a discount coupon.

get/api/v1/billing/discountcoupons/{discountCouponUid}/redemptions

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/billing/discountcoupons/{discountCouponUid}/redemptions
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

discountCouponUidstring nullable required

The discount coupon's unique identifier

Query parameters

qstring nullable

Searches redemptions by account or plan name

isActiveboolean nullable

When set, filters by whether the redemption is still active

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": {},
      "RedeemedDate": "string",
      "ExpireDate": "string",
      "Subscription": {},
      "DiscountCoupon": {}
    }
  ]
}

Changes

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