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
- type LineItemIter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FinalizeQuote ¶
Finalizes the quote.
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 ¶
Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
Types ¶
type Client ¶
Client is used to invoke /quotes APIs.
func (Client) FinalizeQuote ¶
func (c Client) FinalizeQuote(id string, params *stripe.QuoteFinalizeQuoteParams) (*stripe.Quote, error)
Finalizes the quote.
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 ¶
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 ¶
Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
type Iter ¶
Iter is an iterator for quotes.
type LineItemIter ¶
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.