Sample - Stripe API
POST/v1/invoice_rendering_templates/{template}/unarchive

Unarchive an invoice rendering template

Unarchives an invoice rendering template so it can be used on new objects again. Supply the template identifier and optionally use expand to include selected response fields in expanded form.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
templatestringrequired
The identifier of the invoice rendering template to unarchive. Maximum 5,000 characters.

Optional unarchive request parameters.

expandarray<string>optional
Specifies which fields in the response should be expanded.

2 status codes
200Returns the active invoice rendering template with its identifier, status, object type, version, and other template attributes.
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 the template to unarchive. Values in the body expand field must be strings no longer than 5,000 characters.