subitem

Documentation

Overview

Package subitem provides the /subscription_items APIs

Index

• func Del(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
• func Get(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
• func New(params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
• func Update(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
• type Client
  • func (c Client) Del(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
  • func (c Client) Get(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
  • func (c Client) List(listParams *stripe.SubscriptionItemListParams) *Iter
  • func (c Client) New(params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
  • func (c Client) Update(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)
• type Iter
  • func List(params *stripe.SubscriptionItemListParams) *Iter
  • func (i *Iter) SubscriptionItem() *stripe.SubscriptionItem
  • func (i *Iter) SubscriptionItemList() *stripe.SubscriptionItemList

Functions

func Del

func Del(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

Del removes a subscription item.

func Get

func Get(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

Get returns the details of a subscription item.

func New

func New(params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

New creates a new subscription item.

func Update

func Update(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

Update updates a subscription item's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /subscriptions APIs.

func (Client) Del

func (c Client) Del(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

Del removes a subscription item.

func (Client) Get

func (c Client) Get(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

Get returns the details of a subscription item.

func (Client) List

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

List returns a list of subscription items.

func (Client) New

func (c Client) New(params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

New creates a new subscription item.

func (Client) Update

func (c Client) Update(id string, params *stripe.SubscriptionItemParams) (*stripe.SubscriptionItem, error)

Update updates a subscription item's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for subscription items.

func List

func List(params *stripe.SubscriptionItemListParams) *Iter

List returns a list of subscription items.

func (*Iter) SubscriptionItem

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

SubscriptionItem returns the subscription item which the iterator is currently pointing to.

func (*Iter) SubscriptionItemList

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

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