Mayson Monorepo Documentation
    Preparing search index...

    Interface TaxRateUpdateParams

    interface TaxRateUpdateParams {
        active?: boolean;
        country?: string;
        description?: string;
        display_name?: string;
        expand?: string[];
        jurisdiction?: string;
        metadata?: Emptyable<MetadataParam>;
        state?: string;
        tax_type?: Stripe.TaxRateUpdateParams.TaxType;
    }
    Index

    Properties

    active? country? description? display_name? expand? jurisdiction? metadata? state? tax_type?

    Properties

    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.

    display_name?: string

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

    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?: Emptyable<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.

    tax_type?: Stripe.TaxRateUpdateParams.TaxType

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

    Settings

    Member Visibility

    On This Page

    Properties