invoicepayment

Documentation

Overview

Package invoicepayment provides the /invoices/{invoice}/payments APIs

Index

• func Get(id string, params *stripe.InvoicePaymentParams) (*stripe.InvoicePayment, error)
• type Client
  • func (c Client) Get(id string, params *stripe.InvoicePaymentParams) (*stripe.InvoicePayment, error)
  • func (c Client) List(listParams *stripe.InvoicePaymentListParams) *Iter
• type Iter
  • func List(params *stripe.InvoicePaymentListParams) *Iter
  • func (i *Iter) InvoicePayment() *stripe.InvoicePayment
  • func (i *Iter) InvoicePaymentList() *stripe.InvoicePaymentList

Functions

func Get

func Get(id string, params *stripe.InvoicePaymentParams) (*stripe.InvoicePayment, error)

Retrieves the invoice payment with the given ID.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /invoices/{invoice}/payments APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.InvoicePaymentParams) (*stripe.InvoicePayment, error)

Retrieves the invoice payment with the given ID.

func (Client) List

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

When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for invoice payments.

func List

func List(params *stripe.InvoicePaymentListParams) *Iter

When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.

func (*Iter) InvoicePayment

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

InvoicePayment returns the invoice payment which the iterator is currently pointing to.

func (*Iter) InvoicePaymentList

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

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