creditnote

Documentation

Overview

Package creditnote provides the /credit_notes APIs

Index

• func Get(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)
• func New(params *stripe.CreditNoteParams) (*stripe.CreditNote, error)
• func Preview(params *stripe.CreditNotePreviewParams) (*stripe.CreditNote, error)
• func Update(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)
• func VoidCreditNote(id string, params *stripe.CreditNoteVoidParams) (*stripe.CreditNote, error)
• type Client
  • func (c Client) Get(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)
  • func (c Client) List(listParams *stripe.CreditNoteListParams) *Iter
  • func (c Client) ListLines(listParams *stripe.CreditNoteLineItemListParams) *LineItemIter
  • func (c Client) ListPreviewLines(listParams *stripe.CreditNoteLineItemListPreviewParams) *LineItemIter
  • func (c Client) New(params *stripe.CreditNoteParams) (*stripe.CreditNote, error)
  • func (c Client) Preview(params *stripe.CreditNotePreviewParams) (*stripe.CreditNote, error)
  • func (c Client) Update(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)
  • func (c Client) VoidCreditNote(id string, params *stripe.CreditNoteVoidParams) (*stripe.CreditNote, error)
• type Iter
  • func List(params *stripe.CreditNoteListParams) *Iter
  • func (i *Iter) CreditNote() *stripe.CreditNote
• type LineItemIter
  • func ListLines(params *stripe.CreditNoteLineItemListParams) *LineItemIter
  • func ListPreviewLines(params *stripe.CreditNoteLineItemListPreviewParams) *LineItemIter
  • func (i *LineItemIter) CreditNoteLineItem() *stripe.CreditNoteLineItem

Functions

func Get

func Get(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)

Get returns the details of a credit note.

func New

func New(params *stripe.CreditNoteParams) (*stripe.CreditNote, error)

New creates a new credit note.

func Preview

func Preview(params *stripe.CreditNotePreviewParams) (*stripe.CreditNote, error)

Preview previews a credit note.

func Update

func Update(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)

Update updates a credit note.

func VoidCreditNote

func VoidCreditNote(id string, params *stripe.CreditNoteVoidParams) (*stripe.CreditNote, error)

VoidCreditNote voids a credit note.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is the client used to invoke /credit_notes APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)

Get returns the details of a credit note.

func (Client) List

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

List returns a list of credit notes.

func (Client) ListLines

func (c Client) ListLines(listParams *stripe.CreditNoteLineItemListParams) *LineItemIter

ListLines returns a list of credit note line items on a credit note.

func (Client) ListPreviewLines

func (c Client) ListPreviewLines(listParams *stripe.CreditNoteLineItemListPreviewParams) *LineItemIter

ListPreviewLines returns a list of lines on a previewed credit note.

func (Client) New

func (c Client) New(params *stripe.CreditNoteParams) (*stripe.CreditNote, error)

New creates a new credit note.

func (Client) Preview

func (c Client) Preview(params *stripe.CreditNotePreviewParams) (*stripe.CreditNote, error)

Preview previews a credit note.

func (Client) Update

func (c Client) Update(id string, params *stripe.CreditNoteParams) (*stripe.CreditNote, error)

Update updates a credit note.

func (Client) VoidCreditNote

func (c Client) VoidCreditNote(id string, params *stripe.CreditNoteVoidParams) (*stripe.CreditNote, error)

VoidCreditNote voids a credit note.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for credit notes.

func List

func List(params *stripe.CreditNoteListParams) *Iter

List returns a list of credit notes.

func (*Iter) CreditNote

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

CreditNote returns the cn which the iterator is currently pointing to.

type LineItemIter

type LineItemIter struct {
	*stripe.Iter
}

LineItemIter is an iterator for credit note line items on a credit note.

func ListLines

func ListLines(params *stripe.CreditNoteLineItemListParams) *LineItemIter

ListLines returns a list of credit note line items on a credit note.

func ListPreviewLines

func ListPreviewLines(params *stripe.CreditNoteLineItemListPreviewParams) *LineItemIter

ListPreviewLines returns a list of lines on a previewed credit note.

func (*LineItemIter) CreditNoteLineItem

func (i *LineItemIter) CreditNoteLineItem() *stripe.CreditNoteLineItem

CreditNoteLineItem returns the credit note line item which the iterator is currently pointing to.