alert

Documentation

Overview

Package alert provides the /billing/alerts APIs

Index

• func Activate(id string, params *stripe.BillingAlertActivateParams) (*stripe.BillingAlert, error)
• func Archive(id string, params *stripe.BillingAlertArchiveParams) (*stripe.BillingAlert, error)
• func Deactivate(id string, params *stripe.BillingAlertDeactivateParams) (*stripe.BillingAlert, error)
• func Get(id string, params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)
• func New(params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)
• type Client
  • func (c Client) Activate(id string, params *stripe.BillingAlertActivateParams) (*stripe.BillingAlert, error)
  • func (c Client) Archive(id string, params *stripe.BillingAlertArchiveParams) (*stripe.BillingAlert, error)
  • func (c Client) Deactivate(id string, params *stripe.BillingAlertDeactivateParams) (*stripe.BillingAlert, error)
  • func (c Client) Get(id string, params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)
  • func (c Client) List(listParams *stripe.BillingAlertListParams) *Iter
  • func (c Client) New(params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)
• type Iter
  • func List(params *stripe.BillingAlertListParams) *Iter
  • func (i *Iter) BillingAlert() *stripe.BillingAlert
  • func (i *Iter) BillingAlertList() *stripe.BillingAlertList

Functions

func Activate

func Activate(id string, params *stripe.BillingAlertActivateParams) (*stripe.BillingAlert, error)

Reactivates this alert, allowing it to trigger again.

func Archive

func Archive(id string, params *stripe.BillingAlertArchiveParams) (*stripe.BillingAlert, error)

Archives this alert, removing it from the list view and APIs. This is non-reversible.

func Deactivate

func Deactivate(id string, params *stripe.BillingAlertDeactivateParams) (*stripe.BillingAlert, error)

Deactivates this alert, preventing it from triggering.

func Get

func Get(id string, params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)

Retrieves a billing alert given an ID

func New

func New(params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)

Creates a billing alert

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /billing/alerts APIs.

func (Client) Activate

func (c Client) Activate(id string, params *stripe.BillingAlertActivateParams) (*stripe.BillingAlert, error)

Reactivates this alert, allowing it to trigger again.

func (Client) Archive

func (c Client) Archive(id string, params *stripe.BillingAlertArchiveParams) (*stripe.BillingAlert, error)

Archives this alert, removing it from the list view and APIs. This is non-reversible.

func (Client) Deactivate

func (c Client) Deactivate(id string, params *stripe.BillingAlertDeactivateParams) (*stripe.BillingAlert, error)

Deactivates this alert, preventing it from triggering.

func (Client) Get

func (c Client) Get(id string, params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)

Retrieves a billing alert given an ID

func (Client) List

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

Lists billing active and inactive alerts

func (Client) New

func (c Client) New(params *stripe.BillingAlertParams) (*stripe.BillingAlert, error)

Creates a billing alert

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for billing alerts.

func List

func List(params *stripe.BillingAlertListParams) *Iter

Lists billing active and inactive alerts

func (*Iter) BillingAlert

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

BillingAlert returns the billing alert which the iterator is currently pointing to.

func (*Iter) BillingAlertList

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

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