Package com.stripe.model.tax

Class Location

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.tax.Location

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class Location
extends ApiResource
implements HasId

Tax locations represent venues for services, tickets, or other product types.

Nested Class Summary

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
Location()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Location	create(LocationCreateParams params)	Create a tax location to use in calculating taxes for a service, ticket, or other type of product.
static Location	create(LocationCreateParams params, RequestOptions options)	Create a tax location to use in calculating taxes for a service, ticket, or other type of product.
static Location	create(Map<String,Object> params)	Create a tax location to use in calculating taxes for a service, ticket, or other type of product.
static Location	create(Map<String,Object> params, RequestOptions options)	Create a tax location to use in calculating taxes for a service, ticket, or other type of product.
boolean	equals(Object o)
Address	getAddress()
String	getDescription()	A descriptive text providing additional context about the tax location.
String	getId()	Unique identifier for the object.
String	getObject()	String representing the object's type.
String	getType()	The type of tax location to be defined.
int	hashCode()
static LocationCollection	list(LocationListParams params)	Retrieve a list of all tax locations.
static LocationCollection	list(LocationListParams params, RequestOptions options)	Retrieve a list of all tax locations.
static LocationCollection	list(Map<String,Object> params)	Retrieve a list of all tax locations.
static LocationCollection	list(Map<String,Object> params, RequestOptions options)	Retrieve a list of all tax locations.
static Location	retrieve(String location)	Fetch the details of a specific tax location using its unique identifier.
static Location	retrieve(String location, RequestOptions options)	Fetch the details of a specific tax location using its unique identifier.
static Location	retrieve(String location, LocationRetrieveParams params, RequestOptions options)	Fetch the details of a specific tax location using its unique identifier.
static Location	retrieve(String location, Map<String,Object> params, RequestOptions options)	Fetch the details of a specific tax location using its unique identifier.
void	setAddress(Address address)
void	setDescription(String description)	A descriptive text providing additional context about the tax location.
void	setId(String id)	Unique identifier for the object.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setType(String type)	The type of tax location to be defined.

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

Location

public Location()

Method Details

create

public static Location create(Map<String,Object> params)
                       throws StripeException

Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.

Throws:

StripeException

create

public static Location create(Map<String,Object> params,
 RequestOptions options)
                       throws StripeException

Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.

Throws:

StripeException

create

public static Location create(LocationCreateParams params)
                       throws StripeException

Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.

Throws:

StripeException

create

public static Location create(LocationCreateParams params,
 RequestOptions options)
                       throws StripeException

Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.

Throws:

StripeException

list

public static LocationCollection list(Map<String,Object> params)
                               throws StripeException

Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.

The response includes detailed information for each tax location, such as its address, name, description, and current operational status.

You can paginate through the list by using the limit parameter to control the number of results returned in each request.

Throws:

StripeException

list

public static LocationCollection list(Map<String,Object> params,
 RequestOptions options)
                               throws StripeException

Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.

The response includes detailed information for each tax location, such as its address, name, description, and current operational status.

You can paginate through the list by using the limit parameter to control the number of results returned in each request.

Throws:

StripeException

list

public static LocationCollection list(LocationListParams params)
                               throws StripeException

Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.

The response includes detailed information for each tax location, such as its address, name, description, and current operational status.

You can paginate through the list by using the limit parameter to control the number of results returned in each request.

Throws:

StripeException

list

public static LocationCollection list(LocationListParams params,
 RequestOptions options)
                               throws StripeException

Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.

The response includes detailed information for each tax location, such as its address, name, description, and current operational status.

You can paginate through the list by using the limit parameter to control the number of results returned in each request.

Throws:

StripeException

retrieve

public static Location retrieve(String location)
                         throws StripeException

Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the integration guide.

Throws:

StripeException

retrieve

public static Location retrieve(String location,
 RequestOptions options)
                         throws StripeException

Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the integration guide.

Throws:

StripeException

retrieve

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

Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the integration guide.

Throws:

StripeException

retrieve

public static Location retrieve(String location,
 LocationRetrieveParams params,
 RequestOptions options)
                         throws StripeException

Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the integration guide.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getAddress

public Address getAddress()

getDescription

public String getDescription()

A descriptive text providing additional context about the tax location. This can include information about the venue, types of events held, services available, or any relevant details for better identification (e.g., "A spacious auditorium suitable for large concerts and events.").

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to tax.location.

getType

public String getType()

The type of tax location to be defined. Currently the only option is performance.

Equal to performance.

setAddress

public void setAddress(Address address)

setDescription

public void setDescription(String description)

A descriptive text providing additional context about the tax location. This can include information about the venue, types of events held, services available, or any relevant details for better identification (e.g., "A spacious auditorium suitable for large concerts and events.").

setId

public void setId(String id)

Unique identifier for the object.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to tax.location.

setType

public void setType(String type)

The type of tax location to be defined. Currently the only option is performance.

Equal to performance.

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