Skip to main content
POST
Preview what a coupon is worth on a basket

Authorizations

Authorization
string
header
required

Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.

Body

application/json
code
string
required
Minimum string length: 1
productType
enum<string>
required
Available options:
DEDICATED,
CLOUD,
WEB_HOSTING
planId
string
required
billingCycle
enum<string>
Available options:
monthly,
quarterly,
semi-annually,
annually,
biennially,
triennially
quantity
integer
Required range: 1 <= x <= 10
addonIds
string[]

Response

The quote, or the reason the code doesn't apply.

success
boolean
required
data
object
required