Package com.stripe.model.tax

Class Settings

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.tax.Settings
All Implemented Interfaces:
StripeObjectInterface
public class Settings extends ApiResource
You can use Tax Settings to manage configurations used by Stripe Tax calculations.

Related guide: Using the Settings API

  • Constructor Details

    • Settings

      public Settings()

  • Method Details

    • retrieve

      public static Settings retrieve() throws StripeException
      Retrieves Tax Settings for a merchant.
      Throws:
      StripeException

    • retrieve

      public static Settings retrieve(RequestOptions options) throws StripeException
      Retrieves Tax Settings for a merchant.
      Throws:
      StripeException

    • retrieve

      public static Settings retrieve(Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves Tax Settings for a merchant.
      Throws:
      StripeException

    • retrieve

      public static Settings retrieve(SettingsRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves Tax Settings for a merchant.
      Throws:
      StripeException

    • update

      public static Settings update(Map<String,Object> params) throws StripeException
      Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
      Throws:
      StripeException

    • update

      public static Settings update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
      Throws:
      StripeException

    • update

      public static Settings update(SettingsUpdateParams params) throws StripeException
      Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
      Throws:
      StripeException

    • update

      public static Settings update(SettingsUpdateParams params, RequestOptions options) throws StripeException
      Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
      Throws:
      StripeException

    • getDefaults

      public Settings.Defaults getDefaults()

    • getHeadOffice

      public Settings.HeadOffice getHeadOffice()
      The place where your business is located.

    • 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.

    • getLocations

      public List<Settings.Location> getLocations()
      The deprecated places where your business is located.

    • getObject

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

      Equal to tax.settings.

    • getStatus

      public String getStatus()
      The active status indicates you have all required settings to calculate tax. A status can transition out of active when new required settings are introduced.

      One of active, or pending.

    • getStatusDetails

      public Settings.StatusDetails getStatusDetails()

    • setDefaults

      public void setDefaults(Settings.Defaults defaults)

    • setHeadOffice

      public void setHeadOffice(Settings.HeadOffice headOffice)
      The place where your business is located.

    • 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.

    • setLocations

      public void setLocations(List<Settings.Location> locations)
      The deprecated places where your business is located.

    • setObject

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

      Equal to tax.settings.

    • setStatus

      public void setStatus(String status)
      The active status indicates you have all required settings to calculate tax. A status can transition out of active when new required settings are introduced.

      One of active, or pending.

    • setStatusDetails

      public void setStatusDetails(Settings.StatusDetails statusDetails)

    • 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