Toshl Developer

Promos

Promo endpoint can be used to inquire about promo codes. If a promo code is active the endpoint returns details about the promo code.

Resource representation

{
  "code": "hufierw821",
  "discount": 20,
  "valid_until": "2012-09-04 13:55:15"
}

Properties

code
readonly
string

Promo code
discount
readonly
number

Discount amount

Minimum: > 0
Maximum: =< 100
level
readonly
string

Promo code level. If null promo code is available for any level.

Possible values: pro, medici
period
readonly
string

Promo code period. If null promo code is available for any period.

Possible values: month, year, 3-years
gift
read, write
boolean

Set to true if promo code includes gift option.
valid_until
read, write
string

Date until promo code is valid.

Format: date-time

* denotes required field/parameter.