List all credit notes

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

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

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

external_customer_id

string

Unique identifier assigned to the customer in your application.

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

issuing_date_from

string<date>

Filter credit notes starting from a specific date.

Example:

"2022-07-08"

issuing_date_to

string<date>

Filter credit notes up to a specific date.

Example:

"2022-08-09"

search_term

string

Search credit notes by id, number, customer name, customer external_id or customer email.

Example:

"Jane"

currency

string

Filter credit notes by currency. Possible values ISO 4217 currency codes.

Example:

"EUR"

reason

enum<string>

Filter credit notes by reasons. Possible values are product_unsatisfactory, order_change, order_cancellation, fraudulent_charge, duplicated_charge or other.

Available options:

product_unsatisfactory,

order_change,

order_cancellation,

fraudulent_charge,

duplicated_charge,

other

credit_status

enum<string>

Filter credit notes by credit status. Possible values are available, consumed or voided.

Available options:

available,

consumed,

voided

refund_status

enum<string>

Filter credit notes by refund status. Possible values are pending, succeeded or failed.

Available options:

pending,

succeeded,

failed

invoice_number

string

Filter credit notes by their related invoice number.

Example:

"INV-001-002"

amount_from

integer

Filter credit notes of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.

Example:

9000

amount_to

integer

Filter credit notes up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.

Example:

100000

self_billed

boolean

Filter credit notes belonging to a self billed invoice. Possible values are true or false.

Example:

true

billing_entity_codes[]

string[]

Filter credit notes by billing entity codes.

Example:

[
  "billing_entity_code_1",
  "billing_entity_code_2"
]

Response

Credit notes

credit_notes

object[]

required

Show child attributes

credit_notes.lago_id

string<uuid>

required

The credit note unique identifier, created by Lago.

Example:

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

credit_notes.billing_entity_code

string

required

The unique code of the billing entity associated with the credit note.

Example:

"acme_corp"

credit_notes.sequential_id

integer

required

The sequential identifier of the credit note, specifically scoped on the associated invoice. It provides a unique numerical identifier for the credit note within the context of the invoice.

Example:

2

credit_notes.number

string

required

The credit note unique number.

Example:

"LAG-1234-CN2"

credit_notes.lago_invoice_id

string<uuid>

required

Unique identifier assigned to the invoice that the credit note belongs to

Example:

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

credit_notes.invoice_number

string

required

The invoice unique number, related to the credit note.

Example:

"LAG-1234"

credit_notes.issuing_date

string<date>

required

The date of creation of the credit note. It follows the ISO 8601 date format and provides the specific date when the credit note was created.

Example:

"2022-12-06"

credit_notes.reason

enum<string>

required

The reason of the credit note creation. Possible values are duplicated_charge, product_unsatisfactory, order_change, order_cancellation, fraudulent_charge or other.

Available options:

duplicated_charge,

product_unsatisfactory,

order_change,

order_cancellation,

fraudulent_charge,

other

Example:

"other"

credit_notes.currency

enum<string>

required

The currency of the credit note.

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"EUR"

credit_notes.total_amount_cents

integer

required

The total amount of the credit note, expressed in cents.

Example:

120

credit_notes.taxes_amount_cents

integer

required

The tax amount of the credit note, expressed in cents.

Example:

20

credit_notes.taxes_rate

number

required

The tax rate associated with this specific credit note.

Example:

20

credit_notes.sub_total_excluding_taxes_amount_cents

integer

required

The subtotal of the credit note excluding any applicable taxes, expressed in cents.

Example:

100

credit_notes.balance_amount_cents

integer

required

The remaining credit note amount, expressed in cents.

Example:

100

credit_notes.credit_amount_cents

integer

required

The credited amount of the credit note, expressed in cents.

Example:

100

credit_notes.refund_amount_cents

integer

required

The refunded amount of the credit note, expressed in cents.

Example:

0

credit_notes.coupons_adjustment_amount_cents

integer

required

The pro-rated amount of the coupons applied to the source invoice.

Example:

20

credit_notes.created_at

string<date-time>

required

The date when the credit note was created. It is expressed in Coordinated Universal Time (UTC).

Example:

"2022-09-14T16:35:31Z"

credit_notes.updated_at

string<date-time>

required

