coupon

Documentation

Overview

package coupon provides the /coupons APIs

Index

• Constants
• func Del(id string) error
• func Get(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
• func New(params *stripe.CouponParams) (*stripe.Coupon, error)
• type Client
  • func (c Client) Del(id string) error
  • func (c Client) Get(id string, params *stripe.CouponParams) (*stripe.Coupon, error)
  • func (c Client) List(params *stripe.CouponListParams) *Iter
  • func (c Client) New(params *stripe.CouponParams) (*stripe.Coupon, error)
• type Iter
  • func List(params *stripe.CouponListParams) *Iter
  • func (i *Iter) Meta() *stripe.ListMeta
  • func (i *Iter) Next() (*stripe.Coupon, error)
  • func (i *Iter) Stop() bool

Constants

const (
	Forever   stripe.CouponDuration = "forever"
	Once      stripe.CouponDuration = "once"
	Repeating stripe.CouponDuration = "repeating"
)

Functions

func Del

func Del(id string) error

Del removes a coupon. For more details see https://stripe.com/docs/api#delete_coupon.

func Get

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

Get returns the details of a coupon. For more details see https://stripe.com/docs/api#retrieve_coupon.

func New

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

New POSTs new coupons. For more details see https://stripe.com/docs/api#create_coupon.

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) error

func (Client) Get

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

func (Client) List

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

func (Client) New

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

type Iter

type Iter struct {
	Iter *stripe.Iter
}

Iter is a iterator for list responses.

func List

func List(params *stripe.CouponListParams) *Iter

List returns a list of coupons. For more details see https://stripe.com/docs/api#list_coupons.

func (*Iter) Meta

func (i *Iter) Meta() *stripe.ListMeta

Meta returns the list metadata.

func (*Iter) Next

func (i *Iter) Next() (*stripe.Coupon, error)

Next returns the next value in the list.

func (*Iter) Stop

func (i *Iter) Stop() bool

Stop returns true if there are no more iterations to be performed.