financingoffer

Documentation

Overview

Package financingoffer provides the /capital/financing_offers APIs

Index

• func Get(id string, params *stripe.CapitalFinancingOfferParams) (*stripe.CapitalFinancingOffer, error)
• func MarkDelivered(id string, params *stripe.CapitalFinancingOfferMarkDeliveredParams) (*stripe.CapitalFinancingOffer, error)
• type Client
  • func (c Client) Get(id string, params *stripe.CapitalFinancingOfferParams) (*stripe.CapitalFinancingOffer, error)
  • func (c Client) List(listParams *stripe.CapitalFinancingOfferListParams) *Iter
  • func (c Client) MarkDelivered(id string, params *stripe.CapitalFinancingOfferMarkDeliveredParams) (*stripe.CapitalFinancingOffer, error)
• type Iter
  • func List(params *stripe.CapitalFinancingOfferListParams) *Iter
  • func (i *Iter) CapitalFinancingOffer() *stripe.CapitalFinancingOffer
  • func (i *Iter) CapitalFinancingOfferList() *stripe.CapitalFinancingOfferList

Functions

func Get

func Get(id string, params *stripe.CapitalFinancingOfferParams) (*stripe.CapitalFinancingOffer, error)

Get returns the details of a capital financing offer.

func MarkDelivered

func MarkDelivered(id string, params *stripe.CapitalFinancingOfferMarkDeliveredParams) (*stripe.CapitalFinancingOffer, error)

MarkDelivered is the method for the `POST /v1/capital/financing_offers/{financing_offer}/mark_delivered` API.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /capital/financing_offers APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.CapitalFinancingOfferParams) (*stripe.CapitalFinancingOffer, error)

Get returns the details of a capital financing offer.

func (Client) List

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

List returns a list of capital financing offers.

func (Client) MarkDelivered

func (c Client) MarkDelivered(id string, params *stripe.CapitalFinancingOfferMarkDeliveredParams) (*stripe.CapitalFinancingOffer, error)

MarkDelivered is the method for the `POST /v1/capital/financing_offers/{financing_offer}/mark_delivered` API.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for capital financing offers.

func List

func List(params *stripe.CapitalFinancingOfferListParams) *Iter

List returns a list of capital financing offers.

func (*Iter) CapitalFinancingOffer

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

CapitalFinancingOffer returns the capital financing offer which the iterator is currently pointing to.

func (*Iter) CapitalFinancingOfferList

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

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