Retrieve a coupon

GET

coupons

{code}

Authorization

Path

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": true,
    "billable_metric_codes": [],
    "percentage_rate": "<string>",
    "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"
  }
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

code

string

required

Unique code used to identify the coupon.

Response

200 - application/json

coupon

object

required

coupon.lago_id

string

required

Unique identifier of the coupon, created by Lago.

coupon.name

string

required

The name of the coupon.

coupon.code

string

required

Unique code used to identify the coupon.

coupon.description

string | null

Description of the coupon.

coupon.coupon_type

enum<string>

required

The type of the coupon. It can have two possible values: fixed_amount or percentage.

If set to fixed_amount, the coupon represents a fixed amount discount.
If set to percentage, the coupon represents a percentage-based discount.

Available options:

fixed_amount,

percentage

coupon.amount_cents

integer | null

The amount of the coupon in cents. This field is required only for coupon with fixed_amount type.

coupon.amount_currency

enum<string>

The currency of the coupon. This field is required only for coupon with fixed_amount type.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

coupon.reusable

boolean

required

Indicates whether the coupon can be reused or not. If set to true, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to false, the coupon can only be used once and is not reusable. If not specified, this field is set to true by default.

coupon.limited_plans

boolean

required

The coupon is limited to specific plans. The possible values can be true or false.

coupon.plan_codes

string[]

An array of plan codes to which the coupon is applicable. By specifying the plan codes in this field, you can restrict the coupon's usage to specific plans only.

coupon.limited_billable_metrics

boolean

required

The coupon is limited to specific billable metrics. The possible values can be true or false.

coupon.billable_metric_codes

string[]

An array of billable metric codes to which the coupon is applicable. By specifying the billable metric codes in this field, you can restrict the coupon's usage to specific metrics only.

coupon.percentage_rate

string | null

The percentage rate of the coupon. This field is required only for coupons with a percentage coupon type.

coupon.frequency

enum<string>

required

The type of frequency for the coupon. It can have three possible values: once, recurring, or forever.

If set to once, the coupon is applicable only for a single use.
If set to recurring, the coupon can be used multiple times for recurring billing periods.
If set to forever, the coupon has unlimited usage and can be applied indefinitely.

Available options:

once,

recurring

coupon.frequency_duration

integer | null

Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a recurring frequency type

coupon.expiration

enum<string>

required

Specifies the type of expiration for the coupon. It can have two possible values: time_limit or no_expiration.

If set to time_limit, the coupon has an expiration based on a specified time limit.
If set to no_expiration, the coupon does not have an expiration date and remains valid indefinitely.

Available options:

no_expiration,

time_limit

coupon.expiration_at

string | null

The expiration date and time of the coupon. This field is required only for coupons with expiration set to time_limit. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.

coupon.created_at

string

required

The date and time when the coupon was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the coupon was initially created.

coupon.terminated_at

string

This field indicates if the coupon has been terminated and is no longer usable. If it's not null, it won't be removed for existing customers using it, but it prevents the coupon from being applied in the future.

Was this page helpful?

Delete a coupon List all coupons

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": true,
    "billable_metric_codes": [],
    "percentage_rate": "<string>",
    "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"
  }
}

API Reference

Authorizations

Path Parameters

Response