Package com.stripe.model

Class TaxRate

    • Constructor Detail

      • TaxRate

        public TaxRate()

    • Method Detail

      • list

        public static TaxRateCollection list​(java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.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

      • getActive

        public java.lang.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 java.lang.String getCountry()
        Two-letter country code (ISO 3166-1 alpha-2).

      • getCreated

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

      • getDescription

        public java.lang.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 java.lang.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 java.lang.Boolean getInclusive()
        This specifies if the tax rate is inclusive or exclusive.

      • getJurisdiction

        public java.lang.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 java.lang.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 java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to tax_rate.

      • getPercentage

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

      • getState

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

      • getTaxType

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

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

      • setActive

        public void setActive​(java.lang.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​(java.lang.String country)
        Two-letter country code (ISO 3166-1 alpha-2).

      • setCreated

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

      • setDescription

        public void setDescription​(java.lang.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​(java.lang.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​(java.lang.String id)
        Unique identifier for the object.

      • setInclusive

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

      • setJurisdiction

        public void setJurisdiction​(java.lang.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​(java.lang.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​(java.util.Map<java.lang.String,​java.lang.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​(java.lang.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​(java.math.BigDecimal percentage)
        This represents the tax rate percent out of 100.

      • setState

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

      • setTaxType

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

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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

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

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.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>