coupon

Documentation

Overview

Package coupon provides the /coupons APIs

Index

• func Del(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
• func Get(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
• func New(params *stripe.CouponParams) (*stripe.Coupon, error)
• func Update(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
• type Client
  • func (c Client) Del(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
  • func (c Client) Get(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
  • func (c Client) List(listParams *stripe.CouponListParams) *Iter
  • func (c Client) New(params *stripe.CouponParams) (*stripe.Coupon, error)
  • func (c Client) Update(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
• type Iter
  • func List(params *stripe.CouponListParams) *Iter
  • func (i *Iter) Coupon() *stripe.Coupon
  • func (i *Iter) CouponList() *stripe.CouponList

Functions

func Del

func Del(id string, params *stripe.CouponParams) (*stripe.Coupon, error)

Del removes a coupon.

func Get

func Get(id string, params *stripe.CouponParams) (*stripe.Coupon, error)

Get returns the details of a coupon.

func New

func New(params *stripe.CouponParams) (*stripe.Coupon, error)

New creates a new coupon.

func Update

func Update(id string, params *stripe.CouponParams) (*stripe.Coupon, error)

Update updates a coupon's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /coupons APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.CouponParams) (*stripe.Coupon, error)

Del removes a coupon.

func (Client) Get

func (c Client) Get(id string, params *stripe.CouponParams) (*stripe.Coupon, error)

Get returns the details of a coupon.

func (Client) List

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

List returns a list of coupons.

func (Client) New

func (c Client) New(params *stripe.CouponParams) (*stripe.Coupon, error)

New creates a new coupon.

func (Client) Update

func (c Client) Update(id string, params *stripe.CouponParams) (*stripe.Coupon, error)

Update updates a coupon's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for coupons.

func List

func List(params *stripe.CouponListParams) *Iter

List returns a list of coupons.

func (*Iter) Coupon

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

Coupon returns the coupon which the iterator is currently pointing to.

func (*Iter) CouponList

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

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