creditgrant

Documentation

Overview

Package creditgrant provides the /billing/credit_grants APIs

Index

• func Expire(id string, params *stripe.BillingCreditGrantExpireParams) (*stripe.BillingCreditGrant, error)
• func Get(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)
• func New(params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)
• func Update(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)
• func VoidGrant(id string, params *stripe.BillingCreditGrantVoidGrantParams) (*stripe.BillingCreditGrant, error)
• type Client
  • func (c Client) Expire(id string, params *stripe.BillingCreditGrantExpireParams) (*stripe.BillingCreditGrant, error)
  • func (c Client) Get(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)
  • func (c Client) List(listParams *stripe.BillingCreditGrantListParams) *Iter
  • func (c Client) New(params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)
  • func (c Client) Update(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)
  • func (c Client) VoidGrant(id string, params *stripe.BillingCreditGrantVoidGrantParams) (*stripe.BillingCreditGrant, error)
• type Iter
  • func List(params *stripe.BillingCreditGrantListParams) *Iter
  • func (i *Iter) BillingCreditGrant() *stripe.BillingCreditGrant
  • func (i *Iter) BillingCreditGrantList() *stripe.BillingCreditGrantList

Functions

func Expire

func Expire(id string, params *stripe.BillingCreditGrantExpireParams) (*stripe.BillingCreditGrant, error)

Expires a credit grant

func Get

func Get(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)

Retrieves a credit grant

func New

func New(params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)

Creates a credit grant

func Update

func Update(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)

Updates a credit grant

func VoidGrant

func VoidGrant(id string, params *stripe.BillingCreditGrantVoidGrantParams) (*stripe.BillingCreditGrant, error)

Voids a credit grant

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /billing/credit_grants APIs.

func (Client) Expire

func (c Client) Expire(id string, params *stripe.BillingCreditGrantExpireParams) (*stripe.BillingCreditGrant, error)

Expires a credit grant

func (Client) Get

func (c Client) Get(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)

Retrieves a credit grant

func (Client) List

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

Retrieve a list of credit grants

func (Client) New

func (c Client) New(params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)

Creates a credit grant

func (Client) Update

func (c Client) Update(id string, params *stripe.BillingCreditGrantParams) (*stripe.BillingCreditGrant, error)

Updates a credit grant

func (Client) VoidGrant

func (c Client) VoidGrant(id string, params *stripe.BillingCreditGrantVoidGrantParams) (*stripe.BillingCreditGrant, error)

Voids a credit grant

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for billing credit grants.

func List

func List(params *stripe.BillingCreditGrantListParams) *Iter

Retrieve a list of credit grants

func (*Iter) BillingCreditGrant

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

BillingCreditGrant returns the billing credit grant which the iterator is currently pointing to.

func (*Iter) BillingCreditGrantList

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

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