TEtellers
accepts-api-key

Check Coupons

get/users/check_coupons

Request

  • Base URL
    https://api.tellers.ai (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

coupon_codestring required

Stripe promotion code to validate.

currencystring nullable

Lowercase ISO currency the prices are shown in (the checkout currency). An amount discount is then described in it, and a coupon that can't be charged in it comes back invalid.

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Successful Response

coupon_codestring required
is_validboolean required
namestring nullable required
descriptionstring nullable required
expires_atstring date-time nullable

UTC time after which the code can no longer be redeemed (the earlier of the promotion code's expiry and the coupon's redeem_by); null when it doesn't expire. Also set, with nothing else, when the code has expired. Clients show it in the user's own time zone.

is_expiredboolean

True when the code exists but has expired (expires_at says when); is_valid is then false and no other detail is given.

Changes

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