The date when the credit note was last updated. It is expressed in Coordinated Universal Time (UTC).

Example:

"2022-09-14T16:35:31Z"

credit_notes.credit_status

enum<string> | null

The status of the credit portion of the credit note. It indicates the current state or condition of the credit amount associated with the credit note. The possible values for this field are:

available: this status indicates that an amount remains available for future usage. The credit can be applied towards future transactions or invoices.
consumed: this status indicates that the credit amount has been fully consumed. The remaining amount is 0, indicating that the credit has been utilized in its entirety.
voided: this status indicates that the remaining amount of the credit cannot be used any further. The credit has been voided and is no longer available for application or redemption.

Available options:

available,

consumed,

voided,

Example:

"available"

credit_notes.refund_status

enum<string> | null

The status of the refund portion of the credit note. It indicates the current state or condition of the refund associated with the credit note. The possible values for this field are:

pending: this status indicates that the refund is pending execution. The refund request has been initiated but has not been processed or completed yet.
succeeded: this status indicates that the refund has been successfully executed. The refund amount has been processed and returned to the customer or the designated recipient.
failed: this status indicates that the refund failed to execute. The refund request encountered an error or unsuccessful processing, and the refund amount could not be returned.

Available options:

pending,

succeeded,

failed,

Example:

"pending"

credit_notes.description

string | null

The description of the credit note.

Example:

"Free text"

credit_notes.file_url

string | null

The PDF file of the credit note.

Example:

"https://getlago.com/credit_note/file"

credit_notes.items

object[]

Array of credit note's items.

Show child attributes

credit_notes.items.lago_id

string<uuid>

required

The credit note's item unique identifier, created by Lago.

Example:

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

credit_notes.items.amount_cents

integer

required

The credit note's item amount, expressed in cents.

Example:

100

credit_notes.items.amount_currency

enum<string>

required

The credit note's item currency.

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"EUR"

credit_notes.items.fee

object

required

The fee object related to the credit note item.

Show child attributes

credit_notes.items.fee.amount_cents

integer

required

The cost of this specific fee, excluding any applicable taxes.

Example:

100

credit_notes.items.fee.amount_currency

enum<string>

required

The currency of this specific fee. It indicates the monetary unit in which the fee's cost is expressed.

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"EUR"

credit_notes.items.fee.taxes_amount_cents

integer

required

The cost of the tax associated with this specific fee.

Example:

20

credit_notes.items.fee.taxes_rate

number

required

The tax rate associated with this specific fee.

Example:

20

credit_notes.items.fee.units

string

required

The number of units used to charge the customer. This field indicates the quantity or count of units consumed or utilized in the context of the charge. It helps in determining the basis for calculating the fee or cost associated with the usage of the service or product provided to the customer.

Example:

"0.32"

credit_notes.items.fee.precise_unit_amount

string

required

The unit amount of the fee per unit, with precision.

Example:

"312.5"

credit_notes.items.fee.total_aggregated_units

string

required

The total number of units that have been aggregated for this specific fee.

Example:

"0.32"

credit_notes.items.fee.total_amount_cents

integer

required

The cost of this specific fee, including any applicable taxes.

Example:

120

credit_notes.items.fee.total_amount_currency

enum<string>

required

The currency of this specific fee, including any applicable taxes.

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"EUR"

credit_notes.items.fee.pay_in_advance

boolean

required

Flag that indicates whether the fee was paid in advance. It serves as a boolean value, where true represents that the fee was paid in advance (straightaway), and false indicates that the fee was not paid in arrears (at the end of the period).

Example:

true

credit_notes.items.fee.invoiceable

boolean

required

Flag that indicates whether the fee was included on the invoice. It serves as a boolean value, where true represents that the fee was included on the invoice, and false indicates that the fee was not included on the invoice.

Example:

true

credit_notes.items.fee.payment_status

enum<string>

required

Indicates the payment status of the fee. It represents the current status of the payment associated with the fee. The possible values for this field are pending, succeeded, failed and refunded.

Available options:

pending,

succeeded,

failed,

refunded

Example:

"pending"

credit_notes.items.fee.item

object

required

Item attached to the fee

Show child attributes

credit_notes.items.fee.item.type

enum<string>

required

The fee type. Possible values are add-on, charge, credit, subscription or commitment.

Available options:

charge,

