Mayson Monorepo Documentation
    Preparing search index...
    interface TaxRateCreateParams {
        display_name: string;
        inclusive: boolean;
        percentage: number;
        active?: boolean;
        country?: string;
        description?: string;
        expand?: string[];
        jurisdiction?: string;
        metadata?: MetadataParam;
        state?: string;
        tax_type?: Stripe.TaxRateCreateParams.TaxType;
    }
    Index

    Properties

    display_name: string

    The display name of the tax rate, which will be shown to users.

    inclusive: boolean

    This specifies if the tax rate is inclusive or exclusive.

    percentage: number

    This represents the tax rate percent out of 100.

    active?: boolean

    Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

    country?: string

    Two-letter country code (ISO 3166-1 alpha-2).

    description?: string

    An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    jurisdiction?: string

    The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.

    metadata?: MetadataParam

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    state?: string

    ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.

    The high-level tax type, such as vat or sales_tax.