price

Documentation

Overview

Package price provides the /prices APIs

Index

• func Get(id string, params *stripe.PriceParams) (*stripe.Price, error)
• func New(params *stripe.PriceParams) (*stripe.Price, error)
• func Update(id string, params *stripe.PriceParams) (*stripe.Price, error)
• type Client
  • func (c Client) Get(id string, params *stripe.PriceParams) (*stripe.Price, error)
  • func (c Client) List(listParams *stripe.PriceListParams) *Iter
  • func (c Client) New(params *stripe.PriceParams) (*stripe.Price, error)
  • func (c Client) Search(params *stripe.PriceSearchParams) *SearchIter
  • func (c Client) Update(id string, params *stripe.PriceParams) (*stripe.Price, error)
• type Iter
  • func List(params *stripe.PriceListParams) *Iter
  • func (i *Iter) Price() *stripe.Price
  • func (i *Iter) PriceList() *stripe.PriceList
• type SearchIter
  • func Search(params *stripe.PriceSearchParams) *SearchIter
  • func (i *SearchIter) Price() *stripe.Price
  • func (i *SearchIter) PriceSearchResult() *stripe.PriceSearchResult

Functions

func Get

func Get(id string, params *stripe.PriceParams) (*stripe.Price, error)

Get returns the details of a price.

func New

func New(params *stripe.PriceParams) (*stripe.Price, error)

New creates a new price.

func Update

func Update(id string, params *stripe.PriceParams) (*stripe.Price, error)

Update updates a price's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /prices APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.PriceParams) (*stripe.Price, error)

Get returns the details of a price.

func (Client) List

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

List returns a list of prices.

func (Client) New

func (c Client) New(params *stripe.PriceParams) (*stripe.Price, error)

New creates a new price.

func (Client) Search

func (c Client) Search(params *stripe.PriceSearchParams) *SearchIter

Search returns a search result containing prices.

func (Client) Update

func (c Client) Update(id string, params *stripe.PriceParams) (*stripe.Price, error)

Update updates a price's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for prices.

func List

func List(params *stripe.PriceListParams) *Iter

List returns a list of prices.

func (*Iter) Price

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

Price returns the price which the iterator is currently pointing to.

func (*Iter) PriceList

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

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

type SearchIter

type SearchIter struct {
	*stripe.SearchIter
}

SearchIter is an iterator for prices.

func Search

func Search(params *stripe.PriceSearchParams) *SearchIter

Search returns a search result containing prices.

func (*SearchIter) Price

func (i *SearchIter) Price() *stripe.Price

Price returns the price which the iterator is currently pointing to.

func (*SearchIter) PriceSearchResult

func (i *SearchIter) PriceSearchResult() *stripe.PriceSearchResult

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