add_on,

subscription,

credit,

commitment

Example:

"subscription"

credit_notes.items.fee.item.code

string

required

The code of the fee item. It can be the code of the add-on, the code of the charge, the code of the credit or the code of the subscription.

Example:

"startup"

credit_notes.items.fee.item.name

string

required

The name of the fee item. The value depends on the type of the fee item:

If the fee item is a charge, it is the billable metric name.
If the fee item is a add-on, it is the add-on name.
If the fee item is a credit, it is the wallet transaction name if set, or "credit" if not.
If the fee item is a fixed_charge, it is the fixed charge add-on name.
For all the other fee items, it is the subscription plan name.

Example:

"Startup"

credit_notes.items.fee.item.lago_item_id

string<uuid>

required

Unique identifier of the fee item, created by Lago. It can be the identifier of the add-on, the charge, the credit, the subscription or the commitment.

Example:

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

credit_notes.items.fee.item.item_type

enum<string>

required

The type of the fee item. Possible values are AddOn, BillableMetric, WalletTransaction, Subscription.

Available options:

AddOn,

BillableMetric,

Subscription,

WalletTransaction

Example:

"Subscription"

credit_notes.items.fee.item.description

string | null

The description of the fee item. The value depends on the type of the fee item:

If the fee item is a charge, it is the billable metric description.
If the fee item is a add-on, it is the add-on description.
If the fee item is a credit, it is always "credit".
If the fee item is a fixed_charge, it is the fixed charge add-on description.
For all the other fee items, it is the subscription plan description.

Example:

"Startup"

credit_notes.items.fee.item.invoice_display_name

string

Specifies the name that will be displayed on an invoice. If no value is set for this field, we'll fallback to a value that depends on the type of the fee items:

If the fee item is a charge, we'll fallback to the invoice_display_name of the charge or the billable metric name if no invoice_display_name is set.
If the fee item is a add-on, we'll fallback to the invoice_name of the add-on or the name of the add-on.
If the fee item is a credit, we'll fallback to the wallet transaction name if set, or credit if not.
If the fee item is a fixed_charge, we'll fallback to the invoice_display_name of the fixed_charge or the invoice_name of the fixed_charge_add_on if no invoice_display_name is set.
For all the other fee items, we'll fallback to the invoice_display_name of the subscription plan.

Example:

"Setup Fee (SF1)"

credit_notes.items.fee.item.filter_invoice_display_name

string | null

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

Example:

"AWS eu-east-1"

credit_notes.items.fee.item.filters

object

Key value list of event properties

Show child attributes

credit_notes.items.fee.item.filters.{key}

string[]

credit_notes.items.fee.item.grouped_by

object

Key value list of event properties aggregated by the charge model

Show child attributes

credit_notes.items.fee.item.grouped_by.{key}

string

credit_notes.items.fee.lago_id

string<uuid> | null

Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.

Example:

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

credit_notes.items.fee.lago_charge_id

string<uuid> | null

Unique identifier assigned to the charge that the fee belongs to

Example:

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

credit_notes.items.fee.lago_charge_filter_id

string<uuid> | null

Unique identifier assigned to the charge filter that the fee belongs to

Example:

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

credit_notes.items.fee.lago_invoice_id

string<uuid> | null

Unique identifier assigned to the invoice that the fee belongs to

Example:

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

credit_notes.items.fee.lago_true_up_fee_id

string<uuid> | null

Unique identifier assigned to the true-up fee when a minimum has been set to the charge. This identifier helps to distinguish and manage the true-up fee associated with the charge, which may be applicable when a minimum threshold or limit is set for the charge amount.

Example:

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

credit_notes.items.fee.lago_true_up_parent_fee_id

string<uuid> | null

Unique identifier assigned to the parent fee on which the true-up fee is assigned. This identifier establishes the relationship between the parent fee and the associated true-up fee.

Example:

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

credit_notes.items.fee.lago_subscription_id

string<uuid> | null

Unique identifier assigned to the subscription, created by Lago. This field is specifically displayed when the fee type is charge or subscription.

Example:

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

credit_notes.items.fee.lago_customer_id

string<uuid> | null

Unique identifier assigned to the customer, created by Lago. This field is specifically displayed when the fee type is charge or subscription.

Example:

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

