Coupons
Retrieve a coupon
API Reference
- Getting started
- Add-ons
- Analytics
- Billable metrics
- Coupons
- Credit notes
- Customer usage
- Customers
- Events
- Fees
- Invoices
- Organizations
- Payments
- Payment receipts
- Payment requests
- Plans
- Resources
- Subscriptions
- Taxes
- Wallets
- Webhook endpoints
- Webhooks
Coupons
Retrieve a coupon
This endpoint is used to retrieve a specific coupon.
GET
/
coupons
/
{code}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/coupons/:code" \
--header "Authorization: Bearer $API_KEY"
{
"coupon": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"name": "Startup Deal",
"code": "startup_deal",
"description": "I am a coupon description",
"coupon_type": "fixed_amount",
"amount_cents": 5000,
"amount_currency": "USD",
"reusable": true,
"limited_plans": true,
"plan_codes": [
"startup_plan"
],
"limited_billable_metrics": false,
"billable_metric_codes": [],
"percentage_rate": null,
"frequency": "recurring",
"frequency_duration": 6,
"expiration": "time_limit",
"expiration_at": "2022-08-08T23:59:59Z",
"created_at": "2022-04-29T08:59:51Z",
"terminated_at": "2022-08-08T23:59:59Z"
}
}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/coupons/:code" \
--header "Authorization: Bearer $API_KEY"
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique code used to identify the coupon.
Example:
"startup_deal"
Response
200
application/json
Coupon
The response is of type object
.
Was this page helpful?
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request GET "$LAGO_URL/api/v1/coupons/:code" \
--header "Authorization: Bearer $API_KEY"
{
"coupon": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"name": "Startup Deal",
"code": "startup_deal",
"description": "I am a coupon description",
"coupon_type": "fixed_amount",
"amount_cents": 5000,
"amount_currency": "USD",
"reusable": true,
"limited_plans": true,
"plan_codes": [
"startup_plan"
],
"limited_billable_metrics": false,
"billable_metric_codes": [],
"percentage_rate": null,
"frequency": "recurring",
"frequency_duration": 6,
"expiration": "time_limit",
"expiration_at": "2022-08-08T23:59:59Z",
"created_at": "2022-04-29T08:59:51Z",
"terminated_at": "2022-08-08T23:59:59Z"
}
}