The Invoice Rendering Template object

Attributes

id string Unique identifier for the object.
object string, value is "invoice_rendering_template" String representing the object’s type. Objects of the same type share the same value.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
nickname nullable string A brief description of the template, hidden from customers
status enum The status of the template, one of active or archived. Possible enum values active archived
version integer Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering

{ "id": "inrtem_abc", "object": "invoice_rendering_template", "nickname": "My Invoice Template", "status": "active", "version": 1, "created": 1678942624, "livemode": false}

Retrieve an invoice rendering template

GET / v1 / invoice_rendering_templates /:id

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

Parameters

No parameters.

Returns

Returns an invoice_payment object if a valid invoice payment ID and matching invoice ID were provided. 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}

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 } ]}