credit_notes.items.fee.external_customer_id

string | null

Unique identifier assigned to the customer in your application. This field is specifically displayed when the fee type is charge or subscription.

Example:

"external_id"

credit_notes.items.fee.external_subscription_id

string | null

Unique identifier assigned to the subscription in your application. This field is specifically displayed when the fee type is charge or subscription.

Example:

"external_id"

credit_notes.items.fee.precise_amount

string

The cost of this specific fee, excluding any applicable taxes, with precision.

Example:

"1.0001"

credit_notes.items.fee.precise_total_amount

string

The cost of this specific fee, including any applicable taxes, with precision.

Example:

"1.0212"

credit_notes.items.fee.taxes_precise_amount

string

The cost of the tax associated with this specific fee, with precision.

Example:

"0.20123"

credit_notes.items.fee.events_count

integer | null

The number of events that have been sent and used to charge the customer. This field indicates the count or quantity of events that have been processed and considered in the charging process.

Example:

23

credit_notes.items.fee.from_date

string<date-time> | null

The beginning date of the period that the fee covers. It is applicable only to subscription and charge fees. This field indicates the start date of the billing period or subscription period associated with the fee.

Example:

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

credit_notes.items.fee.to_date

string<date-time> | null

The ending date of the period that the fee covers. It is applicable only to subscription and charge fees. This field indicates the end date of the billing period or subscription period associated with the fee.

Example:

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

credit_notes.items.fee.created_at

string<date-time> | null

The date and time when the fee was created. It is provided in Coordinated Universal Time (UTC) format.

Example:

"2022-08-24T14:58:59Z"

credit_notes.items.fee.succeeded_at

string<date-time> | null

The date and time when the payment for the fee was successfully processed. It is provided in Coordinated Universal Time (UTC) format.

Example:

"2022-08-24T14:58:59Z"

credit_notes.items.fee.failed_at

string<date-time> | null

The date and time when the payment for the fee failed to process. It is provided in Coordinated Universal Time (UTC) format.

Example:

"2022-08-24T14:58:59Z"

credit_notes.items.fee.refunded_at

string<date-time> | null

The date and time when the payment for the fee was refunded. It is provided in Coordinated Universal Time (UTC) format

Example:

"2022-08-24T14:58:59Z"

credit_notes.items.fee.event_transaction_id

string | null

Unique identifier assigned to the transaction. This field is specifically displayed when the fee type is charge and the payment for the fee is made in advance (pay_in_advance is set to true).

Example:

"transaction_1234567890"

credit_notes.items.fee.description

string | null

The description of the fee.

Example:

"Fee description"

credit_notes.items.fee.precise_coupons_amount_cents

string

The coupon amount applied to the fee, with precision.

Example:

"0.0"

credit_notes.items.fee.amount_details

object

List of all unit amount details for calculating the fee.

Show child attributes

credit_notes.items.fee.amount_details.plan_amount_cents

integer

The base cost of the plan, excluding any applicable taxes, that is billed on a recurring basis. This value is defined at 0 if your plan is a pay-as-you-go plan.

Example:

10000

credit_notes.items.fee.amount_details.graduated_ranges

object[]

Graduated ranges, used for a graduated charge model.

Show child attributes

credit_notes.items.fee.amount_details.graduated_ranges.units

string

required

Total units received in Lago.

Example:

"10.0"

credit_notes.items.fee.amount_details.graduated_ranges.from_value

integer

required

Lower value of a tier. It is either 0 or the previous range's to_value + 1.

Example:

0

credit_notes.items.fee.amount_details.graduated_ranges.to_value

integer | null

required

Highest value of a tier.

This value is higher than the from_value of the same tier.
This value is null for the last tier.

Example:

10

credit_notes.items.fee.amount_details.graduated_ranges.flat_unit_amount

string

required

Flat unit amount within a specified tier.

Example:

"1.0"

credit_notes.items.fee.amount_details.graduated_ranges.per_unit_amount

string

required

Amount per unit within a specified tier.

Example:

"1.0"

credit_notes.items.fee.amount_details.graduated_ranges.per_unit_total_amount

string

required

Total amount of received units to be charged within a specified tier.

Example:

"10.0"

credit_notes.items.fee.amount_details.graduated_ranges.total_with_flat_amount

string

required

