shippingrate

Documentation

Overview

Package shippingrate provides the /shipping_rates APIs

Index

• func Get(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)
• func New(params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)
• func Update(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)
• type Client
  • func (c Client) Get(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)
  • func (c Client) List(listParams *stripe.ShippingRateListParams) *Iter
  • func (c Client) New(params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)
  • func (c Client) Update(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)
• type Iter
  • func List(params *stripe.ShippingRateListParams) *Iter
  • func (i *Iter) ShippingRate() *stripe.ShippingRate
  • func (i *Iter) ShippingRateList() *stripe.ShippingRateList

Functions

func Get

func Get(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)

Returns the shipping rate object with the given ID.

func New

func New(params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)

Creates a new shipping rate object.

func Update

func Update(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)

Updates an existing shipping rate object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /shipping_rates APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)

Returns the shipping rate object with the given ID.

func (Client) List

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

Returns a list of your shipping rates.

func (Client) New

func (c Client) New(params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)

Creates a new shipping rate object.

func (Client) Update

func (c Client) Update(id string, params *stripe.ShippingRateParams) (*stripe.ShippingRate, error)

Updates an existing shipping rate object.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for shipping rates.

func List

func List(params *stripe.ShippingRateListParams) *Iter

Returns a list of your shipping rates.

func (*Iter) ShippingRate

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

ShippingRate returns the shipping rate which the iterator is currently pointing to.

func (*Iter) ShippingRateList

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

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