How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Stripe

Stripe Credit Notes API

Issue a credit note to adjust an invoice's amount after the invoice is finalized.

Provider Profile APIs.io OpenAPI GitHub

Stripe Credit Notes API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credit and Notes. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 8 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

8 operations 6 paths 12 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Contact
Stripe Dev Platform Team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Stripe Credit Notes API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Credit Notes 8
GET
/v1/credit_notes
Returns a list of credit notes.
GetCreditNotes 6 params body → 200default
POST
/v1/credit_notes
Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amountdue . For a status=paid invoice, a credit note does not affect its amountdu…
PostCreditNotes body → 200default
GET
/v1/credit_notes/preview
Get a preview of a credit note without creating it.
GetCreditNotesPreview 13 params body → 200default
GET
/v1/credit_notes/preview/lines
When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
GetCreditNotesPreviewLines 16 params body → 200default
GET
/v1/credit_notes/{credit_note}/lines
When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
GetCreditNotesCreditNoteLines 5 params body → 200default
GET
/v1/credit_notes/{id}
Retrieves the credit note object with the given identifier.
GetCreditNotesId 2 params body → 200default
POST
/v1/credit_notes/{id}
Updates an existing credit note.
PostCreditNotesId 1 param body → 200default
POST
/v1/credit_notes/{id}/void
Marks a credit note as void. Learn more about voiding credit notes .
PostCreditNotesIdVoid 1 param body → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are credit_note (30 properties), PostCreditNotesRequest (13 properties), CreditNotesList (4 properties), CreditNoteLinesList (4 properties). Each schema is shown below with its type and property counts.

CreditNoteLinesList
object
4 properties 4 required
credit_note
object
Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit…
30 properties 19 required
GetCreditNotesCreditNoteLinesRequest
object
CreditNotesList
object
4 properties 4 required
GetCreditNotesPreviewRequest
object
error
object
An error response from the Stripe API
1 property 1 required
GetCreditNotesIdRequest
object
PostCreditNotesRequest
object
13 properties 1 required
PostCreditNotesIdVoidRequest
object
1 property
PostCreditNotesIdRequest
object
3 properties
GetCreditNotesRequest
object
GetCreditNotesPreviewLinesRequest
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-credit-notes-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
AE Profile APIs.io
Stripe Balance API
AE Profile APIs.io
Stripe Billing API
AE Profile APIs.io
Stripe Charges API
AE Profile APIs.io
Stripe Checkout API
AE Profile APIs.io
Stripe Climate API
AE Profile APIs.io
Stripe Country API
AE Profile APIs.io
Stripe Coupons API
AE Profile APIs.io
Stripe Customers API
AE Profile APIs.io
Stripe Disputes API
AE Profile APIs.io
Stripe Ephemeral Keys API
AE Profile APIs.io
Stripe Events API
AE Profile APIs.io
#Credit#Notes
← Back to S APIs
API Details
ID
stripe:stripe-credit-notes-api
Server
https://api.stripe.com/
Provider
Stripe
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=stripe-credit-notes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/stripe-credit-notes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Stripe Credit Notes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.