sub

Documentation

Overview

Package sub provides the /subscriptions APIs

Index

• Constants
• func Cancel(id string, params *stripe.SubParams) error
• func Get(id string, params *stripe.SubParams) (*stripe.Sub, error)
• func New(params *stripe.SubParams) (*stripe.Sub, error)
• func Update(id string, params *stripe.SubParams) (*stripe.Sub, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.SubParams) error
  • func (c Client) Get(id string, params *stripe.SubParams) (*stripe.Sub, error)
  • func (c Client) List(params *stripe.SubListParams) *Iter
  • func (c Client) New(params *stripe.SubParams) (*stripe.Sub, error)
  • func (c Client) Update(id string, params *stripe.SubParams) (*stripe.Sub, error)
• type Iter
  • func List(params *stripe.SubListParams) *Iter
  • func (i *Iter) Meta() *stripe.ListMeta
  • func (i *Iter) Next() (*stripe.Sub, error)
  • func (i *Iter) Stop() bool

Constants

const (
	Trialing stripe.SubStatus = "trialing"
	Active   stripe.SubStatus = "active"
	PastDue  stripe.SubStatus = "past_due"
	Canceled stripe.SubStatus = "canceled"
	Unpaid   stripe.SubStatus = "unpaid"
)

Functions

func Cancel

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

Cancel removes a subscription. For more details see https://stripe.com/docs/api#cancel_subscription.

func Get

func Get(id string, params *stripe.SubParams) (*stripe.Sub, error)

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

func New

func New(params *stripe.SubParams) (*stripe.Sub, error)

New POSTS a new subscription for a customer. For more details see https://stripe.com/docs/api#create_subscription.

func Update

func Update(id string, params *stripe.SubParams) (*stripe.Sub, error)

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

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /subscriptions APIs.

func (Client) Cancel

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

func (Client) Get

func (c Client) Get(id string, params *stripe.SubParams) (*stripe.Sub, error)

func (Client) List

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

func (Client) New

func (c Client) New(params *stripe.SubParams) (*stripe.Sub, error)

func (Client) Update

func (c Client) Update(id string, params *stripe.SubParams) (*stripe.Sub, error)

type Iter

type Iter struct {
	Iter *stripe.Iter
}

Iter is a iterator for list responses.

func List

func List(params *stripe.SubListParams) *Iter

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

func (*Iter) Meta

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

Meta returns the list metadata.

func (*Iter) Next

func (i *Iter) Next() (*stripe.Sub, 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.