Coupons
Create a coupon
This endpoint is used to create a coupon that can be then attached to a customer to create a discount.
POST
/api/v1/coupons
Bearer*
{
"coupon": {
"amount_cents": "5000",
"amount_currency": "USD",
"billable_metric_codes": [],
"code": "startup_deal",
"coupon_type": "fixed_amount",
"created_at": "2022-04-29T08:59:51Z",
"description": "I am a coupon description",
"expiration": "time_limit",
"expiration_at": "2022-08-08T23:59:59Z",
"frequency": "recurring",
"frequency_duration": "6",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"limited_billable_metrics": "boolean",
"limited_plans": true,
"name": "Startup Deal",
"percentage_rate": "null",
"plan_codes": [
"startup_plan"
],
"reusable": true,
"terminated_at": "2022-08-08T23:59:59Z"
}
}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request POST "$LAGO_URL/api/v1/coupons" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"coupon": {
"name": "Startup Deal",
"code": "startup_deal",
"amount_cents": 5000,
"amount_currency": "USD",
"coupon_type": "fixed_amount",
"reusable": true,
"frequency": "recurring",
"frequency_duration": 6,
"expiration": "time_limit",
"expiration_at": "2022-08-08T23:59:59Z",
"applies_to": {
"plan_codes": ["startup_plan"],
"billable_metric_codes": []
}
}
}'
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
couponrequired
object
Response
200 - application/json
couponrequired
object
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request POST "$LAGO_URL/api/v1/coupons" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"coupon": {
"name": "Startup Deal",
"code": "startup_deal",
"amount_cents": 5000,
"amount_currency": "USD",
"coupon_type": "fixed_amount",
"reusable": true,
"frequency": "recurring",
"frequency_duration": 6,
"expiration": "time_limit",
"expiration_at": "2022-08-08T23:59:59Z",
"applies_to": {
"plan_codes": ["startup_plan"],
"billable_metric_codes": []
}
}
}'
{
"coupon": {
"amount_cents": "5000",
"amount_currency": "USD",
"billable_metric_codes": [],
"code": "startup_deal",
"coupon_type": "fixed_amount",
"created_at": "2022-04-29T08:59:51Z",
"description": "I am a coupon description",
"expiration": "time_limit",
"expiration_at": "2022-08-08T23:59:59Z",
"frequency": "recurring",
"frequency_duration": "6",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"limited_billable_metrics": "boolean",
"limited_plans": true,
"name": "Startup Deal",
"percentage_rate": "null",
"plan_codes": [
"startup_plan"
],
"reusable": true,
"terminated_at": "2022-08-08T23:59:59Z"
}
}