Documentation ¶
Overview ¶
Package invoice provides the /invoices APIs
Index ¶
- func Del(id string, params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func FinalizeInvoice(id string, params *stripe.InvoiceFinalizeParams) (*stripe.Invoice, error)
- func Get(id string, params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func GetNext(params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func MarkUncollectible(id string, params *stripe.InvoiceMarkUncollectibleParams) (*stripe.Invoice, error)
- func New(params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func Pay(id string, params *stripe.InvoicePayParams) (*stripe.Invoice, error)
- func SendInvoice(id string, params *stripe.InvoiceSendParams) (*stripe.Invoice, error)
- func Update(id string, params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func VoidInvoice(id string, params *stripe.InvoiceVoidParams) (*stripe.Invoice, error)
- type Client
- func (c Client) Del(id string, params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func (c Client) FinalizeInvoice(id string, params *stripe.InvoiceFinalizeParams) (*stripe.Invoice, error)
- func (c Client) Get(id string, params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func (c Client) GetNext(params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func (c Client) List(listParams *stripe.InvoiceListParams) *Iter
- func (c Client) ListLines(listParams *stripe.InvoiceLineListParams) *LineIter
- func (c Client) MarkUncollectible(id string, params *stripe.InvoiceMarkUncollectibleParams) (*stripe.Invoice, error)
- func (c Client) New(params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func (c Client) Pay(id string, params *stripe.InvoicePayParams) (*stripe.Invoice, error)
- func (c Client) SendInvoice(id string, params *stripe.InvoiceSendParams) (*stripe.Invoice, error)
- func (c Client) Update(id string, params *stripe.InvoiceParams) (*stripe.Invoice, error)
- func (c Client) VoidInvoice(id string, params *stripe.InvoiceVoidParams) (*stripe.Invoice, error)
- type Iter
- type LineIter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FinalizeInvoice ¶
FinalizeInvoice finalizes an invoice.
func GetNext ¶
func GetNext(params *stripe.InvoiceParams) (*stripe.Invoice, error)
GetNext returns an upcoming invoice.
func MarkUncollectible ¶
func MarkUncollectible(id string, params *stripe.InvoiceMarkUncollectibleParams) (*stripe.Invoice, error)
MarkUncollectible marks an invoice as uncollectible.
func New ¶
func New(params *stripe.InvoiceParams) (*stripe.Invoice, error)
New creates a new invoice.
func SendInvoice ¶
SendInvoice sends an invoice.
func VoidInvoice ¶
VoidInvoice voids an invoice.
Types ¶
type Client ¶
Client is the client used to invoke /invoices APIs.
func (Client) FinalizeInvoice ¶
func (c Client) FinalizeInvoice(id string, params *stripe.InvoiceFinalizeParams) (*stripe.Invoice, error)
FinalizeInvoice finalizes an invoice.
func (Client) List ¶
func (c Client) List(listParams *stripe.InvoiceListParams) *Iter
List returns a list of invoices.
func (Client) ListLines ¶
func (c Client) ListLines(listParams *stripe.InvoiceLineListParams) *LineIter
ListLines returns a list of line items on an invoice.
func (Client) MarkUncollectible ¶
func (c Client) MarkUncollectible(id string, params *stripe.InvoiceMarkUncollectibleParams) (*stripe.Invoice, error)
MarkUncollectible marks an invoice as uncollectible.
func (Client) SendInvoice ¶
SendInvoice sends an invoice.
func (Client) VoidInvoice ¶
VoidInvoice voids an invoice.
type Iter ¶
Iter is an iterator for invoices.
func (*Iter) InvoiceList ¶
func (i *Iter) InvoiceList() *stripe.InvoiceList
InvoiceList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.
type LineIter ¶
LineIter is an iterator for line items on an invoice.
func ListLines ¶
func ListLines(params *stripe.InvoiceLineListParams) *LineIter
ListLines returns a list of line items on an invoice.
func (*LineIter) InvoiceLine ¶
func (i *LineIter) InvoiceLine() *stripe.InvoiceLine
InvoiceLine returns the line item which the iterator is currently pointing to.
func (*LineIter) InvoiceLineList ¶
func (i *LineIter) InvoiceLineList() *stripe.InvoiceLineList
InvoiceLineList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.