44 lines
1.5 KiB
TypeScript
44 lines
1.5 KiB
TypeScript
import { StripeResource } from '../StripeResource.js';
|
|
import { PaginationParams } from '../shared.js';
|
|
import { RequestOptions, ApiListPromise, Response } from '../lib.js';
|
|
export declare class TaxCodeResource extends StripeResource {
|
|
/**
|
|
* A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
|
|
*/
|
|
list(params?: TaxCodeListParams, options?: RequestOptions): ApiListPromise<TaxCode>;
|
|
/**
|
|
* Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
|
|
*/
|
|
retrieve(id: string, params?: TaxCodeRetrieveParams, options?: RequestOptions): Promise<Response<TaxCode>>;
|
|
}
|
|
export interface TaxCode {
|
|
/**
|
|
* Unique identifier for the object.
|
|
*/
|
|
id: string;
|
|
/**
|
|
* String representing the object's type. Objects of the same type share the same value.
|
|
*/
|
|
object: 'tax_code';
|
|
/**
|
|
* A detailed description of which types of products the tax code represents.
|
|
*/
|
|
description: string;
|
|
/**
|
|
* A short name for the tax code.
|
|
*/
|
|
name: string;
|
|
}
|
|
export interface TaxCodeRetrieveParams {
|
|
/**
|
|
* Specifies which fields in the response should be expanded.
|
|
*/
|
|
expand?: Array<string>;
|
|
}
|
|
export interface TaxCodeListParams extends PaginationParams {
|
|
/**
|
|
* Specifies which fields in the response should be expanded.
|
|
*/
|
|
expand?: Array<string>;
|
|
}
|