calculation

Documentation

Overview

Package calculation provides the /tax/calculations APIs

Index

• func Get(id string, params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)
• func New(params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)
  • func (c Client) ListLineItems(listParams *stripe.TaxCalculationListLineItemsParams) *LineItemIter
  • func (c Client) New(params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)
• type LineItemIter
  • func ListLineItems(params *stripe.TaxCalculationListLineItemsParams) *LineItemIter
  • func (i *LineItemIter) TaxCalculationLineItem() *stripe.TaxCalculationLineItem
  • func (i *LineItemIter) TaxCalculationLineItemList() *stripe.TaxCalculationLineItemList

Functions

func Get

func Get(id string, params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)

Retrieves a Tax Calculation object, if the calculation hasn't expired.

func New

func New(params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)

Calculates tax based on the input and returns a Tax Calculation object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /tax/calculations APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)

Retrieves a Tax Calculation object, if the calculation hasn't expired.

func (Client) ListLineItems

func (c Client) ListLineItems(listParams *stripe.TaxCalculationListLineItemsParams) *LineItemIter

Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.

func (Client) New

func (c Client) New(params *stripe.TaxCalculationParams) (*stripe.TaxCalculation, error)

Calculates tax based on the input and returns a Tax Calculation object.

type LineItemIter

type LineItemIter struct {
	*stripe.Iter
}

LineItemIter is an iterator for tax calculation line items.

func ListLineItems

func ListLineItems(params *stripe.TaxCalculationListLineItemsParams) *LineItemIter

Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.

func (*LineItemIter) TaxCalculationLineItem

func (i *LineItemIter) TaxCalculationLineItem() *stripe.TaxCalculationLineItem

TaxCalculationLineItem returns the tax calculation line item which the iterator is currently pointing to.

func (*LineItemIter) TaxCalculationLineItemList

func (i *LineItemIter) TaxCalculationLineItemList() *stripe.TaxCalculationLineItemList

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