customerbalancetransaction

Documentation

Overview

Package customerbalancetransaction provides the /customers/{customer}/balance_transactions APIs

Index

• func Get(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)
• func New(params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)
• func Update(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)
• type Client
  • func (c Client) Get(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)
  • func (c Client) List(listParams *stripe.CustomerBalanceTransactionListParams) *Iter
  • func (c Client) New(params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)
  • func (c Client) Update(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)
• type Iter
  • func List(params *stripe.CustomerBalanceTransactionListParams) *Iter
  • func (i *Iter) CustomerBalanceTransaction() *stripe.CustomerBalanceTransaction
  • func (i *Iter) CustomerBalanceTransactionList() *stripe.CustomerBalanceTransactionList

Functions

func Get

func Get(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)

Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).

func New

func New(params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)

Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).

func Update

func Update(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)

Most credit balance transaction fields are immutable, but you may update its description and metadata.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /customers/{customer}/balance_transactions APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)

Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).

func (Client) List

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

Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).

func (Client) New

func (c Client) New(params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)

Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).

func (Client) Update

func (c Client) Update(id string, params *stripe.CustomerBalanceTransactionParams) (*stripe.CustomerBalanceTransaction, error)

Most credit balance transaction fields are immutable, but you may update its description and metadata.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for customer balance transactions.

func List

func List(params *stripe.CustomerBalanceTransactionListParams) *Iter

Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).

func (*Iter) CustomerBalanceTransaction

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

CustomerBalanceTransaction returns the customer balance transaction which the iterator is currently pointing to.

func (*Iter) CustomerBalanceTransactionList

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

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