Class CalculationsResource

Index

Constructors

Methods

create retrieve listLineItems

Constructors

constructor

new CalculationsResource(): CalculationsResource
Returns CalculationsResource

Methods

create

create(
params: Stripe.Tax.CalculationCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Tax.Calculation>>
Calculates tax based on the input and returns a Tax Calculation object.
Parameters
- params: Stripe.Tax.CalculationCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Calculation>>
- Defined in node_modules/stripe/types/Tax/CalculationsResource.d.ts:372

retrieve

retrieve(
    id: string,
    params?: CalculationRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Tax.Calculation>>
Retrieves a Tax Calculation object, if the calculation hasn't expired.
Parameters
- id: string
- Optionalparams: CalculationRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Calculation>>
- Defined in node_modules/stripe/types/Tax/CalculationsResource.d.ts:380
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Tax.Calculation>>
Retrieves a Tax Calculation object, if the calculation hasn't expired.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Tax.Calculation>>
- Defined in node_modules/stripe/types/Tax/CalculationsResource.d.ts:385

listLineItems

listLineItems(
    id: string,
    params?: CalculationListLineItemsParams,
    options?: RequestOptions,
): ApiListPromise<Stripe.Tax.CalculationLineItem>
Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
Parameters
- id: string
- Optionalparams: CalculationListLineItemsParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Tax.CalculationLineItem>
- Defined in node_modules/stripe/types/Tax/CalculationsResource.d.ts:393
listLineItems(
id: string,
options?: RequestOptions,
): ApiListPromise<Stripe.Tax.CalculationLineItem>
Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Tax.CalculationLineItem>
- Defined in node_modules/stripe/types/Tax/CalculationsResource.d.ts:398