Sample - Stripe API
GET/v1/invoice_rendering_templates/{template}

Retrieve an invoice rendering template

Retrieves an invoice rendering template by ID and returns its latest version by default. Supply version to retrieve a previous version, and use expand when you need selected response fields expanded.

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

3 parameters
templatestringrequired
The identifier of the invoice rendering template to retrieve. Maximum 5,000 characters.
expandarray<string>optional
Fields to expand in the response.
versionintegeroptional
The template version to retrieve; omit it to retrieve the latest version.

2 status codes
200Returns an invoice rendering template containing its identifier, creation time, mode, nickname, status, object type, and version.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
nicknamestringoptional
A brief description of the template, hidden from customers
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:invoice_rendering_template
statusstringrequired
The status of the template, one of `active` or `archived`.
Allowed:activearchived
versionintegerrequired
Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
defaultReturned when the request cannot be processed; the response contains an API error object with a required `type` field.
errorobjectrequired

Error handling

template must be a string no longer than 5,000 characters and must identify an existing invoice rendering template. version must be an integer when supplied, and values in expand must be strings no longer than 5,000 characters.