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)

Get returns the details of a tax form.

func PDF

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

PDF is the method for the `GET /v1/tax/forms/{id}/pdf` API.

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)

Get returns the details of a tax form.

func (Client) List

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

List returns a list of tax forms.

func (Client) PDF

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

PDF is the method for the `GET /v1/tax/forms/{id}/pdf` API.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for tax forms.

func List

func List(params *stripe.TaxFormListParams) *Iter

List returns a list of tax forms.

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.