Total amount to be charged for a specific tier, taking into account the flat_unit_amount and the per_unit_total_amount.

Example:

"11.0"

credit_notes.items.fee.amount_details.graduated_percentage_ranges

object[]

Graduated percentage ranges, used for a graduated_percentage charge model.

Show child attributes

credit_notes.items.fee.amount_details.graduated_percentage_ranges.units

string

required

Total units received in Lago.

Example:

"10.0"

credit_notes.items.fee.amount_details.graduated_percentage_ranges.from_value

integer

required

Lower value of a tier. It is either 0 or the previous range's to_value + 1.

Example:

0

credit_notes.items.fee.amount_details.graduated_percentage_ranges.to_value

integer | null

required

Highest value of a tier.

This value is higher than the from_value of the same tier.
This value is null for the last tier.

Example:

10

credit_notes.items.fee.amount_details.graduated_percentage_ranges.flat_unit_amount

string

required

Flat unit amount within a specified tier.

Example:

"1.0"

credit_notes.items.fee.amount_details.graduated_percentage_ranges.rate

string<^[0-9]+.?[0-9]*$>

required

Percentage rate applied within a specified tier.

Example:

"1.0"

credit_notes.items.fee.amount_details.graduated_percentage_ranges.per_unit_total_amount

string

required

Total amount of received units to be charged within a specified tier.

Example:

"10.0"

credit_notes.items.fee.amount_details.graduated_percentage_ranges.total_with_flat_amount

string

required

Total amount to be charged for a specific tier, taking into account the flat_unit_amount and the per_unit_total_amount.

Example:

"11.0"

credit_notes.items.fee.amount_details.free_units

string

The quantity of units that are provided free of charge for each billing period in a package charge model.

Example:

"10.0"

credit_notes.items.fee.amount_details.paid_units

string

The quantity of units that are not provided free of charge for each billing period in a package charge model.

Example:

"40.0"

credit_notes.items.fee.amount_details.per_package_size

integer

The quantity of units included, defined for Package or Percentage charge model.

Example:

1000

credit_notes.items.fee.amount_details.per_package_unit_amount

string

Total amount to charge for received paid_units, defined for Package or Percentage charge model.

Example:

"0.5"

credit_notes.items.fee.amount_details.per_unit_total_amount

string

Total amount of received units to be charged for the Volume or Percentage charge model.

Example:

"10.0"

credit_notes.items.fee.amount_details.units

string

The total units received in Lago for the Percentage charge model.

Example:

"20.0"

credit_notes.items.fee.amount_details.free_events

integer

Total number of free events allowed for the Percentage charge model.

Example:

10

credit_notes.items.fee.amount_details.rate

string<^[0-9]+.?[0-9]*$>

Percentage rate applied for the Percentage charge model.

Example:

"1.0"

credit_notes.items.fee.amount_details.paid_events

integer

Total number of paid events for the Percentage charge model.

Example:

20

credit_notes.items.fee.amount_details.fixed_fee_unit_amount

string

Fixed fee unit price per received paid_event for the Percentage charge model.

Example:

"1.0"

credit_notes.items.fee.amount_details.fixed_fee_total_amount

string

Total amount to charge for received paid_events for the Percentage charge model.

Example:

"20.0"

credit_notes.items.fee.amount_details.min_max_adjustment_total_amount

string

Total adjustment amount linked to minimum and maximum spending per transaction for the Percentage charge model.

Example:

"20.0"

credit_notes.items.fee.amount_details.per_unit_amount

string

The flat amount for a whole tier, excluding tax, for a volume charge model.

Example:

"0.5"

credit_notes.items.fee.amount_details.flat_unit_amount

string

The unit price, excluding tax, for a specific tier of a volume charge model.

Example:

"10.0"

credit_notes.items.fee.self_billed

boolean

Indicates if the fee belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.

Example:

false

credit_notes.items.fee.applied_taxes

object[]

List of fee applied taxes

Show child attributes

credit_notes.items.fee.applied_taxes.lago_id

string<uuid>

required

Unique identifier of the applied tax, created by Lago.

Example:

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

credit_notes.items.fee.applied_taxes.lago_tax_id

string<uuid> | null

required

Unique identifier of the tax, created by Lago.

Example:

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

credit_notes.items.fee.applied_taxes.tax_name

