transaction

Documentation

Overview

Package transaction provides the /tax/transactions APIs

Index

• func CreateFromCalculation(params *stripe.TaxTransactionCreateFromCalculationParams) (*stripe.TaxTransaction, error)
• func CreateReversal(params *stripe.TaxTransactionCreateReversalParams) (*stripe.TaxTransaction, error)
• func Get(id string, params *stripe.TaxTransactionParams) (*stripe.TaxTransaction, error)
• type Client
  • func (c Client) CreateFromCalculation(params *stripe.TaxTransactionCreateFromCalculationParams) (*stripe.TaxTransaction, error)
  • func (c Client) CreateReversal(params *stripe.TaxTransactionCreateReversalParams) (*stripe.TaxTransaction, error)
  • func (c Client) Get(id string, params *stripe.TaxTransactionParams) (*stripe.TaxTransaction, error)
  • func (c Client) ListLineItems(listParams *stripe.TaxTransactionListLineItemsParams) *LineItemIter
• type LineItemIter
  • func ListLineItems(params *stripe.TaxTransactionListLineItemsParams) *LineItemIter
  • func (i *LineItemIter) TaxTransactionLineItem() *stripe.TaxTransactionLineItem
  • func (i *LineItemIter) TaxTransactionLineItemList() *stripe.TaxTransactionLineItemList

Functions

func CreateFromCalculation

func CreateFromCalculation(params *stripe.TaxTransactionCreateFromCalculationParams) (*stripe.TaxTransaction, error)

Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.

func CreateReversal

func CreateReversal(params *stripe.TaxTransactionCreateReversalParams) (*stripe.TaxTransaction, error)

Partially or fully reverses a previously created Transaction.

func Get

func Get(id string, params *stripe.TaxTransactionParams) (*stripe.TaxTransaction, error)

Retrieves a Tax Transaction object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /tax/transactions APIs.

func (Client) CreateFromCalculation

func (c Client) CreateFromCalculation(params *stripe.TaxTransactionCreateFromCalculationParams) (*stripe.TaxTransaction, error)

Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days.

func (Client) CreateReversal

func (c Client) CreateReversal(params *stripe.TaxTransactionCreateReversalParams) (*stripe.TaxTransaction, error)

Partially or fully reverses a previously created Transaction.

func (Client) Get

func (c Client) Get(id string, params *stripe.TaxTransactionParams) (*stripe.TaxTransaction, error)

Retrieves a Tax Transaction object.

func (Client) ListLineItems

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

Retrieves the line items of a committed standalone transaction as a collection.

type LineItemIter

type LineItemIter struct {
	*stripe.Iter
}

LineItemIter is an iterator for tax transaction line items.

func ListLineItems

func ListLineItems(params *stripe.TaxTransactionListLineItemsParams) *LineItemIter

Retrieves the line items of a committed standalone transaction as a collection.

func (*LineItemIter) TaxTransactionLineItem

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

TaxTransactionLineItem returns the tax transaction line item which the iterator is currently pointing to.

func (*LineItemIter) TaxTransactionLineItemList

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

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