Package com.stripe.model.entitlements

Class Feature

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.entitlements.Feature

All Implemented Interfaces:

HasId, MetadataStore<Feature>, StripeActiveObject, StripeObjectInterface

public class Feature
extends ApiResource
implements HasId, MetadataStore<Feature>

A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing 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
Feature()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Feature	create(FeatureCreateParams params)	Creates a feature.
static Feature	create(FeatureCreateParams params, RequestOptions options)	Creates a feature.
static Feature	create(Map<String,Object> params)	Creates a feature.
static Feature	create(Map<String,Object> params, RequestOptions options)	Creates a feature.
boolean	equals(Object o)
Boolean	getActive()	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
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.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	The feature's name, for your own purpose, not meant to be displayable to the customer.
String	getObject()	String representing the object's type.
int	hashCode()
static FeatureCollection	list(FeatureListParams params)	Retrieve a list of features.
static FeatureCollection	list(FeatureListParams params, RequestOptions options)	Retrieve a list of features.
static FeatureCollection	list(Map<String,Object> params)	Retrieve a list of features.
static FeatureCollection	list(Map<String,Object> params, RequestOptions options)	Retrieve a list of features.
static Feature	retrieve(String id)	Retrieves a feature.
static Feature	retrieve(String id, RequestOptions options)	Retrieves a feature.
static Feature	retrieve(String id, FeatureRetrieveParams params, RequestOptions options)	Retrieves a feature.
static Feature	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a feature.
void	setActive(Boolean active)	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
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	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	The feature's name, for your own purpose, not meant to be displayable to the customer.
void	setObject(String object)	String representing the object's type.
Feature	update(FeatureUpdateParams params)	Update a feature’s metadata or permanently deactivate it.
Feature	update(FeatureUpdateParams params, RequestOptions options)	Update a feature’s metadata or permanently deactivate it.
Feature	update(Map<String,Object> params)	Update a feature’s metadata or permanently deactivate it.
Feature	update(Map<String,Object> params, RequestOptions options)	Update a feature’s metadata or permanently deactivate it.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, setResponseGetter, 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

Feature

public Feature()

Method Details

create

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

Creates a feature.

Throws:

StripeException

create

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

Creates a feature.

Throws:

StripeException

create

public static Feature create(FeatureCreateParams params)
                      throws StripeException

Creates a feature.

Throws:

StripeException

create

public static Feature create(FeatureCreateParams params,
 RequestOptions options)
                      throws StripeException

Creates a feature.

Throws:

StripeException

list

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

Retrieve a list of features.

Throws:

StripeException

list

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

Retrieve a list of features.

Throws:

StripeException

list

public static FeatureCollection list(FeatureListParams params)
                              throws StripeException

Retrieve a list of features.

Throws:

StripeException

list

public static FeatureCollection list(FeatureListParams params,
 RequestOptions options)
                              throws StripeException

Retrieve a list of features.

Throws:

StripeException

retrieve

public static Feature retrieve(String id)
                        throws StripeException

Retrieves a feature.

Throws:

StripeException

retrieve

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

Retrieves a feature.

Throws:

StripeException

retrieve

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

Retrieves a feature.

Throws:

StripeException

retrieve

public static Feature retrieve(String id,
 FeatureRetrieveParams params,
 RequestOptions options)
                        throws StripeException

Retrieves a feature.

Throws:

StripeException

update

public Feature update(Map<String,Object> params)
               throws StripeException

Update a feature’s metadata or permanently deactivate it.

Specified by:

update in interface MetadataStore<Feature>

Throws:

StripeException

update

public Feature update(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

Update a feature’s metadata or permanently deactivate it.

Specified by:

update in interface MetadataStore<Feature>

Throws:

StripeException

update

public Feature update(FeatureUpdateParams params)
               throws StripeException

Update a feature’s metadata or permanently deactivate it.

Throws:

StripeException

update

public Feature update(FeatureUpdateParams params,
 RequestOptions options)
               throws StripeException

Update a feature’s metadata or permanently deactivate it.

Throws:

StripeException

getActive

public Boolean getActive()

Inactive features cannot be attached to new products and will not be returned from the features list endpoint.

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.

getName

public String getName()

The feature's name, for your own purpose, not meant to be displayable to the customer.

getObject

public String getObject()

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

Equal to entitlements.feature.

setActive

public void setActive(Boolean active)

Inactive features cannot be attached to new products and will not be returned from the features list endpoint.

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.

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

setName

public void setName(String name)

The feature's name, for your own purpose, not meant to be displayable to the customer.

setObject

public void setObject(String object)

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

Equal to entitlements.feature.

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

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Specified by:

getMetadata in interface MetadataStore<Feature>