string

required

Name of the tax.

Example:

"TVA"

credit_notes.items.fee.applied_taxes.tax_code

string

required

Unique code used to identify the tax associated with the API request.

Example:

"french_standard_vat"

credit_notes.items.fee.applied_taxes.tax_rate

number

required

The percentage rate of the tax

Example:

20

credit_notes.items.fee.applied_taxes.tax_description

string | null

required

Internal description of the tax

Example:

"French standard VAT"

credit_notes.items.fee.applied_taxes.amount_cents

integer

required

Amount of the tax

Example:

2000

credit_notes.items.fee.applied_taxes.amount_currency

enum<string>

required

Currency of the tax

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

credit_notes.items.fee.applied_taxes.created_at

string<date-time>

required

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

Example:

"2022-09-14T16:35:31Z"

credit_notes.items.fee.applied_taxes.lago_fee_id

string<uuid>

Unique identifier of the fee, created by Lago.

Example:

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

credit_notes.items.fee.pricing_unit_details

object

Details about the pricing unit used and amounts for this fee.

Show child attributes

credit_notes.items.fee.pricing_unit_details.lago_pricing_unit_id

string<uuid>

required

Unique identifier of the pricing unit, created by Lago.

Example:

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

credit_notes.items.fee.pricing_unit_details.pricing_unit_code

string

required

The code of the pricing unit.

Example:

"credits"

credit_notes.items.fee.pricing_unit_details.short_name

string

required

The short name of the pricing unit. Will be used as currency name in the UI and PDFs.

Example:

"CR"

credit_notes.items.fee.pricing_unit_details.amount_cents

integer

required

The amount in cents in the pricing unit.

Example:

200

credit_notes.items.fee.pricing_unit_details.precise_amount_cents

string

required

The precise amount in cents in the pricing unit.

Example:

"200.0"

credit_notes.items.fee.pricing_unit_details.unit_amount_cents

integer

required

The unit amount in cents in the pricing unit.

Example:

100

credit_notes.items.fee.pricing_unit_details.precise_unit_amount

string

required

The precise unit amount in the pricing unit.

Example:

"100.0"

credit_notes.items.fee.pricing_unit_details.conversion_rate

string

required

The conversion rate from pricing units to the plan's currency.

Example:

"0.5"

credit_notes.applied_taxes

object[]

Show child attributes

credit_notes.applied_taxes.lago_id

string<uuid>

required

Unique identifier of the applied tax, created by Lago.

Example:

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

credit_notes.applied_taxes.lago_tax_id

string<uuid> | null

required

Unique identifier of the tax, created by Lago.

Example:

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

credit_notes.applied_taxes.tax_name

string

required

Name of the tax.

Example:

"TVA"

credit_notes.applied_taxes.tax_code

string

required

Unique code used to identify the tax associated with the API request.

Example:

"french_standard_vat"

credit_notes.applied_taxes.tax_rate

number

required

The percentage rate of the tax

Example:

20

credit_notes.applied_taxes.tax_description

string | null

required

Internal description of the tax

Example:

"French standard VAT"

credit_notes.applied_taxes.amount_cents

integer

required

Amount of the tax

Example:

2000

credit_notes.applied_taxes.amount_currency

enum<string>

required

Currency of the tax

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,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

Example:

"USD"

credit_notes.applied_taxes.created_at

string<date-time>

required

Example:

"2022-09-14T16:35:31Z"

credit_notes.applied_taxes.lago_credit_note_id

string<uuid>

Unique identifier of the credit note, created by Lago.

Example:

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

credit_notes.applied_taxes.base_amount_cents

integer

Example:

100

credit_notes.self_billed

boolean

Indicates if the credit note belongs to self-billed invoice. Self-billing is a process where an organization creates the invoice on behalf of the partner.

Example:

false

credit_notes.error_details

object[] | null

Show child attributes

credit_notes.error_details.lago_id

string<uuid>

required

The credit note error details unique identifier, created by Lago.

Example:

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

credit_notes.error_details.error_code

enum<string>

required

The type of the error.

Available options:

not_provided,

tax_error,

tax_voiding_error,

invoice_generation_error

Example:

"tax_error"

credit_notes.error_details.details

object

required

The details of the error.

API Reference

Authorizations

Query Parameters

Response