Sample - Stripe API
GET/v1/invoice_rendering_templates

List invoice rendering templates

Lists invoice rendering templates ordered by creation date, with the newest template first. Use starting_after or ending_before to paginate the results, limit to control page size, and status to filter active or archived templates.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
ending_beforestringoptional
An object ID cursor that defines the end of the requested page when retrieving previous results.
expandarray<string>optional
Fields to expand in the response.
limitintegeroptional
The maximum number of templates to return. Must be between 1 and 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that defines the start of the requested page when retrieving subsequent results.
statusstringoptional
Filter templates by status: `active` or `archived`.
Allowed:activearchived

2 status codes
200Returns a list object containing invoice rendering templates, the `has_more` pagination flag, the object type, and the list URL.
dataarray<InvoiceRenderingTemplate>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the request cannot be processed; the response contains an API error object with a required `type` field.
errorobjectrequired

Error handling

limit must be between 1 and 100 and defaults to 10 when omitted. status must be either active or archived, and cursor values in starting_after and ending_before must be no longer than 5,000 characters.