event

Documentation

Overview

Package event provides the /events APIs

Index

• func Get(id string, params *stripe.EventParams) (*stripe.Event, error)
• type Client
  • func (c Client) Get(id string, params *stripe.EventParams) (*stripe.Event, error)
  • func (c Client) List(listParams *stripe.EventListParams) *Iter
• type Iter
  • func List(params *stripe.EventListParams) *Iter
  • func (i *Iter) Event() *stripe.Event
  • func (i *Iter) EventList() *stripe.EventList

Functions

func Get

func Get(id string, params *stripe.EventParams) (*stripe.Event, error)

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /events APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.EventParams) (*stripe.Event, error)

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

func (Client) List

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

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for events.

func List

func List(params *stripe.EventListParams) *Iter

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).

func (*Iter) Event

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

Event returns the event which the iterator is currently pointing to.

func (*Iter) EventList

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

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