Package com.stripe.model.tax

Class Registration

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.tax.Registration

All Implemented Interfaces:

HasId, StripeActiveObject, 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 doesn't 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.

Related guide: Using the Registrations API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Registration.CountryOptions	For more details about CountryOptions, please refer to the API Reference.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Registration()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Registration	create(RegistrationCreateParams params)	Creates a new Tax Registration object.
static Registration	create(RegistrationCreateParams params, RequestOptions options)	Creates a new Tax Registration object.
static Registration	create(Map<String,Object> params)	Creates a new Tax Registration object.
static Registration	create(Map<String,Object> params, RequestOptions options)	Creates a new Tax Registration object.
boolean	equals(Object o)
Long	getActiveFrom()	Time at which the registration becomes active.
String	getCountry()	Two-letter country code (ISO 3166-1 alpha-2).
Registration.CountryOptions	getCountryOptions()
Long	getCreated()	Time at which the object was created.
Long	getExpiresAt()	If set, the registration stops being active at this time.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getObject()	String representing the object's type.
String	getStatus()	The status of the registration.
int	hashCode()
static RegistrationCollection	list(RegistrationListParams params)	Returns a list of Tax Registration objects.
static RegistrationCollection	list(RegistrationListParams params, RequestOptions options)	Returns a list of Tax Registration objects.
static RegistrationCollection	list(Map<String,Object> params)	Returns a list of Tax Registration objects.
static RegistrationCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of Tax Registration objects.
static Registration	retrieve(String id)	Returns a Tax Registration object.
static Registration	retrieve(String id, RequestOptions options)	Returns a Tax Registration object.
static Registration	retrieve(String id, RegistrationRetrieveParams params, RequestOptions options)	Returns a Tax Registration object.
static Registration	retrieve(String id, Map<String,Object> params, RequestOptions options)	Returns a Tax Registration object.
void	setActiveFrom(Long activeFrom)	Time at which the registration becomes active.
void	setCountry(String country)	Two-letter country code (ISO 3166-1 alpha-2).
void	setCountryOptions(Registration.CountryOptions countryOptions)
void	setCreated(Long created)	Time at which the object was created.
void	setExpiresAt(Long expiresAt)	If set, the registration stops being active at this time.
void	setId(String id)	Unique identifier for the object.
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.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Type of registration in country.
void	setStatus(String status)	The status of the registration.
Registration	update(RegistrationUpdateParams params)	Updates an existing Tax Registration object.
Registration	update(RegistrationUpdateParams params, RequestOptions options)	Updates an existing Tax Registration object.
Registration	update(Map<String,Object> params)	Updates an existing Tax Registration object.
Registration	update(Map<String,Object> params, RequestOptions options)	Updates an existing Tax Registration object.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

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

public static RegistrationCollection list(RegistrationListParams params)
                                   throws StripeException

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

retrieve

public static Registration retrieve(String id)
                             throws StripeException

Returns a Tax Registration object.

Throws:

StripeException

retrieve

public static Registration retrieve(String id,
 RequestOptions options)
                             throws StripeException

Returns a Tax Registration object.

Throws:

StripeException

retrieve

public static Registration retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                             throws StripeException

Returns a Tax Registration object.

Throws:

StripeException

retrieve

public static Registration retrieve(String id,
 RegistrationRetrieveParams params,
 RequestOptions options)
                             throws StripeException

Returns a Tax Registration object.

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

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Type of registration in country.

Equal to standard.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

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

getCountryOptions

public Registration.CountryOptions getCountryOptions()

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.

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.

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

setCountryOptions

public void setCountryOptions(Registration.CountryOptions countryOptions)

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.

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.

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