quote

Documentation

Overview

Package quote provides the /quotes APIs

Index

• func Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)
• func Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)
• func FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)
• func Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
• func New(params *stripe.QuoteParams) (*stripe.Quote, error)
• func PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)
• func Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
• type Client
  • func (c Client) Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)
  • func (c Client) Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)
  • func (c Client) FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)
  • func (c Client) Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
  • func (c Client) List(listParams *stripe.QuoteListParams) *Iter
  • func (c Client) ListComputedUpfrontLineItems(listParams *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter
  • func (c Client) ListLineItems(listParams *stripe.QuoteListLineItemsParams) *LineItemIter
  • func (c Client) New(params *stripe.QuoteParams) (*stripe.Quote, error)
  • func (c Client) PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)
  • func (c Client) Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)
• type Iter
  • func List(params *stripe.QuoteListParams) *Iter
  • func (i *Iter) Quote() *stripe.Quote
  • func (i *Iter) QuoteList() *stripe.QuoteList
• type LineItemIter
  • func ListComputedUpfrontLineItems(params *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter
  • func ListLineItems(params *stripe.QuoteListLineItemsParams) *LineItemIter
  • func (i *LineItemIter) LineItem() *stripe.LineItem
  • func (i *LineItemIter) LineItemList() *stripe.LineItemList

Functions

func Accept

func Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)

Accepts the specified quote.

func Cancel

func Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)

Cancels the quote.

func FinalizeQuote

func FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)

Finalizes the quote.

func Get

func Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

Retrieves the quote with the given ID.

func New

func New(params *stripe.QuoteParams) (*stripe.Quote, error)

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).

func PDF

func PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)

Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)

func Update

func Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

A quote models prices and services for a customer.

Types

type Client

type Client struct {
	B        stripe.Backend
	BUploads stripe.Backend
	Key      string
}

Client is used to invoke /quotes APIs.

func (Client) Accept

func (c Client) Accept(id string, params *stripe.QuoteAcceptParams) (*stripe.Quote, error)

Accepts the specified quote.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.QuoteCancelParams) (*stripe.Quote, error)

Cancels the quote.

func (Client) FinalizeQuote

func (c Client) FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)

Finalizes the quote.

func (Client) Get

func (c Client) Get(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

Retrieves the quote with the given ID.

func (Client) List

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

Returns a list of your quotes.

func (Client) ListComputedUpfrontLineItems

func (c Client) ListComputedUpfrontLineItems(listParams *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter

When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

func (Client) ListLineItems

func (c Client) ListLineItems(listParams *stripe.QuoteListLineItemsParams) *LineItemIter

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

func (Client) New

func (c Client) New(params *stripe.QuoteParams) (*stripe.Quote, error)

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).

func (Client) PDF

func (c Client) PDF(id string, params *stripe.QuotePDFParams) (*stripe.APIStream, error)

Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)

func (Client) Update

func (c Client) Update(id string, params *stripe.QuoteParams) (*stripe.Quote, error)

A quote models prices and services for a customer.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for quotes.

func List

func List(params *stripe.QuoteListParams) *Iter

Returns a list of your quotes.

func (*Iter) Quote

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

Quote returns the quote which the iterator is currently pointing to.

func (*Iter) QuoteList

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

QuoteList 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 LineItemIter

type LineItemIter struct {
	*stripe.Iter
}

LineItemIter is an iterator for line items.

func ListComputedUpfrontLineItems

func ListComputedUpfrontLineItems(params *stripe.QuoteListComputedUpfrontLineItemsParams) *LineItemIter

When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

func ListLineItems

func ListLineItems(params *stripe.QuoteListLineItemsParams) *LineItemIter

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

func (*LineItemIter) LineItem

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

LineItem returns the line item which the iterator is currently pointing to.

func (*LineItemIter) LineItemList

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

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