import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.invoices.issueCreditNote({
invoiceId: "inv_2b3c4d5e6f7g8h",
lines: [
{
id: "invoice_li_2b3c4d5e6f7g8h",
amount: 20,
},
],
destination: "refund",
reason: "product_unsatisfactory",
memo: "Partial refund for degraded service",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.invoices.issue_credit_note(
invoice_id="inv_2b3c4d5e6f7g8h",
lines=[
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"amount": 20,
},
],
destination="refund",
send_email=True,
reason="product_unsatisfactory",
memo="Partial refund for degraded service",
)curl --request POST \
--url https://api.useautumn.com/v1/invoices.issue_credit_note \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"invoice_id": "inv_2b3c4d5e6f7g8h",
"lines": [
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"amount": 20
}
],
"destination": "refund",
"send_email": true,
"reason": "product_unsatisfactory",
"memo": "Partial refund for degraded service"
}
'{
"credit_note": {
"id": "cn_1MxvRqLkdIwHu7ixY0xbUcxk",
"invoice_id": "inv_2b3c4d5e6f7g8h",
"number": "ABC-0001-CN-01",
"status": "issued",
"currency": "usd",
"subtotal": 20,
"discount_amount": 0,
"tax_amount": 0,
"total": 20,
"pre_payment_amount": 0,
"post_payment_amount": 20,
"refund_amount": 20,
"credit_amount": 0,
"out_of_band_amount": 0,
"reason": "product_unsatisfactory",
"memo": "Partial refund for degraded service",
"pdf": "https://pay.stripe.com/credit_notes/acct_123/test_456/pdf",
"lines": [
{
"invoice_line_item_id": "invoice_li_2b3c4d5e6f7g8h",
"description": "Pro plan",
"quantity": null,
"amount": 20,
"discount_amount": 0
}
]
}
}
Issue Credit Note
Issues a Stripe credit note against an open or paid invoice, for a flat amount or for specific invoice lines. On an open invoice the credit reduces what is still owed. On a paid invoice the credited money goes to the chosen destination: the customer’s balance (default), a refund, or a record of money returned outside Stripe. Line amounts are pre-discount and pre-tax, like the invoice’s own item amounts. Pass preview to see the credit note without issuing it.
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.invoices.issueCreditNote({
invoiceId: "inv_2b3c4d5e6f7g8h",
lines: [
{
id: "invoice_li_2b3c4d5e6f7g8h",
amount: 20,
},
],
destination: "refund",
reason: "product_unsatisfactory",
memo: "Partial refund for degraded service",
});from autumn_sdk import Autumn
autumn = Autumn(secret_key="am_sk_test...")
res = autumn.invoices.issue_credit_note(
invoice_id="inv_2b3c4d5e6f7g8h",
lines=[
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"amount": 20,
},
],
destination="refund",
send_email=True,
reason="product_unsatisfactory",
memo="Partial refund for degraded service",
)curl --request POST \
--url https://api.useautumn.com/v1/invoices.issue_credit_note \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"invoice_id": "inv_2b3c4d5e6f7g8h",
"lines": [
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"amount": 20
}
],
"destination": "refund",
"send_email": true,
"reason": "product_unsatisfactory",
"memo": "Partial refund for degraded service"
}
'{
"credit_note": {
"id": "cn_1MxvRqLkdIwHu7ixY0xbUcxk",
"invoice_id": "inv_2b3c4d5e6f7g8h",
"number": "ABC-0001-CN-01",
"status": "issued",
"currency": "usd",
"subtotal": 20,
"discount_amount": 0,
"tax_amount": 0,
"total": 20,
"pre_payment_amount": 0,
"post_payment_amount": 20,
"refund_amount": 20,
"credit_amount": 0,
"out_of_band_amount": 0,
"reason": "product_unsatisfactory",
"memo": "Partial refund for degraded service",
"pdf": "https://pay.stripe.com/credit_notes/acct_123/test_456/pdf",
"lines": [
{
"invoice_line_item_id": "invoice_li_2b3c4d5e6f7g8h",
"description": "Pro plan",
"quantity": null,
"amount": 20,
"discount_amount": 0
}
]
}
}
Body Parameters
Response
{
"credit_note": {
"id": "cn_1MxvRqLkdIwHu7ixY0xbUcxk",
"invoice_id": "inv_2b3c4d5e6f7g8h",
"number": "ABC-0001-CN-01",
"status": "issued",
"currency": "usd",
"subtotal": 20,
"discount_amount": 0,
"tax_amount": 0,
"total": 20,
"pre_payment_amount": 0,
"post_payment_amount": 20,
"refund_amount": 20,
"credit_amount": 0,
"out_of_band_amount": 0,
"reason": "product_unsatisfactory",
"memo": "Partial refund for degraded service",
"pdf": "https://pay.stripe.com/credit_notes/acct_123/test_456/pdf",
"lines": [
{
"invoice_line_item_id": "invoice_li_2b3c4d5e6f7g8h",
"description": "Pro plan",
"quantity": null,
"amount": 20,
"discount_amount": 0
}
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
The Autumn invoice ID to credit. Must be open or paid.
Total to credit across the whole invoice. Cannot be combined with lines.
Credit specific invoice lines instead of a flat amount. Cannot be combined with amount. Unavailable on invoices recorded before line item storage.
1Show child attributes
Show child attributes
Where already-paid money goes. customer_balance credits the customer's balance for their next invoice, refund returns it to the original payment method, and out_of_band records money returned outside Stripe.
customer_balance, refund, out_of_band Email the credit note to the customer.
Reason shown on the credit note.
duplicate, fraudulent, order_change, product_unsatisfactory Memo printed on the credit note PDF.
Return the credit note that would be issued without creating it.
Response
OK
Show child attributes
Show child attributes