List all invoice rendering templates
GET / v1 / invoice_rendering_templates
List all templates, ordered by creation date, with the most recently created template appearing first.
Parameters
No parameters.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit templates, starting after template starting_after. Each entry in the array is a separate template object. If no more templates are available, the resulting array will be empty.
Response
{ "object": "list", "url": "/v1/invoice_rendering_templates", "has_more": false, "data": [ { "id": "inrtem_abc", "object": "invoice_rendering_template", "nickname": "My Invoice Template", "status": "active", "version": 1, "created": 1678942624, "livemode": false } ]}
Archive an invoice rendering template
POST / v1 / invoice_rendering_templates /:id / archive
Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
Parameters
No parameters.
Returns
The updated template object is returned if successful. Otherwise, this call raises an error.
Response
{ "id": "inrtem_abc", "object": "invoice_rendering_template", "nickname": "My Invoice Template", "status": "active", "version": 1, "created": 1678942624, "livemode": false}
Unarchive an invoice rendering template
POST / v1 / invoice_rendering_templates /:id / unarchive
Unarchive an invoice rendering template so it can be used on new Stripe objects again.
Parameters
No parameters.
Returns
The updated template object is returned if successful. Otherwise, this call raises an error.
Response
{ "id": "inrtem_abc", "object": "invoice_rendering_template", "nickname": "My Invoice Template", "status": "active", "version": 1, "created": 1678942624, "livemode": false}