Credit Notes
List credit notes
Returns a paginated list of credit notes for a given customer. The customer_id query parameter is required.
GET
/
credit-notes
List credit notes
curl --request GET \
--url https://api.alguna.io/credit-notes \
--header 'Alguna-Version: <alguna-version>' \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.alguna.io/credit-notes"
headers = {
"Alguna-Version": "<alguna-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api.alguna.io/credit-notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alguna.io/credit-notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Alguna-Version: <alguna-version>",
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.alguna.io/credit-notes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Alguna-Version", "<alguna-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.alguna.io/credit-notes")
.header("Alguna-Version", "<alguna-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alguna.io/credit-notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"attachments": [
{
"file_url": "<string>",
"title": "Credit Note PDF"
}
],
"created_at": "2026-04-01T10:00:00Z",
"currency": "USD",
"customer_id": "cust_01H1VECT",
"description": "Overcharge credit",
"external_reference": "<string>",
"id": "cn_01H1VECT",
"is_pdf_available": true,
"line_items": [
{
"billing_period_end": "2026-01-31T23:59:59Z",
"billing_period_start": "2026-01-01T00:00:00Z",
"description": "Platform usage credit",
"id": "cnli_01H1VECT",
"is_editable": true,
"quantity": "1",
"total_price": "100.00",
"unit_price": "100.00",
"additional_description": "<string>",
"invoice_line_item_id": "<string>",
"product_id": "prod_01H1VECT",
"tax_amount": "10.00",
"tax_rate": "0.10"
}
],
"status": "draft",
"subtotal": "100.00",
"sync_enabled": true,
"tax": "10.00",
"total": "110.00",
"updated_at": "2026-04-01T12:30:00Z",
"accounting_credit_note_id": "<string>",
"accounting_credit_note_url": "<string>",
"accounting_integration_id": "<string>",
"accounting_provider": "<string>",
"apply_date": "2026-03-01T00:00:00Z",
"billing_period_end": "2026-01-31T23:59:59Z",
"billing_period_start": "2026-01-01T00:00:00Z",
"credit_date": "2026-03-01T00:00:00Z",
"invoice_id": "<string>",
"last_refund_date": "2023-11-07T05:31:56Z",
"last_refund_id": "<string>",
"legal_entity_id": "<string>",
"purchase_order_number": "<string>",
"void_date": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"per_page": 20,
"total_pages": 5
}
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}Authorizations
API key authentication. Pass your API key as a Bearer token.
Headers
Available options:
2026-04-01 Query Parameters
Customer ID to list credit notes for
Example:
"cust_01H1VECT"
Number of items to return per page
Example:
20
Number of items to skip
Example:
0
Previous
Create a credit noteCreates a credit note in draft status. Optionally link it to an invoice. Linked paid invoices are supported, and pre-payment credit notes are supported for Alguna-managed invoices in `issued` or `overdue`. Add line items to specify the credited amounts, then apply the credit note to finalize it.
Next
⌘I
List credit notes
curl --request GET \
--url https://api.alguna.io/credit-notes \
--header 'Alguna-Version: <alguna-version>' \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.alguna.io/credit-notes"
headers = {
"Alguna-Version": "<alguna-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Alguna-Version': '<alguna-version>', Authorization: 'Bearer <token>'}
};
fetch('https://api.alguna.io/credit-notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alguna.io/credit-notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Alguna-Version: <alguna-version>",
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.alguna.io/credit-notes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Alguna-Version", "<alguna-version>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.alguna.io/credit-notes")
.header("Alguna-Version", "<alguna-version>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alguna.io/credit-notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"attachments": [
{
"file_url": "<string>",
"title": "Credit Note PDF"
}
],
"created_at": "2026-04-01T10:00:00Z",
"currency": "USD",
"customer_id": "cust_01H1VECT",
"description": "Overcharge credit",
"external_reference": "<string>",
"id": "cn_01H1VECT",
"is_pdf_available": true,
"line_items": [
{
"billing_period_end": "2026-01-31T23:59:59Z",
"billing_period_start": "2026-01-01T00:00:00Z",
"description": "Platform usage credit",
"id": "cnli_01H1VECT",
"is_editable": true,
"quantity": "1",
"total_price": "100.00",
"unit_price": "100.00",
"additional_description": "<string>",
"invoice_line_item_id": "<string>",
"product_id": "prod_01H1VECT",
"tax_amount": "10.00",
"tax_rate": "0.10"
}
],
"status": "draft",
"subtotal": "100.00",
"sync_enabled": true,
"tax": "10.00",
"total": "110.00",
"updated_at": "2026-04-01T12:30:00Z",
"accounting_credit_note_id": "<string>",
"accounting_credit_note_url": "<string>",
"accounting_integration_id": "<string>",
"accounting_provider": "<string>",
"apply_date": "2026-03-01T00:00:00Z",
"billing_period_end": "2026-01-31T23:59:59Z",
"billing_period_start": "2026-01-01T00:00:00Z",
"credit_date": "2026-03-01T00:00:00Z",
"invoice_id": "<string>",
"last_refund_date": "2023-11-07T05:31:56Z",
"last_refund_id": "<string>",
"legal_entity_id": "<string>",
"purchase_order_number": "<string>",
"void_date": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"per_page": 20,
"total_pages": 5
}
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}{
"detail": "<string>",
"status": 123
}