activeentitlement

Documentation

Overview

Package activeentitlement provides the /entitlements/active_entitlements APIs

Index

• func Get(id string, params *stripe.EntitlementsActiveEntitlementParams) (*stripe.EntitlementsActiveEntitlement, error)
• type Client
  • func (c Client) Get(id string, params *stripe.EntitlementsActiveEntitlementParams) (*stripe.EntitlementsActiveEntitlement, error)
  • func (c Client) List(listParams *stripe.EntitlementsActiveEntitlementListParams) *Iter
• type Iter
  • func List(params *stripe.EntitlementsActiveEntitlementListParams) *Iter
  • func (i *Iter) EntitlementsActiveEntitlement() *stripe.EntitlementsActiveEntitlement
  • func (i *Iter) EntitlementsActiveEntitlementList() *stripe.EntitlementsActiveEntitlementList

Functions

func Get

func Get(id string, params *stripe.EntitlementsActiveEntitlementParams) (*stripe.EntitlementsActiveEntitlement, error)

Retrieve an active entitlement

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /entitlements/active_entitlements APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.EntitlementsActiveEntitlementParams) (*stripe.EntitlementsActiveEntitlement, error)

Retrieve an active entitlement

func (Client) List

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

Retrieve a list of active entitlements for a customer

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for entitlements active entitlements.

func List

func List(params *stripe.EntitlementsActiveEntitlementListParams) *Iter

Retrieve a list of active entitlements for a customer

func (*Iter) EntitlementsActiveEntitlement

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

EntitlementsActiveEntitlement returns the entitlements active entitlement which the iterator is currently pointing to.

func (*Iter) EntitlementsActiveEntitlementList

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

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