plan

Documentation

Overview

Package plan provides the /plans APIs

Index

• Constants
• func Del(id string) error
• func Get(id string, params *stripe.PlanParams) (*stripe.Plan, error)
• func New(params *stripe.PlanParams) (*stripe.Plan, error)
• func Update(id string, params *stripe.PlanParams) (*stripe.Plan, error)
• type Client
  • func (c Client) Del(id string) error
  • func (c Client) Get(id string, params *stripe.PlanParams) (*stripe.Plan, error)
  • func (c Client) List(params *stripe.PlanListParams) *Iter
  • func (c Client) New(params *stripe.PlanParams) (*stripe.Plan, error)
  • func (c Client) Update(id string, params *stripe.PlanParams) (*stripe.Plan, error)
• type Iter
  • func List(params *stripe.PlanListParams) *Iter
  • func (i *Iter) Plan() *stripe.Plan

Constants

const (
	Day   stripe.PlanInterval = "day"
	Week  stripe.PlanInterval = "week"
	Month stripe.PlanInterval = "month"
	Year  stripe.PlanInterval = "year"
)

Functions

func Del

func Del(id string) error

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

func Get

func Get(id string, params *stripe.PlanParams) (*stripe.Plan, error)

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

func New

func New(params *stripe.PlanParams) (*stripe.Plan, error)

New POSTs a new plan. For more details see https://stripe.com/docs/api#create_plan.

func Update

func Update(id string, params *stripe.PlanParams) (*stripe.Plan, error)

Update updates a plan's properties. For more details see https://stripe.com/docs/api#update_plan.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /plans APIs.

func (Client) Del

func (c Client) Del(id string) error

func (Client) Get

func (c Client) Get(id string, params *stripe.PlanParams) (*stripe.Plan, error)

func (Client) List

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

func (Client) New

func (c Client) New(params *stripe.PlanParams) (*stripe.Plan, error)

func (Client) Update

func (c Client) Update(id string, params *stripe.PlanParams) (*stripe.Plan, error)

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for lists of Plans. The embedded Iter carries methods with it; see its documentation for details.

func List

func List(params *stripe.PlanListParams) *Iter

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

func (*Iter) Plan

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

Plan returns the most recent Plan visited by a call to Next.