Coupons

Get coupon by code

Changed on

Use when resolving a coupon by promo code (e.g. checkout or validation).

get/coupons/code/{code}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/coupons/code/{code}
  • Auth
    API key in header x-api-key

Path parameters

codestring required

Coupon code

Response

OK

amount_offstring
cadence'once' | 'repeated' | 'forever'
coupon_codestring
created_atstring date-time
created_bystring
currencystring
duration_in_periodsinteger
environment_idstring
idstring
max_redemptionsinteger
metadataobject
namestring
percentage_offstring
redeem_afterstring
redeem_beforestring
rulesobject
status'published' | 'deleted' | 'archived'
tenant_idstring
total_redemptionsinteger
type'fixed' | 'percentage'
updated_atstring date-time
updated_bystring

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

  • 7d57386313c7Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new archived enum value to the response property for the response status

    • warning

      added the new deleted enum value to the response property for the response status

    • warning

      added the new published enum value to the response property for the response status