Retrieve an add-on

GET

add_ons

{code}

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

curl --location --request GET "$LAGO_URL/api/v1/add_ons/:code" \
  --header "Authorization: Bearer $API_KEY"

{
  "add_on": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Setup Fee",
    "invoice_display_name": "Setup Fee (SF1)",
    "code": "setup_fee",
    "amount_cents": 50000,
    "amount_currency": "USD",
    "description": "Implementation fee for new customers.",
    "created_at": "2022-04-29T08:59:51Z",
    "taxes": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "TVA",
        "code": "french_standard_vat",
        "description": "French standard VAT",
        "rate": 20,
        "applied_to_organization": true,
        "add_ons_count": 123,
        "charges_count": 123,
        "customers_count": 123,
        "plans_count": 123,
        "created_at": "2023-07-06T14:35:58Z"
      }
    ]
  }
}

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 add-on.

Response

200 - application/json

add_on

object

required

add_on.lago_id

string

required

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

add_on.name

string

required

The name of the add-on.

add_on.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_on.code

string

required

Unique code used to identify the add-on.

add_on.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_on.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_on.description

string | null

The description of the add-on.

add_on.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_on.taxes

object[]

All taxes applied to the add-on.

Was this page helpful?

Delete an add-on List all add-ons

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

curl --location --request GET "$LAGO_URL/api/v1/add_ons/:code" \
  --header "Authorization: Bearer $API_KEY"

{
  "add_on": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Setup Fee",
    "invoice_display_name": "Setup Fee (SF1)",
    "code": "setup_fee",
    "amount_cents": 50000,
    "amount_currency": "USD",
    "description": "Implementation fee for new customers.",
    "created_at": "2022-04-29T08:59:51Z",
    "taxes": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "TVA",
        "code": "french_standard_vat",
        "description": "French standard VAT",
        "rate": 20,
        "applied_to_organization": true,
        "add_ons_count": 123,
        "charges_count": 123,
        "customers_count": 123,
        "plans_count": 123,
        "created_at": "2023-07-06T14:35:58Z"
      }
    ]
  }
}

API Reference

Authorizations

Path Parameters

Response