The credit note object

lago_id

string

required

The credit note unique identifier, created by Lago.

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.

number

string

required

The credit note unique number.

lago_invoice_id

string

required

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

invoice_number

string

required

The invoice unique number, related to the credit note.

issuing_date

string

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.

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

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,

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

total_amount_cents

integer

required

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

taxes_amount_cents

integer

required

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

taxes_rate

number

required

The tax rate associated with this specific credit note.

sub_total_excluding_taxes_amount_cents

integer

required

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

balance_amount_cents

integer

required

The remaining credit note amount, expressed in cents.

credit_amount_cents

integer

required

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

refund_amount_cents

integer

required

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

coupons_adjustment_amount_cents

integer

required

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

created_at

string

required

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

updated_at

string

required

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

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

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

description

string | null

The description of the credit note.

file_url

string | null

The PDF file of the credit note.

items

object[]

Array of credit note's items.

items.lago_id

string

required

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

items.amount_cents

integer

required

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

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,

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

items.fee

object

required

The fee object related to the credit note item.

items.fee.amount_cents

integer

required

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

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,

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

items.fee.taxes_amount_cents

integer

required

The cost of the tax associated with this specific fee.

items.fee.taxes_rate

number

required

The tax rate associated with this specific fee.

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.

items.fee.precise_unit_amount

string

required

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

items.fee.total_amount_cents

integer

required

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

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,

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

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

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.

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

items.fee.item

object

required

Item attached to the fee

items.fee.lago_id

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

items.fee.lago_charge_id

string | null

Unique identifier assigned to the charge that the fee belongs to

items.fee.lago_charge_filter_id

string | null

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

items.fee.lago_invoice_id

string | null

Unique identifier assigned to the invoice that the fee belongs to

items.fee.lago_true_up_fee_id

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

items.fee.lago_true_up_parent_fee_id

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

items.fee.lago_subscription_id

string | null

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

items.fee.lago_customer_id

string | null

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

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.

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.

items.fee.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.

items.fee.precise_amount

string

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

items.fee.precise_total_amount

string

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

items.fee.taxes_precise_amount

string

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

items.fee.events_count

integer

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.

items.fee.from_date

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

items.fee.to_date

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

items.fee.created_at

string | null

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

items.fee.succeeded_at

string | null

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

items.fee.failed_at

string | null

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

items.fee.refunded_at

string | null

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

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

items.fee.amount_details

object

List of all unit amount details for calculating the fee.

items.fee.amount_details.graduated_ranges

object[]

Graduated ranges, used for a graduated charge model.

items.fee.amount_details.graduated_percentage_ranges

object[]

Graduated percentage ranges, used for a graduated_percentage charge model.

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.

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.

items.fee.amount_details.per_package_size

integer

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

items.fee.amount_details.per_package_unit_amount

string

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

items.fee.amount_details.units

string

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

items.fee.amount_details.free_events

integer

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

items.fee.amount_details.rate

string

Percentage rate applied for the Percentage charge model.

items.fee.amount_details.per_unit_total_amount

string

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

items.fee.amount_details.paid_events

integer

Total number of paid events for the Percentage charge model.

items.fee.amount_details.fixed_fee_unit_amount

string

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

items.fee.amount_details.fixed_fee_total_amount

string

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

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.

items.fee.amount_details.volume_ranges

object[]

Volume ranges, used for a volume charge model.

items.fee.applied_taxes

object[]

List of fee applied taxes

applied_taxes

object[]

API Reference