com.stripe.model

Class CustomerBalanceTransaction

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.CustomerBalanceTransaction

All Implemented Interfaces:

HasId, MetadataStore<CustomerBalanceTransaction>, StripeObjectInterface

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

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
CustomerBalanceTransaction()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.Long	getAmount() The amount of the transaction.
java.lang.Long	getCreated() Time at which the object was created.
java.lang.String	getCreditNote() Get id of expandable `creditNote` object.
CreditNote	getCreditNoteObject() Get expanded `creditNote`.
java.lang.String	getCurrency() Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
java.lang.String	getCustomer() Get id of expandable `customer` object.
Customer	getCustomerObject() Get expanded `customer`.
java.lang.String	getDescription() An arbitrary string attached to the object.
java.lang.Long	getEndingBalance() The customer's `balance` after the transaction was applied.
java.lang.String	getId() Unique identifier for the object.
java.lang.String	getInvoice() Get id of expandable `invoice` object.
Invoice	getInvoiceObject() Get expanded `invoice`.
java.lang.Boolean	getLivemode() Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.String	getObject() String representing the object's type.
java.lang.String	getType() Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unapplied_from_invoice`, or `unspent_receiver_credit`.
int	hashCode()
void	setAmount(java.lang.Long amount) The amount of the transaction.
void	setCreated(java.lang.Long created) Time at which the object was created.
void	setCreditNote(java.lang.String id)
void	setCreditNoteObject(CreditNote expandableObject)
void	setCurrency(java.lang.String currency) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
void	setCustomer(java.lang.String id)
void	setCustomerObject(Customer expandableObject)
void	setDescription(java.lang.String description) An arbitrary string attached to the object.
void	setEndingBalance(java.lang.Long endingBalance) The customer's `balance` after the transaction was applied.
void	setId(java.lang.String id) Unique identifier for the object.
void	setInvoice(java.lang.String id)
void	setInvoiceObject(Invoice expandableObject)
void	setLivemode(java.lang.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(java.util.Map<java.lang.String,java.lang.String> metadata) Set of key-value pairs that you can attach to an object.
void	setObject(java.lang.String object) String representing the object's type.
void	setType(java.lang.String type) Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unapplied_from_invoice`, or `unspent_receiver_credit`.
CustomerBalanceTransaction	update(CustomerBalanceTransactionUpdateParams params) Most customer balance transaction fields are immutable, but you may update its description and metadata.
CustomerBalanceTransaction	update(CustomerBalanceTransactionUpdateParams params, RequestOptions options) Most customer balance transaction fields are immutable, but you may update its description and metadata.
CustomerBalanceTransaction	update(java.util.Map<java.lang.String,java.lang.Object> params) Most customer balance transaction fields are immutable, but you may update its description and metadata.
CustomerBalanceTransaction	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Most customer balance transaction fields are immutable, but you may update its description and metadata.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomerBalanceTransaction

public CustomerBalanceTransaction()

Method Detail

getCreditNote

public java.lang.String getCreditNote()

Get id of expandable `creditNote` object.

setCreditNote

public void setCreditNote(java.lang.String id)

getCreditNoteObject

public CreditNote getCreditNoteObject()

Get expanded `creditNote`.

setCreditNoteObject

public void setCreditNoteObject(CreditNote expandableObject)

getCustomer

public java.lang.String getCustomer()

Get id of expandable `customer` object.

setCustomer

public void setCustomer(java.lang.String id)

getCustomerObject

public Customer getCustomerObject()

Get expanded `customer`.

setCustomerObject

public void setCustomerObject(Customer expandableObject)

getInvoice

public java.lang.String getInvoice()

Get id of expandable `invoice` object.

setInvoice

public void setInvoice(java.lang.String id)

getInvoiceObject

public Invoice getInvoiceObject()

Get expanded `invoice`.

setInvoiceObject

public void setInvoiceObject(Invoice expandableObject)

update

public CustomerBalanceTransaction update(java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws StripeException

Most customer balance transaction fields are immutable, but you may update its description and metadata.

Specified by:

update in interface MetadataStore<CustomerBalanceTransaction>

Throws:

StripeException

update

public CustomerBalanceTransaction update(java.util.Map<java.lang.String,java.lang.Object> params,
                                         RequestOptions options)
                                  throws StripeException

Most customer balance transaction fields are immutable, but you may update its description and metadata.

Specified by:

update in interface MetadataStore<CustomerBalanceTransaction>

Throws:

StripeException

update

public CustomerBalanceTransaction update(CustomerBalanceTransactionUpdateParams params)
                                  throws StripeException

Most customer balance transaction fields are immutable, but you may update its description and metadata.

Throws:

StripeException

update

public CustomerBalanceTransaction update(CustomerBalanceTransactionUpdateParams params,
                                         RequestOptions options)
                                  throws StripeException

Most customer balance transaction fields are immutable, but you may update its description and metadata.

Throws:

StripeException

getAmount

public java.lang.Long getAmount()

The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.

getCreated

public java.lang.Long getCreated()

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

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

getDescription

public java.lang.String getDescription()

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

getEndingBalance

public java.lang.Long getEndingBalance()

The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.

getLivemode

public java.lang.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 java.lang.String getObject()

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

Equal to `customer_balance_transaction`.

getType

public java.lang.String getType()

Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unapplied_from_invoice`, or `unspent_receiver_credit`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.

One of `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `migration`, `unapplied_from_invoice`, or `unspent_receiver_credit`.

setAmount

public void setAmount(java.lang.Long amount)

The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.

setCreated

public void setCreated(java.lang.Long created)

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

setCurrency

public void setCurrency(java.lang.String currency)

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

setDescription

public void setDescription(java.lang.String description)

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

setEndingBalance

public void setEndingBalance(java.lang.Long endingBalance)

The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.

setId

public void setId(java.lang.String id)

Unique identifier for the object.

setLivemode

public void setLivemode(java.lang.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(java.util.Map<java.lang.String,java.lang.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.

setObject

public void setObject(java.lang.String object)

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

Equal to `customer_balance_transaction`.

setType

public void setType(java.lang.String type)

Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `unapplied_from_invoice`, or `unspent_receiver_credit`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.

One of `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_too_large`, `invoice_too_small`, `migration`, `unapplied_from_invoice`, or `unspent_receiver_credit`.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.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<CustomerBalanceTransaction>