Package com.stripe.model.billing

Class CreditGrant

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.billing.CreditGrant

All Implemented Interfaces:

HasId, MetadataStore<CreditGrant>, StripeActiveObject, StripeObjectInterface

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

A credit grant is an API resource that documents the allocation of some billing credits to a customer.

Related guide: Billing credits

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static CreditGrant	create(CreditGrantCreateParams params)	Creates a credit grant.
static CreditGrant	create(CreditGrantCreateParams params, RequestOptions options)	Creates a credit grant.
static CreditGrant	create(Map<String,Object> params)	Creates a credit grant.
static CreditGrant	create(Map<String,Object> params, RequestOptions options)	Creates a credit grant.
boolean	equals(Object o)
CreditGrant	expire()	Expires a credit grant.
CreditGrant	expire(RequestOptions options)	Expires a credit grant.
CreditGrant	expire(CreditGrantExpireParams params)	Expires a credit grant.
CreditGrant	expire(CreditGrantExpireParams params, RequestOptions options)	Expires a credit grant.
CreditGrant	expire(Map<String,Object> params)	Expires a credit grant.
CreditGrant	expire(Map<String,Object> params, RequestOptions options)	Expires a credit grant.
CreditGrant.Amount	getAmount()
CreditGrant.ApplicabilityConfig	getApplicabilityConfig()
String	getCategory()	The category of this credit grant.
Long	getCreated()	Time at which the object was created.
String	getCustomer()	Get ID of expandable customer object.
String	getCustomerAccount()	ID of the account receiving the billing credits.
Customer	getCustomerObject()	Get expanded customer.
Long	getEffectiveAt()	The time when the billing credits become effective-when they're eligible for use.
Long	getExpiresAt()	The time when the billing credits expire.
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.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getName()	A descriptive name shown in dashboard.
String	getObject()	String representing the object's type.
Long	getPriority()	The priority for applying this credit grant.
String	getTestClock()	Get ID of expandable testClock object.
TestClock	getTestClockObject()	Get expanded testClock.
Long	getUpdated()	Time at which the object was last updated.
Long	getVoidedAt()	The time when this credit grant was voided.
int	hashCode()
static CreditGrantCollection	list(CreditGrantListParams params)	Retrieve a list of credit grants.
static CreditGrantCollection	list(CreditGrantListParams params, RequestOptions options)	Retrieve a list of credit grants.
static CreditGrantCollection	list(Map<String,Object> params)	Retrieve a list of credit grants.
static CreditGrantCollection	list(Map<String,Object> params, RequestOptions options)	Retrieve a list of credit grants.
static CreditGrant	retrieve(String id)	Retrieves a credit grant.
static CreditGrant	retrieve(String id, RequestOptions options)	Retrieves a credit grant.
static CreditGrant	retrieve(String id, CreditGrantRetrieveParams params, RequestOptions options)	Retrieves a credit grant.
static CreditGrant	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a credit grant.
void	setAmount(CreditGrant.Amount amount)
void	setApplicabilityConfig(CreditGrant.ApplicabilityConfig applicabilityConfig)
void	setCategory(String category)	The category of this credit grant.
void	setCreated(Long created)	Time at which the object was created.
void	setCustomer(String id)
void	setCustomerAccount(String customerAccount)	ID of the account receiving the billing credits.
void	setCustomerObject(Customer expandableObject)
void	setEffectiveAt(Long effectiveAt)	The time when the billing credits become effective-when they're eligible for use.
void	setExpiresAt(Long expiresAt)	The time when the billing credits expire.
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	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setName(String name)	A descriptive name shown in dashboard.
void	setObject(String object)	String representing the object's type.
void	setPriority(Long priority)	The priority for applying this credit grant.
void	setResponseGetter(StripeResponseGetter responseGetter)	Unique identifier for the object.
void	setTestClock(String id)
void	setTestClockObject(TestClock expandableObject)
void	setUpdated(Long updated)	Time at which the object was last updated.
void	setVoidedAt(Long voidedAt)	The time when this credit grant was voided.
CreditGrant	update(CreditGrantUpdateParams params)	Updates a credit grant.
CreditGrant	update(CreditGrantUpdateParams params, RequestOptions options)	Updates a credit grant.
CreditGrant	update(Map<String,Object> params)	Updates a credit grant.
CreditGrant	update(Map<String,Object> params, RequestOptions options)	Updates a credit grant.
CreditGrant	voidGrant()	Voids a credit grant.
CreditGrant	voidGrant(RequestOptions options)	Voids a credit grant.
CreditGrant	voidGrant(CreditGrantVoidGrantParams params)	Voids a credit grant.
CreditGrant	voidGrant(CreditGrantVoidGrantParams params, RequestOptions options)	Voids a credit grant.
CreditGrant	voidGrant(Map<String,Object> params)	Voids a credit grant.
CreditGrant	voidGrant(Map<String,Object> params, RequestOptions options)	Voids a credit grant.

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

CreditGrant

public CreditGrant()

Method Details

getCustomer

public String getCustomer()

Get ID of expandable customer object.

setCustomer

public void setCustomer(String id)

getCustomerObject

public Customer getCustomerObject()

Get expanded customer.

setCustomerObject

public void setCustomerObject(Customer expandableObject)

getTestClock

public String getTestClock()

Get ID of expandable testClock object.

setTestClock

public void setTestClock(String id)

getTestClockObject

public TestClock getTestClockObject()

Get expanded testClock.

setTestClockObject

public void setTestClockObject(TestClock expandableObject)

create

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

Creates a credit grant.

Throws:

StripeException

create

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

