Apply a coupon

POST

applied_coupons

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/applied_coupons" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "applied_coupon": {
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
      "coupon_code": "startup_deal",
      "amount_cents": 2500,
      "amount_currency": "EUR",
      "frequency": "recurring",
      "frequency_duration": 3
    }
  }'

{
  "applied_coupon": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_coupon_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "coupon_code": "startup_deal",
    "coupon_name": "Startup Deal",
    "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "status": "active",
    "amount_cents": 2000,
    "amount_cents_remaining": 50,
    "amount_currency": "EUR",
    "percentage_rate": "<string>",
    "frequency": "recurring",
    "frequency_duration": 3,
    "frequency_duration_remaining": 1,
    "expiration_at": "2022-04-29T08:59:51Z",
    "created_at": "2022-04-29T08:59:51Z",
    "terminated_at": "2022-04-29T08:59:51Z"
  }
}

Authorizations

Authorization

string

headerrequired

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

Body

application/json

applied_coupon

object

required

Response

200 - application/json

applied_coupon

object

required

applied_coupon.lago_id

string

required

Unique identifier of the applied coupon, created by Lago.

applied_coupon.lago_coupon_id

string

required

Unique identifier of the coupon, created by Lago.

applied_coupon.coupon_code

string

required

Unique code used to identify the coupon.

applied_coupon.coupon_name

string

required

The name of the coupon.

applied_coupon.lago_customer_id

string

required

Unique identifier of the customer, created by Lago.

applied_coupon.external_customer_id

string

required

The customer external unique identifier (provided by your own application)

applied_coupon.status

enum<string>

required

The status of the coupon. Can be either active or terminated.

Available options:

active,

terminated

applied_coupon.amount_cents

integer | null

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

applied_coupon.amount_cents_remaining

integer | null

The remaining amount in cents for a fixed_amount coupon with a frequency set to once. This field indicates the remaining balance or value that can still be utilized from the coupon.

applied_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

applied_coupon.percentage_rate

string | null

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

applied_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,

forever

applied_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

applied_coupon.frequency_duration_remaining

integer | null

The remaining number of billing periods to which the coupon is applicable. This field determines the remaining usage or availability of the coupon based on the remaining billing periods.

applied_coupon.expiration_at

string | null

The date and time after which the coupon will stop applying to customer's invoices. Once the expiration date is reached, the coupon will no longer be applicable, and any further invoices generated for the customer will not include the coupon discount.

applied_coupon.created_at

string

required

The date and time when the coupon was assigned to a customer. It is expressed in UTC format according to the ISO 8601 datetime standard.

applied_coupon.terminated_at

string | null

This field indicates the specific moment when the coupon amount is fully utilized or when the coupon is removed from the customer's coupon list. It is expressed in UTC format according to the ISO 8601 datetime standard.

Was this page helpful?

The applied coupon object Delete an applied coupon

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/applied_coupons" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "applied_coupon": {
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
      "coupon_code": "startup_deal",
      "amount_cents": 2500,
      "amount_currency": "EUR",
      "frequency": "recurring",
      "frequency_duration": 3
    }
  }'

{
  "applied_coupon": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_coupon_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "coupon_code": "startup_deal",
    "coupon_name": "Startup Deal",
    "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
    "status": "active",
    "amount_cents": 2000,
    "amount_cents_remaining": 50,
    "amount_currency": "EUR",
    "percentage_rate": "<string>",
    "frequency": "recurring",
    "frequency_duration": 3,
    "frequency_duration_remaining": 1,
    "expiration_at": "2022-04-29T08:59:51Z",
    "created_at": "2022-04-29T08:59:51Z",
    "terminated_at": "2022-04-29T08:59:51Z"
  }
}

API Reference

Authorizations

Body

Response