Package com.stripe.model.productcatalog

Class TrialOffer

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.productcatalog.TrialOffer

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class TrialOffer
extends ApiResource
implements HasId

Resource for the TrialOffer API, used to describe a subscription item's trial period settings. Renders a TrialOffer object that describes the price, duration, end_behavior of a trial offer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrialOffer.Duration	For more details about Duration, please refer to the API Reference.
static class	TrialOffer.EndBehavior	For more details about EndBehavior, 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
TrialOffer()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static TrialOffer	create(TrialOfferCreateParams params)	Creates a trial offer.
static TrialOffer	create(TrialOfferCreateParams params, RequestOptions options)	Creates a trial offer.
static TrialOffer	create(Map<String,Object> params)	Creates a trial offer.
static TrialOffer	create(Map<String,Object> params, RequestOptions options)	Creates a trial offer.
boolean	equals(Object o)
TrialOffer.Duration	getDuration()
TrialOffer.EndBehavior	getEndBehavior()
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	getPrice()	Get ID of expandable price object.
Price	getPriceObject()	Get expanded price.
int	hashCode()
void	setDuration(TrialOffer.Duration duration)
void	setEndBehavior(TrialOffer.EndBehavior endBehavior)
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	setPrice(String id)
void	setPriceObject(Price expandableObject)
void	setResponseGetter(StripeResponseGetter responseGetter)	The new price to use at the end of the trial offer period.

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

TrialOffer

public TrialOffer()

Method Details

getPrice

public String getPrice()

Get ID of expandable price object.

setPrice

public void setPrice(String id)

getPriceObject

public Price getPriceObject()

Get expanded price.

setPriceObject

public void setPriceObject(Price expandableObject)

create

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

Creates a trial offer.

Throws:

StripeException

create

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

Creates a trial offer.

Throws:

StripeException

create

public static TrialOffer create(TrialOfferCreateParams params)
                         throws StripeException

Creates a trial offer.

Throws:

StripeException

create

public static TrialOffer create(TrialOfferCreateParams params,
 RequestOptions options)
                         throws StripeException

Creates a trial offer.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

The new price to use at the end of the trial offer period.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getDuration

public TrialOffer.Duration getDuration()

getEndBehavior

public TrialOffer.EndBehavior getEndBehavior()

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 product_catalog.trial_offer.

setDuration

public void setDuration(TrialOffer.Duration duration)

setEndBehavior

public void setEndBehavior(TrialOffer.EndBehavior endBehavior)

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 product_catalog.trial_offer.

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