Creates a credit grant.

Throws:

StripeException

create

public static CreditGrant create(CreditGrantCreateParams params)
                          throws StripeException

Creates a credit grant.

Throws:

StripeException

create

public static CreditGrant create(CreditGrantCreateParams params,
 RequestOptions options)
                          throws StripeException

Creates a credit grant.

Throws:

StripeException

expire

public CreditGrant expire()
                   throws StripeException

Expires a credit grant.

Throws:

StripeException

expire

public CreditGrant expire(RequestOptions options)
                   throws StripeException

Expires a credit grant.

Throws:

StripeException

expire

public CreditGrant expire(Map<String,Object> params)
                   throws StripeException

Expires a credit grant.

Throws:

StripeException

expire

public CreditGrant expire(Map<String,Object> params,
 RequestOptions options)
                   throws StripeException

Expires a credit grant.

Throws:

StripeException

expire

public CreditGrant expire(CreditGrantExpireParams params)
                   throws StripeException

Expires a credit grant.

Throws:

StripeException

expire

public CreditGrant expire(CreditGrantExpireParams params,
 RequestOptions options)
                   throws StripeException

Expires a credit grant.

Throws:

StripeException

list

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

Retrieve a list of credit grants.

Throws:

StripeException

list

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

Retrieve a list of credit grants.

Throws:

StripeException

list

public static CreditGrantCollection list(CreditGrantListParams params)
                                  throws StripeException

Retrieve a list of credit grants.

Throws:

StripeException

list

public static CreditGrantCollection list(CreditGrantListParams params,
 RequestOptions options)
                                  throws StripeException

Retrieve a list of credit grants.

Throws:

StripeException

retrieve

public static CreditGrant retrieve(String id)
                            throws StripeException

Retrieves a credit grant.

Throws:

StripeException

retrieve

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

Retrieves a credit grant.

Throws:

StripeException

retrieve

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

Retrieves a credit grant.

Throws:

StripeException

retrieve

public static CreditGrant retrieve(String id,
 CreditGrantRetrieveParams params,
 RequestOptions options)
                            throws StripeException

Retrieves a credit grant.

Throws:

StripeException

update

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

Updates a credit grant.

Specified by:

update in interface MetadataStore<CreditGrant>

Throws:

StripeException

update

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

Updates a credit grant.

Specified by:

update in interface MetadataStore<CreditGrant>

Throws:

StripeException

update

public CreditGrant update(CreditGrantUpdateParams params)
                   throws StripeException

Updates a credit grant.

Throws:

StripeException

update

public CreditGrant update(CreditGrantUpdateParams params,
 RequestOptions options)
                   throws StripeException

Updates a credit grant.

Throws:

StripeException

voidGrant

public CreditGrant voidGrant()
                      throws StripeException

Voids a credit grant.

Throws:

StripeException

voidGrant

public CreditGrant voidGrant(RequestOptions options)
                      throws StripeException

Voids a credit grant.

Throws:

StripeException

voidGrant

public CreditGrant voidGrant(Map<String,Object> params)
                      throws StripeException

Voids a credit grant.

Throws:

StripeException

voidGrant

public CreditGrant voidGrant(Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

Voids a credit grant.

Throws:

StripeException

voidGrant

public CreditGrant voidGrant(CreditGrantVoidGrantParams params)
                      throws StripeException

Voids a credit grant.

Throws:

StripeException

voidGrant

public CreditGrant voidGrant(CreditGrantVoidGrantParams params,
 RequestOptions options)
                      throws StripeException

Voids a credit grant.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Unique identifier for the object.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getAmount

public CreditGrant.Amount getAmount()

getApplicabilityConfig

public CreditGrant.ApplicabilityConfig getApplicabilityConfig()

getCategory

public String getCategory()

The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.

One of paid, or promotional.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCustomerAccount

public String getCustomerAccount()

ID of the account receiving the billing credits.

getEffectiveAt

public Long getEffectiveAt()

The time when the billing credits become effective-when they're eligible for use.

getExpiresAt

public Long getExpiresAt()

The time when the billing credits expire. If not present, the billing credits don't expire.

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.

getName

public String getName()

A descriptive name shown in dashboard.

getObject

public String getObject()

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

Equal to billing.credit_grant.

getPriority

public Long getPriority()

The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.

getUpdated

public Long getUpdated()

Time at which the object was last updated. Measured in seconds since the Unix epoch.

getVoidedAt

public Long getVoidedAt()

The time when this credit grant was voided. If not present, the credit grant hasn't been voided.

setAmount

public void setAmount(CreditGrant.Amount amount)

setApplicabilityConfig

public void setApplicabilityConfig(CreditGrant.ApplicabilityConfig applicabilityConfig)

setCategory

public void setCategory(String category)

The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.

One of paid, or promotional.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCustomerAccount

public void setCustomerAccount(String customerAccount)

ID of the account receiving the billing credits.

setEffectiveAt

public void setEffectiveAt(Long effectiveAt)

The time when the billing credits become effective-when they're eligible for use.

setExpiresAt

public void setExpiresAt(Long expiresAt)

The time when the billing credits expire. If not present, the billing credits don't expire.

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.

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)

A descriptive name shown in dashboard.

setObject

public void setObject(String object)

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

Equal to billing.credit_grant.

setPriority

public void setPriority(Long priority)

The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.

setUpdated

public void setUpdated(Long updated)

Time at which the object was last updated. Measured in seconds since the Unix epoch.

setVoidedAt

public void setVoidedAt(Long voidedAt)

The time when this credit grant was voided. If not present, the credit grant hasn't been voided.

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