Package com.stripe.model

Class TaxRate

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.TaxRate
All Implemented Interfaces:
HasId, MetadataStore<TaxRate>, StripeObjectInterface
public class TaxRate extends ApiResource implements HasId, MetadataStore<TaxRate>

  • Constructor Details

    • TaxRate

      public TaxRate()

  • Method Details

    • list

      public static TaxRateCollection list(Map<String,Object> params) throws StripeException
      Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
      Throws:
      StripeException

    • list

      public static TaxRateCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
      Throws:
      StripeException

    • list

      public static TaxRateCollection list(TaxRateListParams params) throws StripeException
      Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
      Throws:
      StripeException

    • list

      public static TaxRateCollection list(TaxRateListParams params, RequestOptions options) throws StripeException
      Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
      Throws:
      StripeException

    • retrieve

      public static TaxRate retrieve(String taxRate) throws StripeException
      Retrieves a tax rate with the given ID.
      Throws:
      StripeException

    • retrieve

      public static TaxRate retrieve(String taxRate, RequestOptions options) throws StripeException
      Retrieves a tax rate with the given ID.
      Throws:
      StripeException

    • retrieve

      public static TaxRate retrieve(String taxRate, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves a tax rate with the given ID.
      Throws:
      StripeException

    • retrieve

      public static TaxRate retrieve(String taxRate, TaxRateRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves a tax rate with the given ID.
      Throws:
      StripeException

    • create

      public static TaxRate create(Map<String,Object> params) throws StripeException
      Creates a new tax rate.
      Throws:
      StripeException

    • create

      public static TaxRate create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates a new tax rate.
      Throws:
      StripeException

    • create

      public static TaxRate create(TaxRateCreateParams params) throws StripeException
      Creates a new tax rate.
      Throws:
      StripeException

    • create

      public static TaxRate create(TaxRateCreateParams params, RequestOptions options) throws StripeException
      Creates a new tax rate.
      Throws:
      StripeException

    • update

      public TaxRate update(Map<String,Object> params) throws StripeException
      Updates an existing tax rate.
      Specified by:
      update in interface MetadataStore<TaxRate>
      Throws:
      StripeException

    • update

      public TaxRate update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates an existing tax rate.
      Specified by:
      update in interface MetadataStore<TaxRate>
      Throws:
      StripeException

    • update

      public TaxRate update(TaxRateUpdateParams params) throws StripeException
      Updates an existing tax rate.
      Throws:
      StripeException

    • update

      public TaxRate update(TaxRateUpdateParams params, RequestOptions options) throws StripeException
      Updates an existing tax rate.
      Throws:
      StripeException

    • getActive

      public Boolean getActive()
      Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

    • getCountry

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

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getDescription

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

    • getDisplayName

      public String getDisplayName()
      The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

    • getInclusive

      public Boolean getInclusive()
      This specifies if the tax rate is inclusive or exclusive.

    • getJurisdiction

      public String 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.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to tax_rate.

    • getPercentage

      public BigDecimal getPercentage()
      This represents the tax rate percent out of 100.

    • getState

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

    • getTaxType

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

      One of gst, hst, jct, pst, qst, rst, sales_tax, or vat.

    • setActive

      public void setActive(Boolean active)
      Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

    • setCountry

      public void setCountry(String country)
      Two-letter country code (ISO 3166-1 alpha-2).

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setDescription

      public void setDescription(String description)
      An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

    • setDisplayName

      public void setDisplayName(String displayName)
      The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setInclusive

      public void setInclusive(Boolean inclusive)
      This specifies if the tax rate is inclusive or exclusive.

    • setJurisdiction

      public void setJurisdiction(String jurisdiction)
      The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      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.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to tax_rate.

    • setPercentage

      public void setPercentage(BigDecimal percentage)
      This represents the tax rate percent out of 100.

    • setState

      public void setState(String state)
      ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.

    • setTaxType

      public void setTaxType(String taxType)
      The high-level tax type, such as vat or sales_tax.

      One of gst, hst, jct, pst, qst, rst, sales_tax, or vat.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId

    • getMetadata

      public Map<String,String> 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.
      Specified by:
      getMetadata in interface MetadataStore<TaxRate>