Skip to content

README.md

Latest commit

 

History

History
108 lines (72 loc) · 2.87 KB

README.md

File metadata and controls

108 lines (72 loc) · 2.87 KB
Raw

list

List all invoice rendering templates

List all templates, ordered by creation date, with the most recently created template appearing first.

API Endpoint: GET /v1/invoice_rendering_templates

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.invoice_rendering_template.list()

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.invoice_rendering_template.list()

get

Retrieve an invoice rendering template

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.

API Endpoint: GET /v1/invoice_rendering_templates/{template}

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.invoice_rendering_template.get(template="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.invoice_rendering_template.get(template="string")

archive

Archive an invoice rendering template

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.

API Endpoint: POST /v1/invoice_rendering_templates/{template}/archive

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.invoice_rendering_template.archive(template="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.invoice_rendering_template.archive(template="string")

unarchive

Unarchive an invoice rendering template

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

API Endpoint: POST /v1/invoice_rendering_templates/{template}/unarchive

Synchronous Client

from os import getenv
from sideko_stripe import Stripe

client = Stripe(token=getenv("API_TOKEN"))
res = client.invoice_rendering_template.unarchive(template="string")

Asynchronous Client

from os import getenv
from sideko_stripe import AsyncStripe

client = AsyncStripe(token=getenv("API_TOKEN"))
res = await client.invoice_rendering_template.unarchive(template="string")