---
title: "Archive an invoice rendering template"
method: POST
path: "/v1/invoice_rendering_templates/{template}/archive"
---

# Archive an invoice rendering template

`POST /v1/invoice_rendering_templates/{template}/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.

## Path parameters

- `template` string, required

## Response `200`

Successful response.

- InvoiceRenderingTemplate — 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.
  - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch.
  - `id` string, required — Unique identifier for the object.
  - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
  - `metadata` object, nullable — 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.
  - `nickname` string, nullable — A brief description of the template, hidden from customers
  - `object` 'invoice_rendering_template', required — String representing the object's type. Objects of the same type share the same value.
  - `status` 'active' | 'archived', required — The status of the template, one of `active` or `archived`.
  - `version` integer, required — Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/stripe/apis/spec3.md) · [All operations](https://skmtc.net/stripe/apis/spec3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/spec3/revisions/3653ad45bbec/schema)