feature

Documentation

Overview

Package feature provides the /entitlements/features APIs

Index

• func Get(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)
• func New(params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)
• func Update(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)
• type Client
  • func (c Client) Get(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)
  • func (c Client) List(listParams *stripe.EntitlementsFeatureListParams) *Iter
  • func (c Client) New(params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)
  • func (c Client) Update(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)
• type Iter
  • func List(params *stripe.EntitlementsFeatureListParams) *Iter
  • func (i *Iter) EntitlementsFeature() *stripe.EntitlementsFeature
  • func (i *Iter) EntitlementsFeatureList() *stripe.EntitlementsFeatureList

Functions

func Get

func Get(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)

Retrieves a feature

func New

func New(params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)

Creates a feature

func Update

func Update(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)

Update a feature's metadata or permanently deactivate it.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /entitlements/features APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)

Retrieves a feature

func (Client) List

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

Retrieve a list of features

func (Client) New

func (c Client) New(params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)

Creates a feature

func (Client) Update

func (c Client) Update(id string, params *stripe.EntitlementsFeatureParams) (*stripe.EntitlementsFeature, error)

Update a feature's metadata or permanently deactivate it.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for entitlements features.

func List

func List(params *stripe.EntitlementsFeatureListParams) *Iter

Retrieve a list of features

func (*Iter) EntitlementsFeature

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

EntitlementsFeature returns the entitlements feature which the iterator is currently pointing to.

func (*Iter) EntitlementsFeatureList

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

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