Archive an invoice rendering template

Changed on

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.

post/v1/invoice_rendering_templates/{template}/archive

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/invoice_rendering_templates/{template}/archive
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

templatestring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

nicknamestring 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.

versioninteger required

Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.