Package com.stripe.model.billing

Class CreditBalanceTransaction

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.billing.CreditBalanceTransaction

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class CreditBalanceTransaction
extends ApiResource
implements HasId

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
CreditBalanceTransaction.Credit	getCredit()	Credit details for this credit balance transaction.
String	getCreditGrant()	Get ID of expandable creditGrant object.
CreditGrant	getCreditGrantObject()	Get expanded creditGrant.
CreditBalanceTransaction.Debit	getDebit()	Debit details for this credit balance transaction.
Long	getEffectiveAt()	The effective time of this credit balance transaction.
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	getTestClock()	Get ID of expandable testClock object.
TestClock	getTestClockObject()	Get expanded testClock.
String	getType()	The type of credit balance transaction (credit or debit).
int	hashCode()
static CreditBalanceTransactionCollection	list(CreditBalanceTransactionListParams params)	Retrieve a list of credit balance transactions.
static CreditBalanceTransactionCollection	list(CreditBalanceTransactionListParams params, RequestOptions options)	Retrieve a list of credit balance transactions.
static CreditBalanceTransactionCollection	list(Map<String,Object> params)	Retrieve a list of credit balance transactions.
static CreditBalanceTransactionCollection	list(Map<String,Object> params, RequestOptions options)	Retrieve a list of credit balance transactions.
static CreditBalanceTransaction	retrieve(String id)	Retrieves a credit balance transaction.
static CreditBalanceTransaction	retrieve(String id, RequestOptions options)	Retrieves a credit balance transaction.
static CreditBalanceTransaction	retrieve(String id, CreditBalanceTransactionRetrieveParams params, RequestOptions options)	Retrieves a credit balance transaction.
static CreditBalanceTransaction	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a credit balance transaction.
void	setCreated(Long created)	Time at which the object was created.
void	setCredit(CreditBalanceTransaction.Credit credit)	Credit details for this credit balance transaction.
void	setCreditGrant(String id)
void	setCreditGrantObject(CreditGrant expandableObject)
void	setDebit(CreditBalanceTransaction.Debit debit)	Debit details for this credit balance transaction.
void	setEffectiveAt(Long effectiveAt)	The effective time of this credit balance transaction.
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	setResponseGetter(StripeResponseGetter responseGetter)	Get expanded invoice.
void	setTestClock(String id)
void	setTestClockObject(TestClock expandableObject)
void	setType(String type)	The type of credit balance transaction (credit or debit).

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

CreditBalanceTransaction

public CreditBalanceTransaction()

Method Details

getCreditGrant

public String getCreditGrant()

Get ID of expandable creditGrant object.

setCreditGrant

public void setCreditGrant(String id)

getCreditGrantObject

public CreditGrant getCreditGrantObject()

Get expanded creditGrant.

setCreditGrantObject

public void setCreditGrantObject(CreditGrant 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)

list

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

Retrieve a list of credit balance transactions.

Throws:

StripeException

list

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

Retrieve a list of credit balance transactions.

Throws:

StripeException

list

public static CreditBalanceTransactionCollection list(CreditBalanceTransactionListParams params)
                                               throws StripeException

Retrieve a list of credit balance transactions.

Throws:

StripeException

list

public static CreditBalanceTransactionCollection list(CreditBalanceTransactionListParams params,
 RequestOptions options)
                                               throws StripeException

Retrieve a list of credit balance transactions.

Throws:

StripeException

retrieve

public static CreditBalanceTransaction retrieve(String id)
                                         throws StripeException

Retrieves a credit balance transaction.

Throws:

StripeException

retrieve

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

Retrieves a credit balance transaction.

Throws:

StripeException

retrieve

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

Retrieves a credit balance transaction.

Throws:

StripeException

retrieve

public static CreditBalanceTransaction retrieve(String id,
 CreditBalanceTransactionRetrieveParams params,
 RequestOptions options)
                                         throws StripeException

Retrieves a credit balance transaction.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Get expanded invoice.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

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

getCreated

public Long getCreated()

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

getCredit

public CreditBalanceTransaction.Credit getCredit()

Credit details for this credit balance transaction. Only present if type is credit.

getDebit

public CreditBalanceTransaction.Debit getDebit()

Debit details for this credit balance transaction. Only present if type is debit.

getEffectiveAt

public Long getEffectiveAt()

The effective time of this credit balance transaction.

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 billing.credit_balance_transaction.

getType

public String getType()

The type of credit balance transaction (credit or debit).

One of credit, or debit.

setCreated

public void setCreated(Long created)

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

setCredit

public void setCredit(CreditBalanceTransaction.Credit credit)

Credit details for this credit balance transaction. Only present if type is credit.

setDebit

public void setDebit(CreditBalanceTransaction.Debit debit)

Debit details for this credit balance transaction. Only present if type is debit.

setEffectiveAt

public void setEffectiveAt(Long effectiveAt)

The effective time of this credit balance transaction.

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 billing.credit_balance_transaction.

setType

public void setType(String type)

The type of credit balance transaction (credit or debit).

One of credit, or debit.

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