topup

Documentation

Overview

Package topup provides the /topups APIs

Index

• func Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• func Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• func New(params *stripe.TopupParams) (*stripe.Topup, error)
• func Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)
  • func (c Client) Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)
  • func (c Client) List(listParams *stripe.TopupListParams) *Iter
  • func (c Client) New(params *stripe.TopupParams) (*stripe.Topup, error)
  • func (c Client) Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• type Iter
  • func List(params *stripe.TopupListParams) *Iter
  • func (i *Iter) Topup() *stripe.Topup
  • func (i *Iter) TopupList() *stripe.TopupList

Functions

func Cancel

func Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Cancel is the method for the `POST /v1/topups/{topup}/cancel` API.

func Get

func Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Get returns the details of a topup.

func New

func New(params *stripe.TopupParams) (*stripe.Topup, error)

New creates a new topup.

func Update

func Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Update updates a topup's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /topups APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Cancel is the method for the `POST /v1/topups/{topup}/cancel` API.

func (Client) Get

func (c Client) Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Get returns the details of a topup.

func (Client) List

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

List returns a list of topups.

func (Client) New

func (c Client) New(params *stripe.TopupParams) (*stripe.Topup, error)

New creates a new topup.

func (Client) Update

func (c Client) Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Update updates a topup's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for topups.

func List

func List(params *stripe.TopupListParams) *Iter

List returns a list of topups.

func (*Iter) Topup

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

Topup returns the topup which the iterator is currently pointing to.

func (*Iter) TopupList

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

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