Class QuotesResource

Index

Constructors

constructor

Methods

create retrieve update list accept cancel finalizeQuote listComputedUpfrontLineItems listLineItems pdf

Constructors

constructor

new QuotesResource(): QuotesResource
Returns QuotesResource

Methods

create

create(
params?: Stripe.QuoteCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
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.
Parameters
- Optionalparams: Stripe.QuoteCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:785
create(options?: RequestOptions): Promise<Response<Stripe.Quote>>
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.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:789

retrieve

retrieve(
    id: string,
    params?: QuoteRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
Retrieves the quote with the given ID.
Parameters
- id: string
- Optionalparams: QuoteRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:794
retrieve(id: string, options?: RequestOptions): Promise<Response<Stripe.Quote>>
Retrieves the quote with the given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:799

update

update(
    id: string,
    params?: Stripe.QuoteUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
A quote models prices and services for a customer.
Parameters
- id: string
- Optionalparams: Stripe.QuoteUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:807

list

list(
params?: Stripe.QuoteListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Quote>
Returns a list of your quotes.
Parameters
- Optionalparams: Stripe.QuoteListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Quote>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:816
list(options?: RequestOptions): ApiListPromise<Stripe.Quote>
Returns a list of your quotes.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Quote>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:820

accept

accept(
    id: string,
    params?: QuoteAcceptParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
Accepts the specified quote.
Parameters
- id: string
- Optionalparams: QuoteAcceptParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:825
accept(id: string, options?: RequestOptions): Promise<Response<Stripe.Quote>>
Accepts the specified quote.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:830

cancel

cancel(
    id: string,
    params?: QuoteCancelParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
Cancels the quote.
Parameters
- id: string
- Optionalparams: QuoteCancelParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:838
cancel(id: string, options?: RequestOptions): Promise<Response<Stripe.Quote>>
Cancels the quote.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:843

finalizeQuote

finalizeQuote(
    id: string,
    params?: QuoteFinalizeQuoteParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
Finalizes the quote.
Parameters
- id: string
- Optionalparams: QuoteFinalizeQuoteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:851
finalizeQuote(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Quote>>
Finalizes the quote.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Quote>>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:856

listComputedUpfrontLineItems

listComputedUpfrontLineItems(
    id: string,
    params?: QuoteListComputedUpfrontLineItemsParams,
    options?: RequestOptions,
): ApiListPromise<Stripe.LineItem>
When retrieving a quote, there is an includable 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.
Parameters
- id: string
- Optionalparams: QuoteListComputedUpfrontLineItemsParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.LineItem>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:864
listComputedUpfrontLineItems(
id: string,
options?: RequestOptions,
): ApiListPromise<Stripe.LineItem>
When retrieving a quote, there is an includable 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.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.LineItem>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:869

listLineItems

listLineItems(
    id: string,
    params?: QuoteListLineItemsParams,
    options?: RequestOptions,
): ApiListPromise<Stripe.LineItem>
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.
Parameters
- id: string
- Optionalparams: QuoteListLineItemsParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.LineItem>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:877
listLineItems(
id: string,
options?: RequestOptions,
): ApiListPromise<Stripe.LineItem>
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.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.LineItem>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:882

pdf

pdf(
    id: string,
    params?: QuotePdfParams,
    options?: RequestOptions,
): Promise<ReadableStream>
Download the PDF for a finalized quote. Explanation for special handling can be found here
Parameters
- id: string
- Optionalparams: QuotePdfParams
- Optionaloptions: RequestOptions
Returns Promise<ReadableStream>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:890
pdf(id: string, options?: RequestOptions): Promise<ReadableStream>
Download the PDF for a finalized quote. Explanation for special handling can be found here
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<ReadableStream>
- Defined in node_modules/stripe/types/QuotesResource.d.ts:895

Class QuotesResource

Index

Constructors

Methods

Constructors

constructor

Returns QuotesResource

Methods

create

Parameters

Returns Promise<Response<Stripe.Quote>>

Parameters

Returns Promise<Response<Stripe.Quote>>

retrieve

Parameters

Returns Promise<Response<Stripe.Quote>>

Parameters

Returns Promise<Response<Stripe.Quote>>

update

Parameters

Returns Promise<Response<Stripe.Quote>>

list

Parameters

Returns ApiListPromise<Stripe.Quote>

Parameters

Returns ApiListPromise<Stripe.Quote>

accept

Parameters

Returns Promise<Response<Stripe.Quote>>

Parameters

Returns Promise<Response<Stripe.Quote>>

cancel

Parameters

Returns Promise<Response<Stripe.Quote>>

Parameters

Returns Promise<Response<Stripe.Quote>>

finalizeQuote

Parameters

Returns Promise<Response<Stripe.Quote>>

Parameters

Returns Promise<Response<Stripe.Quote>>

listComputedUpfrontLineItems

Parameters

Returns ApiListPromise<Stripe.LineItem>

Parameters

Returns ApiListPromise<Stripe.LineItem>

listLineItems

Parameters

Returns ApiListPromise<Stripe.LineItem>

Parameters

Returns ApiListPromise<Stripe.LineItem>

pdf

Parameters

Returns Promise<ReadableStream>

Parameters

Returns Promise<ReadableStream>

Settings

On This Page