meter

Documentation

Overview

Package meter provides the /billing/meters APIs

Index

• func Deactivate(id string, params *stripe.BillingMeterDeactivateParams) (*stripe.BillingMeter, error)
• func Get(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)
• func New(params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)
• func Reactivate(id string, params *stripe.BillingMeterReactivateParams) (*stripe.BillingMeter, error)
• func Update(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)
• type Client
  • func (c Client) Deactivate(id string, params *stripe.BillingMeterDeactivateParams) (*stripe.BillingMeter, error)
  • func (c Client) Get(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)
  • func (c Client) List(listParams *stripe.BillingMeterListParams) *Iter
  • func (c Client) New(params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)
  • func (c Client) Reactivate(id string, params *stripe.BillingMeterReactivateParams) (*stripe.BillingMeter, error)
  • func (c Client) Update(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)
• type Iter
  • func List(params *stripe.BillingMeterListParams) *Iter
  • func (i *Iter) BillingMeter() *stripe.BillingMeter
  • func (i *Iter) BillingMeterList() *stripe.BillingMeterList

Functions

func Deactivate

func Deactivate(id string, params *stripe.BillingMeterDeactivateParams) (*stripe.BillingMeter, error)

When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.

func Get

func Get(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)

Retrieves a billing meter given an ID.

func New

func New(params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)

Creates a billing meter.

func Reactivate

func Reactivate(id string, params *stripe.BillingMeterReactivateParams) (*stripe.BillingMeter, error)

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

func Update

func Update(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)

Updates a billing meter.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /billing/meters APIs.

func (Client) Deactivate

func (c Client) Deactivate(id string, params *stripe.BillingMeterDeactivateParams) (*stripe.BillingMeter, error)

When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.

func (Client) Get

func (c Client) Get(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)

Retrieves a billing meter given an ID.

func (Client) List

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

Retrieve a list of billing meters.

func (Client) New

func (c Client) New(params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)

Creates a billing meter.

func (Client) Reactivate

func (c Client) Reactivate(id string, params *stripe.BillingMeterReactivateParams) (*stripe.BillingMeter, error)

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

func (Client) Update

func (c Client) Update(id string, params *stripe.BillingMeterParams) (*stripe.BillingMeter, error)

Updates a billing meter.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for billing meters.

func List

func List(params *stripe.BillingMeterListParams) *Iter

Retrieve a list of billing meters.

func (*Iter) BillingMeter

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

BillingMeter returns the billing meter which the iterator is currently pointing to.

func (*Iter) BillingMeterList

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

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