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

Trial offers let you define free or paid introductory pricing for a subscription item. A TrialOffer specifies the price to charge during the trial, how many billing intervals the trial lasts, and what price the subscription item transitions to when the trial ends. You attach a TrialOffer to a subscription item using items[current_trial][trial_offer] when creating or updating a subscription.

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)
Boolean	getActive()	Whether the trial offer is active.
TrialOffer.Duration	getDuration()
TrialOffer.EndBehavior	getEndBehavior()
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	If the object exists in live mode, the value is true.
String	getNickname()	A brief description of the trial offer, hidden from customers.
String	getObject()	String representing the object's type.
String	getPrice()	Get ID of expandable price object.
Price	getPriceObject()	Get expanded price.
int	hashCode()
static TrialOfferCollection	list(TrialOfferListParams params)	Returns a list of trial offers.
static TrialOfferCollection	list(TrialOfferListParams params, RequestOptions options)	Returns a list of trial offers.
static TrialOfferCollection	list(Map<String,Object> params)	Returns a list of trial offers.
static TrialOfferCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of trial offers.
static TrialOffer	retrieve(String id)	Retrieves the trial offer with the given ID.
static TrialOffer	retrieve(String id, RequestOptions options)	Retrieves the trial offer with the given ID.
static TrialOffer	retrieve(String id, TrialOfferRetrieveParams params, RequestOptions options)	Retrieves the trial offer with the given ID.
static TrialOffer	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves the trial offer with the given ID.
void	setActive(Boolean active)	Whether the trial offer is active.
void	setDuration(TrialOffer.Duration duration)
void	setEndBehavior(TrialOffer.EndBehavior endBehavior)
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	setNickname(String nickname)	A brief description of the trial offer, hidden from customers.
void	setObject(String object)	String representing the object's type.
void	setPrice(String id)
void	setPriceObject(Price expandableObject)
void	setResponseGetter(StripeResponseGetter responseGetter)	Get expanded price.
TrialOffer	update(TrialOfferUpdateParams params)	Updates the specified trial offer by setting the values of the parameters passed.
TrialOffer	update(TrialOfferUpdateParams params, RequestOptions options)	Updates the specified trial offer by setting the values of the parameters passed.
TrialOffer	update(Map<String,Object> params)	Updates the specified trial offer by setting the values of the parameters passed.
TrialOffer	update(Map<String,Object> params, RequestOptions options)	Updates the specified trial offer by setting the values of the parameters passed.

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

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

list

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

Returns a list of trial offers.

Throws:

StripeException

list

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

Returns a list of trial offers.

Throws:

StripeException

list

public static TrialOfferCollection list(TrialOfferListParams params)
                                 throws StripeException

Returns a list of trial offers.

Throws:

StripeException

list

public static TrialOfferCollection list(TrialOfferListParams params,
 RequestOptions options)
                                 throws StripeException

Returns a list of trial offers.

Throws:

StripeException

retrieve

public static TrialOffer retrieve(String id)
                           throws StripeException

Retrieves the trial offer with the given ID.

Throws:

StripeException

retrieve

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

Retrieves the trial offer with the given ID.

Throws:

StripeException

retrieve

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

Retrieves the trial offer with the given ID.

Throws:

StripeException

retrieve

public static TrialOffer retrieve(String id,
 TrialOfferRetrieveParams params,
 RequestOptions options)
                           throws StripeException

Retrieves the trial offer with the given ID.

Throws:

StripeException

update

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

Updates the specified trial offer by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Throws:

StripeException

update

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

Updates the specified trial offer by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Throws:

StripeException

update

public TrialOffer update(TrialOfferUpdateParams params)
                  throws StripeException

Updates the specified trial offer by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Throws:

StripeException

update

public TrialOffer update(TrialOfferUpdateParams params,
 RequestOptions options)
                  throws StripeException

Updates the specified trial offer by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Get expanded price.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getActive

public Boolean getActive()

Whether the trial offer is active. Set to false to archive the trial offer.

getDuration

public TrialOffer.Duration getDuration()

getEndBehavior

public TrialOffer.EndBehavior getEndBehavior()

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.

getNickname

public String getNickname()

A brief description of the trial offer, hidden from customers.

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.

setActive

public void setActive(Boolean active)

Whether the trial offer is active. Set to false to archive the 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)

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

setNickname

public void setNickname(String nickname)

A brief description of the trial offer, hidden from customers.

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