promo-codes

Validate Promo Code Handler

Validate a promo code

Checks if the promo code is:

  • Valid and exists
  • Active
  • Not expired
  • Within usage limits
  • Applicable to the specified plan (if provided)
post/promo-codes/validate

Request

  • Base URL: https://api.particl.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.particl.com/promo-codes/validate
  • Auth: none declared

Request body

codestring required

Promo code to validate

plan_typestring nullable

Plan type to check applicability against

Response

Successful Response

validboolean required
messagestring required
promo_code_idstring nullable
discount_type'percentage' | 'fixed'
discount_valuenumber nullable

Changes

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