Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Preview a coupon

POST
/api/v1/billing/coupons/validate
curl --request POST \
--url https://api.pitch2sale.com/api/v1/billing/coupons/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "code": "example", "plan_slug": "example", "interval": "monthly", "country": "example", "seats": 1 }'

Checks a coupon code for plan_slug and returns its percent, whether it would beat the org discount, and the server quote. Nothing is redeemed. Failed checks are limited per organization and IP: the 6th within 15 minutes returns 429 coupon_rate_limited. Requires settings.edit.

Media typeapplication/json
object
code
required
string
>= 1 characters <= 50 characters
plan_slug
required
string
>= 1 characters <= 50 characters
interval
string
default: monthly
Allowed values: monthly yearly
country
string
>= 2 characters <= 2 characters
seats
integer
>= 1 <= 10000

OK

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Role permission or token scope missing; OAuth app tokens are not accepted on this route

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}