form

Documentation

Overview

Package form provides the /tax/forms APIs

Index

• func Get(id string, params *stripe.TaxFormParams) (*stripe.TaxForm, error)
• func PDF(id string, params *stripe.TaxFormPDFParams) (*stripe.APIStream, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TaxFormParams) (*stripe.TaxForm, error)
  • func (c Client) List(listParams *stripe.TaxFormListParams) *Iter
  • func (c Client) PDF(id string, params *stripe.TaxFormPDFParams) (*stripe.APIStream, error)
• type Iter
  • func List(params *stripe.TaxFormListParams) *Iter
  • func (i *Iter) TaxForm() *stripe.TaxForm
  • func (i *Iter) TaxFormList() *stripe.TaxFormList

Functions

func Get

func Get(id string, params *stripe.TaxFormParams) (*stripe.TaxForm, error)

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

func PDF

func PDF(id string, params *stripe.TaxFormPDFParams) (*stripe.APIStream, error)

Download the PDF for a tax form.

Types

type Client

type Client struct {
	B        stripe.Backend
	BUploads stripe.Backend
	Key      string
}

Client is used to invoke /tax/forms APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.TaxFormParams) (*stripe.TaxForm, error)

Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.

func (Client) List

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

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

func (Client) PDF

func (c Client) PDF(id string, params *stripe.TaxFormPDFParams) (*stripe.APIStream, error)

Download the PDF for a tax form.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for tax forms.

func List

func List(params *stripe.TaxFormListParams) *Iter

Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.

func (*Iter) TaxForm

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

TaxForm returns the tax form which the iterator is currently pointing to.

func (*Iter) TaxFormList

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

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