Skip to main content
lago_id
string<uuid>
required

Unique identifier of the add-on, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

name
string
required

The name of the add-on.

Example:

"Setup Fee"

invoice_display_name
string | null
required

Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the add-on will be used as the default display name.

Example:

"Setup Fee (SF1)"

code
string
required

Unique code used to identify the add-on.

Example:

"setup_fee"

amount_cents
integer
required

The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.

Example:

50000

amount_currency
enum<string>
required

The currency of the add-on.

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,
GHS,
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,
SYP,
SZL,
THB,
TJS,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
Example:

"USD"

description
string | null
required

The description of the add-on.

Example:

"Implementation fee for new customers."

created_at
string<date-time>
required

The date and time when the add-on 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 add-on was initially created.

Example:

"2022-04-29T08:59:51Z"

taxes
object[]
required

All taxes applied to the add-on.