Package com.stripe.model.billing

Class FeedbackOption

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.billing.FeedbackOption

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class FeedbackOption
extends ApiResource
implements HasId

A feedback option is a reason you can present to customers when they cancel a subscription through the customer portal. Configure the set of options a customer can choose from on a portal configuration.

Related guide: Customer management

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FeedbackOption.StatusTransitions	For more details about StatusTransitions, 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
FeedbackOption()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static FeedbackOption	create(FeedbackOptionCreateParams params)	Creates a new feedback option.
static FeedbackOption	create(FeedbackOptionCreateParams params, RequestOptions options)	Creates a new feedback option.
static FeedbackOption	create(Map<String,Object> params)	Creates a new feedback option.
static FeedbackOption	create(Map<String,Object> params, RequestOptions options)	Creates a new feedback option.
FeedbackOption	deactivate()	Deactivates a feedback option.
FeedbackOption	deactivate(RequestOptions options)	Deactivates a feedback option.
FeedbackOption	deactivate(FeedbackOptionDeactivateParams params)	Deactivates a feedback option.
FeedbackOption	deactivate(FeedbackOptionDeactivateParams params, RequestOptions options)	Deactivates a feedback option.
FeedbackOption	deactivate(Map<String,Object> params)	Deactivates a feedback option.
FeedbackOption	deactivate(Map<String,Object> params, RequestOptions options)	Deactivates a feedback option.
boolean	equals(Object o)
String	getDescription()	An arbitrary string attached to the object.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	If the object exists in live mode, the value is true.
String	getObject()	String representing the object's type.
String	getStatus()	The feedback option's status.
FeedbackOption.StatusTransitions	getStatusTransitions()
int	hashCode()
static FeedbackOptionCollection	list(FeedbackOptionListParams params)	Returns a list of your feedback options.
static FeedbackOptionCollection	list(FeedbackOptionListParams params, RequestOptions options)	Returns a list of your feedback options.
static FeedbackOptionCollection	list(Map<String,Object> params)	Returns a list of your feedback options.
static FeedbackOptionCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of your feedback options.
static FeedbackOption	retrieve(String id)	Retrieves a feedback option object given an ID.
static FeedbackOption	retrieve(String id, RequestOptions options)	Retrieves a feedback option object given an ID.
static FeedbackOption	retrieve(String id, FeedbackOptionRetrieveParams params, RequestOptions options)	Retrieves a feedback option object given an ID.
static FeedbackOption	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a feedback option object given an ID.
void	setDescription(String description)	An arbitrary string attached to the object.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
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	setStatus(String status)	The feedback option's status.
void	setStatusTransitions(FeedbackOption.StatusTransitions statusTransitions)
FeedbackOption	update(FeedbackOptionUpdateParams params)	Updates the description of an existing feedback option.
FeedbackOption	update(FeedbackOptionUpdateParams params, RequestOptions options)	Updates the description of an existing feedback option.
FeedbackOption	update(Map<String,Object> params)	Updates the description of an existing feedback option.
FeedbackOption	update(Map<String,Object> params, RequestOptions options)	Updates the description of an existing feedback option.

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, 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

FeedbackOption

public FeedbackOption()

Method Details

create

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

Creates a new feedback option.

Throws:

StripeException

create

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

Creates a new feedback option.

Throws:

StripeException

create

public static FeedbackOption create(FeedbackOptionCreateParams params)
                             throws StripeException

Creates a new feedback option.

Throws:

StripeException

create

public static FeedbackOption create(FeedbackOptionCreateParams params,
 RequestOptions options)
                             throws StripeException

Creates a new feedback option.

Throws:

StripeException

deactivate

public FeedbackOption deactivate()
                          throws StripeException

Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.

Throws:

StripeException

deactivate

public FeedbackOption deactivate(RequestOptions options)
                          throws StripeException

Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.

Throws:

StripeException

deactivate

public FeedbackOption deactivate(Map<String,Object> params)
                          throws StripeException

Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.

Throws:

StripeException

deactivate

public FeedbackOption deactivate(Map<String,Object> params,
 RequestOptions options)
                          throws StripeException

Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.

Throws:

StripeException

deactivate

public FeedbackOption deactivate(FeedbackOptionDeactivateParams params)
                          throws StripeException

Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.

Throws:

StripeException

deactivate

public FeedbackOption deactivate(FeedbackOptionDeactivateParams params,
 RequestOptions options)
                          throws StripeException

Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.

Throws:

StripeException

list

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

Returns a list of your feedback options.

Throws:

StripeException

list

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

Returns a list of your feedback options.

Throws:

StripeException

list

public static FeedbackOptionCollection list(FeedbackOptionListParams params)
                                     throws StripeException

Returns a list of your feedback options.

Throws:

StripeException

list

public static FeedbackOptionCollection list(FeedbackOptionListParams params,
 RequestOptions options)
                                     throws StripeException

Returns a list of your feedback options.

Throws:

StripeException

retrieve

public static FeedbackOption retrieve(String id)
                               throws StripeException

Retrieves a feedback option object given an ID.

Throws:

StripeException

retrieve

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

Retrieves a feedback option object given an ID.

Throws:

StripeException

retrieve

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

Retrieves a feedback option object given an ID.

Throws:

StripeException

retrieve

public static FeedbackOption retrieve(String id,
 FeedbackOptionRetrieveParams params,
 RequestOptions options)
                               throws StripeException

Retrieves a feedback option object given an ID.

Throws:

StripeException

update

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

Updates the description of an existing feedback option.

Throws:

StripeException

update

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

Updates the description of an existing feedback option.

Throws:

StripeException

update

public FeedbackOption update(FeedbackOptionUpdateParams params)
                      throws StripeException

Updates the description of an existing feedback option.

Throws:

StripeException

update

public FeedbackOption update(FeedbackOptionUpdateParams params,
 RequestOptions options)
                      throws StripeException

Updates the description of an existing feedback option.

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.

getDescription

public String getDescription()

An arbitrary string attached to the object. Often useful for displaying to users.

getLivemode

public Boolean getLivemode()

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

getObject

public String getObject()

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

Equal to billing.feedback_option.

getStatus

public String getStatus()

The feedback option's status.

One of active, or inactive.

getStatusTransitions

public FeedbackOption.StatusTransitions getStatusTransitions()

setDescription

public void setDescription(String description)

An arbitrary string attached to the object. Often useful for displaying to users.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

setObject

public void setObject(String object)

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

Equal to billing.feedback_option.

setStatus

public void setStatus(String status)

The feedback option's status.

One of active, or inactive.

setStatusTransitions

public void setStatusTransitions(FeedbackOption.StatusTransitions statusTransitions)

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