List all add-ons

GET

add_ons

Authorization

Query

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

curl --location --request GET "$LAGO_URL/api/v1/add_ons?per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"

{
  "add_ons": [
    {
      "amount_cents": 50000,
      "amount_currency": "USD",
      "code": "setup_fee",
      "created_at": "2022-04-29T08:59:51Z",
      "description": "Implementation fee for new customers.",
      "invoice_display_name": "Setup Fee (SF1)",
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "name": "Setup Fee",
      "taxes": []
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 70,
    "total_pages": 4
  }
}

Authorizations

Authorization

string

headerrequired

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

Query Parameters

page

integer

Page number.

per_page

integer

Number of records per page.

Response

200 - application/json

add_ons

object[]

required

add_ons.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.

add_ons.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,

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

add_ons.code

string

required

Unique code used to identify the add-on.

add_ons.created_at

string

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.

add_ons.description

string | null

The description of the add-on.

add_ons.invoice_display_name

string

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

add_ons.lago_id

string

required

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

add_ons.name

string

required

The name of the add-on.

add_ons.taxes

object[]

All taxes applied to the add-on.

meta

object

required

Was this page helpful?

Retrieve an add-on Retrieve gross revenue

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

curl --location --request GET "$LAGO_URL/api/v1/add_ons?per_page=2&page=1" \
  --header "Authorization: Bearer $API_KEY"

{
  "add_ons": [
    {
      "amount_cents": 50000,
      "amount_currency": "USD",
      "code": "setup_fee",
      "created_at": "2022-04-29T08:59:51Z",
      "description": "Implementation fee for new customers.",
      "invoice_display_name": "Setup Fee (SF1)",
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "name": "Setup Fee",
      "taxes": []
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 70,
    "total_pages": 4
  }
}

API Reference

Authorizations

Query Parameters

Response