Package com.stripe.model.entitlements

Class ActiveEntitlement

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.entitlements.ActiveEntitlement

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class ActiveEntitlement
extends ApiResource
implements HasId

An active entitlement describes access to a feature for a customer.

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getFeature()	Get ID of expandable feature object.
Feature	getFeatureObject()	Get expanded feature.
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	getLookupKey()	A unique key you provide as your own system identifier.
String	getObject()	String representing the object's type.
int	hashCode()
static ActiveEntitlementCollection	list(ActiveEntitlementListParams params)	Retrieve a list of active entitlements for a customer.
static ActiveEntitlementCollection	list(ActiveEntitlementListParams params, RequestOptions options)	Retrieve a list of active entitlements for a customer.
static ActiveEntitlementCollection	list(Map<String,Object> params)	Retrieve a list of active entitlements for a customer.
static ActiveEntitlementCollection	list(Map<String,Object> params, RequestOptions options)	Retrieve a list of active entitlements for a customer.
static ActiveEntitlement	retrieve(String id)	Retrieve an active entitlement.
static ActiveEntitlement	retrieve(String id, RequestOptions options)	Retrieve an active entitlement.
static ActiveEntitlement	retrieve(String id, ActiveEntitlementRetrieveParams params, RequestOptions options)	Retrieve an active entitlement.
static ActiveEntitlement	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieve an active entitlement.
void	setFeature(String id)
void	setFeatureObject(Feature expandableObject)
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	setLookupKey(String lookupKey)	A unique key you provide as your own system identifier.
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.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

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

ActiveEntitlement

public ActiveEntitlement()

Method Details

getFeature

public String getFeature()

Get ID of expandable feature object.

setFeature

public void setFeature(String id)

getFeatureObject

public Feature getFeatureObject()

Get expanded feature.

setFeatureObject

public void setFeatureObject(Feature expandableObject)

list

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

Retrieve a list of active entitlements for a customer.

Throws:

StripeException

list

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

Retrieve a list of active entitlements for a customer.

Throws:

StripeException

list

public static ActiveEntitlementCollection list(ActiveEntitlementListParams params)
                                        throws StripeException

Retrieve a list of active entitlements for a customer.

Throws:

StripeException

list

public static ActiveEntitlementCollection list(ActiveEntitlementListParams params,
 RequestOptions options)
                                        throws StripeException

Retrieve a list of active entitlements for a customer.

Throws:

StripeException

retrieve

public static ActiveEntitlement retrieve(String id)
                                  throws StripeException

Retrieve an active entitlement.

Throws:

StripeException

retrieve

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

Retrieve an active entitlement.

Throws:

StripeException

retrieve

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

Retrieve an active entitlement.

Throws:

StripeException

retrieve

public static ActiveEntitlement retrieve(String id,
 ActiveEntitlementRetrieveParams params,
 RequestOptions options)
                                  throws StripeException

Retrieve an active entitlement.

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.

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.

getLookupKey

public String getLookupKey()

A unique key you provide as your own system identifier. This may be up to 80 characters.

getObject

public String getObject()

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

Equal to entitlements.active_entitlement.

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.

setLookupKey

public void setLookupKey(String lookupKey)

A unique key you provide as your own system identifier. This may be up to 80 characters.

setObject

public void setObject(String object)

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

Equal to entitlements.active_entitlement.

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