session

Documentation

Overview

Package session provides API functions related to checkout sessions.

Index

• func Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)
• func ListLineItems(id string, params *stripe.CheckoutSessionListLineItemsParams) *lineitem.Iter
• func New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)
• type Client
  • func (c Client) Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)
  • func (c Client) List(listParams *stripe.CheckoutSessionListParams) *Iter
  • func (c Client) ListLineItems(id string, listParams *stripe.CheckoutSessionListLineItemsParams) *lineitem.Iter
  • func (c Client) New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)
• type Iter
  • func List(params *stripe.CheckoutSessionListParams) *Iter
  • func (i *Iter) CheckoutSession() *stripe.CheckoutSession
  • func (i *Iter) CheckoutSessionList() *stripe.CheckoutSessionList

Functions

func Get

func Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)

Get retrieves a session.

func ListLineItems

func ListLineItems(id string, params *stripe.CheckoutSessionListLineItemsParams) *lineitem.Iter

ListLineItems returns a list of line items on a session.

func New

func New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)

New creates a new session.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /checkout_sessions APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)

Get retrieves a session.

func (Client) List

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

List returns a list of sessions.

func (Client) ListLineItems

func (c Client) ListLineItems(id string, listParams *stripe.CheckoutSessionListLineItemsParams) *lineitem.Iter

ListLineItems returns a list of line items on a session.

func (Client) New

func (c Client) New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)

New creates a new session.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for sessions.

func List

func List(params *stripe.CheckoutSessionListParams) *Iter

List returns a list of sessions.

func (*Iter) CheckoutSession

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

CheckoutSession returns the session which the iterator is currently pointing to.

func (*Iter) CheckoutSessionList

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

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