Class Registration

All Implemented Interfaces:
HasId, StripeObjectInterface

public class Registration extends ApiResource implements HasId
A Tax Registration lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.

Stripe will not register on your behalf with the relevant authorities when you create a Tax Registration object. For more information on how to register to collect tax, see our guide.

  • Constructor Details

    • Registration

      public Registration()
  • Method Details

    • create

      public static Registration create(Map<String,Object> params) throws StripeException
      Creates a new Tax Registration object.
      Throws:
      StripeException
    • create

      public static Registration create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates a new Tax Registration object.
      Throws:
      StripeException
    • create

      public static Registration create(RegistrationCreateParams params) throws StripeException
      Creates a new Tax Registration object.
      Throws:
      StripeException
    • create

      public static Registration create(RegistrationCreateParams params, RequestOptions options) throws StripeException
      Creates a new Tax Registration object.
      Throws:
      StripeException
    • list

      public static RegistrationCollection list(Map<String,Object> params) throws StripeException
      Returns a list of Tax Registration objects.
      Throws:
      StripeException
    • list

      public static RegistrationCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of Tax Registration objects.
      Throws:
      StripeException
    • list

      Returns a list of Tax Registration objects.
      Throws:
      StripeException
    • list

      public static RegistrationCollection list(RegistrationListParams params, RequestOptions options) throws StripeException
      Returns a list of Tax Registration objects.
      Throws:
      StripeException
    • update

      public Registration update(Map<String,Object> params) throws StripeException
      Updates an existing Tax Registration object.

      A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

      Throws:
      StripeException
    • update

      public Registration update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates an existing Tax Registration object.

      A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

      Throws:
      StripeException
    • update

      public Registration update(RegistrationUpdateParams params) throws StripeException
      Updates an existing Tax Registration object.

      A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

      Throws:
      StripeException
    • update

      public Registration update(RegistrationUpdateParams params, RequestOptions options) throws StripeException
      Updates an existing Tax Registration object.

      A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

      Throws:
      StripeException
    • getActiveFrom

      public Long getActiveFrom()
      Time at which the registration becomes active. Measured in seconds since the Unix epoch.
    • 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.
    • getExpiresAt

      public Long getExpiresAt()
      If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.
    • 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.registration.

    • getState

      public String getState()
      State, county, province, or region.
    • getStatus

      public String getStatus()
      The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.

      One of active, expired, or scheduled.

    • getType

      public String getType()
      The type of the registration. See our guide for more information about registration types.

      One of domestic_small_seller, ioss, simplified, standard, vat_oss_non_union, or vat_oss_union.

    • setActiveFrom

      public void setActiveFrom(Long activeFrom)
      Time at which the registration becomes active. Measured in seconds since the Unix epoch.
    • 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.
    • setExpiresAt

      public void setExpiresAt(Long expiresAt)
      If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.
    • setId

      public void setId(String id)
      Unique identifier for the object.
    • 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.
    • setObject

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

      Equal to tax.registration.

    • setState

      public void setState(String state)
      State, county, province, or region.
    • setStatus

      public void setStatus(String status)
      The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.

      One of active, expired, or scheduled.

    • setType

      public void setType(String type)
      The type of the registration. See our guide for more information about registration types.

      One of domestic_small_seller, ioss, simplified, standard, vat_oss_non_union, or vat_oss_union.

    • 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