Create a credit note

POST

credit_notes

Authorization

Body

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

curl --location --request POST "$LAGO_URL/api/v1/credit_notes" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "credit_note": {
      "invoice_id": "__LAGO_INVOICE_ID__",
      "reason": "duplicated_charge",
      "credit_amount_cents": 10,
      "refund_amount_cents": 5,
      "items": [
        {
          "fee_id": "__LAGO_FEE_ID__",
          "amount_cents": 10
        },
        {
          "fee_id": "__LAGO_FEE_ID__",
          "amount_cents": 5
        }
      ]
    }'

{
  "credit_note": {
    "applied_taxes": [],
    "balance_amount_cents": 100,
    "coupons_adjustment_amount_cents": 20,
    "created_at": "2022-09-14T16:35:31Z",
    "credit_amount_cents": 100,
    "credit_status": "available",
    "currency": "EUR",
    "description": "Free text",
    "file_url": "https://getlago.com/credit_note/file",
    "invoice_number": "LAG-1234",
    "issuing_date": "2022-12-06",
    "items": [],
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "number": "LAG-1234-CN2",
    "reason": "other",
    "refund_amount_cents": 123,
    "refund_status": "pending",
    "sequential_id": 2,
    "sub_total_excluding_taxes_amount_cents": 100,
    "taxes_amount_cents": 20,
    "taxes_rate": 20,
    "total_amount_cents": 120,
    "updated_at": "2022-09-14T16:35:31Z"
  }
}

Authorizations

Authorization

string

headerrequired

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

Body

application/json

credit_note

object

required

Response

200 - application/json

credit_note

object

required

credit_note.applied_taxes

object[]

credit_note.balance_amount_cents

integer

required

The remaining credit note amount, expressed in cents.

credit_note.coupons_adjustment_amount_cents

integer

required

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

credit_note.created_at

string

required

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

credit_note.credit_amount_cents

integer

required

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

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

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

credit_note.description

string | null

The description of the credit note.

credit_note.file_url

string | null

The PDF file of the credit note.

credit_note.invoice_number

string

required

The invoice unique number, related to the credit note.

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.

credit_note.items

object[]

Array of credit noteâ€™s items.

credit_note.items.amount_cents

integer

required

The credit noteâ€™s item amount, expressed in cents.

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

credit_note.items.fee

object

required

The fee object related to the credit note item.

credit_note.items.fee.amount_cents

integer

required

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

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

credit_note.items.fee.applied_taxes

object[]

List of fee applied taxes

credit_note.items.fee.created_at

string | null

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

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

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

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

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

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

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

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

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

credit_note.items.fee.item

object

required

Item attached to the fee

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

credit_note.items.fee.lago_group_id

string | null

Unique identifier assigned to the group that the fee belongs to

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

credit_note.items.fee.lago_invoice_id

string | null

Unique identifier assigned to the invoice that the fee belongs to

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

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

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

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

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

credit_note.items.fee.precise_unit_amount

string

required

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

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

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

credit_note.items.fee.taxes_amount_cents

integer

required

The cost of the tax associated with this specific fee.

credit_note.items.fee.taxes_rate

number

required

The tax rate associated with this specific fee.

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

credit_note.items.fee.total_amount_cents

integer

required

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

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

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

credit_note.items.lago_id

string

required

The credit noteâ€™s item unique identifier, created by Lago.

credit_note.lago_id

string

required

The credit note unique identifier, created by Lago.

credit_note.lago_invoice_id

string

required

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

credit_note.number

string

required

The credit note unique number.

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

credit_note.refund_amount_cents

integer

required

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

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

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

credit_note.sub_total_excluding_taxes_amount_cents

integer

required

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

credit_note.taxes_amount_cents

integer

required

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

credit_note.taxes_rate

number

required

The tax rate associated with this specific credit note.

credit_note.total_amount_cents

integer

required

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

credit_note.updated_at

string

required

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

Was this page helpful?

The credit note object Update a credit note

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

curl --location --request POST "$LAGO_URL/api/v1/credit_notes" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "credit_note": {
      "invoice_id": "__LAGO_INVOICE_ID__",
      "reason": "duplicated_charge",
      "credit_amount_cents": 10,
      "refund_amount_cents": 5,
      "items": [
        {
          "fee_id": "__LAGO_FEE_ID__",
          "amount_cents": 10
        },
        {
          "fee_id": "__LAGO_FEE_ID__",
          "amount_cents": 5
        }
      ]
    }'

{
  "credit_note": {
    "applied_taxes": [],
    "balance_amount_cents": 100,
    "coupons_adjustment_amount_cents": 20,
    "created_at": "2022-09-14T16:35:31Z",
    "credit_amount_cents": 100,
    "credit_status": "available",
    "currency": "EUR",
    "description": "Free text",
    "file_url": "https://getlago.com/credit_note/file",
    "invoice_number": "LAG-1234",
    "issuing_date": "2022-12-06",
    "items": [],
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "number": "LAG-1234-CN2",
    "reason": "other",
    "refund_amount_cents": 123,
    "refund_status": "pending",
    "sequential_id": 2,
    "sub_total_excluding_taxes_amount_cents": 100,
    "taxes_amount_cents": 20,
    "taxes_rate": 20,
    "total_amount_cents": 120,
    "updated_at": "2022-09-14T16:35:31Z"
  }
}

API Reference

Authorizations

Body

Response