receivedcredit

Documentation

Overview

Package receivedcredit provides the /treasury/received_credits APIs

Index

• func Get(id string, params *stripe.TreasuryReceivedCreditParams) (*stripe.TreasuryReceivedCredit, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TreasuryReceivedCreditParams) (*stripe.TreasuryReceivedCredit, error)
  • func (c Client) List(listParams *stripe.TreasuryReceivedCreditListParams) *Iter
• type Iter
  • func List(params *stripe.TreasuryReceivedCreditListParams) *Iter
  • func (i *Iter) TreasuryReceivedCredit() *stripe.TreasuryReceivedCredit
  • func (i *Iter) TreasuryReceivedCreditList() *stripe.TreasuryReceivedCreditList

Functions

func Get

func Get(id string, params *stripe.TreasuryReceivedCreditParams) (*stripe.TreasuryReceivedCredit, error)

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/received_credits APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.TreasuryReceivedCreditParams) (*stripe.TreasuryReceivedCredit, error)

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

func (Client) List

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

Returns a list of ReceivedCredits.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for treasury received credits.

func List

func List(params *stripe.TreasuryReceivedCreditListParams) *Iter

Returns a list of ReceivedCredits.

func (*Iter) TreasuryReceivedCredit

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

TreasuryReceivedCredit returns the treasury received credit which the iterator is currently pointing to.

func (*Iter) TreasuryReceivedCreditList

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

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