Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates can be created from within the Dashboard, and they can be used over the API when creating invoices.
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- livemodeboolean
If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - metadatanullable object
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.
- nicknamenullable string
A brief description of the template, hidden from customers
- statusenum
The status of the template, one of
activeorarchived.Possible enum valuesactivearchived - versioninteger
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}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.
{ "id": "inrtem_abc", "object": "invoice_rendering_template", "nickname": "My Invoice Template", "status": "active", "version": 1, "created": 1678942624, "livemode": false}