Discount Codes

Fetch all discount codes

Returns the business's discount codes (coupons), ordered by code.

By default only active codes are returned — those that have not been deactivated and whose validity window includes today. Use the visibility parameter to return expired, deactivated, or all codes instead.

Each code describes how the discount is calculated (adjust_based_on of flat_rate or percent), what it applies to (applies_to_type), and its validity window. To apply a code to an event, use the event discount code endpoint.

Required permission: offerings_read

get/api/v1/discount_codes

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/discount_codes
  • Auth: none declared. Required headers: Api-Key

Query parameters

visibilitystring

Which discount codes to return. Defaults to active.:

  • active
  • expired
  • inactive
  • all

Headers

Api-Keystring required

Your Integration Key

Response

discount codes found

Changes

No recorded changes to this operation across all 2 revisions of this API.