session

Documentation

Overview

Package session provides the /checkout/sessions APIs

Index

• func Expire(id string, params *stripe.CheckoutSessionExpireParams) (*stripe.CheckoutSession, error)
• func Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)
• func New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error)
• type Client
  • func (c Client) Expire(id string, params *stripe.CheckoutSessionExpireParams) (*stripe.CheckoutSession, error)
  • 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) *LineItemIter
  • 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
• type LineItemIter
  • func ListLineItems(id string, params *stripe.CheckoutSessionListLineItemsParams) *LineItemIter

Functions

func Expire

func Expire(id string, params *stripe.CheckoutSessionExpireParams) (*stripe.CheckoutSession, error)

Expire is the method for the `POST /v1/checkout/sessions/{session}/expire` API.

func Get

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

Get returns the details of a checkout session.

func New

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

New creates a new checkout session.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /checkout/sessions APIs.

func (Client) Expire

func (c Client) Expire(id string, params *stripe.CheckoutSessionExpireParams) (*stripe.CheckoutSession, error)

Expire is the method for the `POST /v1/checkout/sessions/{session}/expire` API.

func (Client) Get

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

Get returns the details of a checkout session.

func (Client) List

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

List returns a list of checkout sessions.

func (Client) ListLineItems

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

ListLineItems is the method for the `GET /v1/checkout/sessions/{session}/line_items` API.

func (Client) New

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

New creates a new checkout session.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for checkout sessions.

func List

func List(params *stripe.CheckoutSessionListParams) *Iter

List returns a list of checkout sessions.

func (*Iter) CheckoutSession

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

CheckoutSession returns the checkout 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.

type LineItemIter

type LineItemIter = lineitem.Iter

func ListLineItems

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

ListLineItems is the method for the `GET /v1/checkout/sessions/{session}/line_items` API.