Docs
Sign in

Validate a promo code for a plan

Confirms a promo code can be used with the plan and returns its discount percentage and minimum billing cycle.

POST
/plans/{plan}/promo-codes/validate

Authorization

BearerToken
AuthorizationBearer <token>

In: header

Path Parameters

plan*integer

The plan ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/plans/0/promo-codes/validate" \  -H "Content-Type: application/json" \  -d '{    "promo_code": "string",    "billing_cycle": 1  }'
{  "code": "string",  "percentage": 0,  "minimum_billing_cycle": 0}