provider GET /v1/credit_notes
@utdk/stripe /v1/credit_notes
List all credit notes
<p>Returns a list of credit notes.</p>
created query
Only return credit notes that were created during the given date interval.
customer query
Only return credit notes for the customer specified by this customer ID.
string
customer_account query
Only return credit notes for the account representing the customer specified by this account ID.
string
ending_before query
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
string
expand query
Specifies which fields in the response should be expanded.
array
invoice query
Only return credit notes for the invoice specified by this invoice ID.
string
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
integer
starting_after query
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getcreditnotes
GET/v1/credit_notes
<p>Returns a list of credit notes.</p>

Only return credit notes that were created during the given date interval.

Only return credit notes for the customer specified by this customer ID.

Only return credit notes for the account representing the customer specified by this account ID.

A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.

Specifies which fields in the response should be expanded.

Only return credit notes for the invoice specified by this invoice ID.

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.getcreditnotes()