Class TaxRateUpdateParams


public class TaxRateUpdateParams extends ApiRequestParams
  • Method Details

    • builder

      public static TaxRateUpdateParams.Builder builder()
    • getActive

      public Boolean getActive()
      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.
    • getCountry

      public Object getCountry()
      Two-letter country code (ISO 3166-1 alpha-2).
    • getDescription

      public Object getDescription()
      An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
    • getDisplayName

      public Object getDisplayName()
      The display name of the tax rate, which will be shown to users.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getJurisdiction

      public Object getJurisdiction()
      The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
    • getMetadata

      public Object getMetadata()
      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.
    • getState

      public Object getState()
      ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.
    • getTaxType

      public TaxRateUpdateParams.TaxType getTaxType()
      The high-level tax type, such as vat or sales_tax.