invoicerenderingtemplate

Documentation

Overview

Package invoicerenderingtemplate provides the /invoice_rendering_templates APIs

Index

• func Archive(id string, params *stripe.InvoiceRenderingTemplateArchiveParams) (*stripe.InvoiceRenderingTemplate, error)
• func Get(id string, params *stripe.InvoiceRenderingTemplateParams) (*stripe.InvoiceRenderingTemplate, error)
• func Unarchive(id string, params *stripe.InvoiceRenderingTemplateUnarchiveParams) (*stripe.InvoiceRenderingTemplate, error)
• type Client
  • func (c Client) Archive(id string, params *stripe.InvoiceRenderingTemplateArchiveParams) (*stripe.InvoiceRenderingTemplate, error)
  • func (c Client) Get(id string, params *stripe.InvoiceRenderingTemplateParams) (*stripe.InvoiceRenderingTemplate, error)
  • func (c Client) List(listParams *stripe.InvoiceRenderingTemplateListParams) *Iter
  • func (c Client) Unarchive(id string, params *stripe.InvoiceRenderingTemplateUnarchiveParams) (*stripe.InvoiceRenderingTemplate, error)
• type Iter
  • func List(params *stripe.InvoiceRenderingTemplateListParams) *Iter
  • func (i *Iter) InvoiceRenderingTemplate() *stripe.InvoiceRenderingTemplate
  • func (i *Iter) InvoiceRenderingTemplateList() *stripe.InvoiceRenderingTemplateList

Functions

func Archive

func Archive(id string, params *stripe.InvoiceRenderingTemplateArchiveParams) (*stripe.InvoiceRenderingTemplate, error)

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.

func Get

func Get(id string, params *stripe.InvoiceRenderingTemplateParams) (*stripe.InvoiceRenderingTemplate, error)

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.

func Unarchive

func Unarchive(id string, params *stripe.InvoiceRenderingTemplateUnarchiveParams) (*stripe.InvoiceRenderingTemplate, error)

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

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /invoice_rendering_templates APIs.

func (Client) Archive

func (c Client) Archive(id string, params *stripe.InvoiceRenderingTemplateArchiveParams) (*stripe.InvoiceRenderingTemplate, error)

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.

func (Client) Get

func (c Client) Get(id string, params *stripe.InvoiceRenderingTemplateParams) (*stripe.InvoiceRenderingTemplate, error)

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.

func (Client) List

func (c Client) List(listParams *stripe.InvoiceRenderingTemplateListParams) *Iter

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

func (Client) Unarchive

func (c Client) Unarchive(id string, params *stripe.InvoiceRenderingTemplateUnarchiveParams) (*stripe.InvoiceRenderingTemplate, error)

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

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for invoice rendering templates.

func List

func List(params *stripe.InvoiceRenderingTemplateListParams) *Iter

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

func (*Iter) InvoiceRenderingTemplate

func (i *Iter) InvoiceRenderingTemplate() *stripe.InvoiceRenderingTemplate

InvoiceRenderingTemplate returns the invoice rendering template which the iterator is currently pointing to.

func (*Iter) InvoiceRenderingTemplateList

func (i *Iter) InvoiceRenderingTemplateList() *stripe.InvoiceRenderingTemplateList

InvoiceRenderingTemplateList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.