com.stripe.model.CustomerBalanceTransaction Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.CustomerBalanceTransactionUpdateParams;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* Each customer has a Balance value,
* which denotes a debit or credit that's automatically applied to their next invoice upon
* finalization. You may modify the value directly by using the update customer API, or by creating a
* Customer Balance Transaction, which increments or decrements the customer's {@code balance} by
* the specified {@code amount}.
*
* Related guide: Customer balance
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class CustomerBalanceTransaction extends ApiResource
implements HasId, MetadataStore {
/**
* 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 {@code balance}.
*/
@SerializedName("amount")
Long amount;
/** Time at which the object was created. Measured in seconds since the Unix epoch. */
@SerializedName("created")
Long created;
/** The ID of the credit note (if any) related to the transaction. */
@SerializedName("credit_note")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField creditNote;
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** The ID of the customer the transaction belongs to. */
@SerializedName("customer")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField customer;
/** An arbitrary string attached to the object. Often useful for displaying to users. */
@SerializedName("description")
String description;
/**
* The customer's {@code 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.
*/
@SerializedName("ending_balance")
Long endingBalance;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/** The ID of the invoice (if any) related to the transaction. */
@SerializedName("invoice")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField invoice;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/**
* 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.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map metadata;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code customer_balance_transaction}.
*/
@SerializedName("object")
String object;
/**
* Transaction type: {@code adjustment}, {@code applied_to_invoice}, {@code credit_note}, {@code
* initial}, {@code invoice_overpaid}, {@code invoice_too_large}, {@code invoice_too_small},
* {@code unspent_receiver_credit}, or {@code unapplied_from_invoice}. See the Customer Balance page to
* learn more about transaction types.
*
*
One of {@code adjustment}, {@code applied_to_invoice}, {@code credit_note}, {@code initial},
* {@code invoice_overpaid}, {@code invoice_too_large}, {@code invoice_too_small}, {@code
* migration}, {@code unapplied_from_invoice}, or {@code unspent_receiver_credit}.
*/
@SerializedName("type")
String type;
/** Get ID of expandable {@code creditNote} object. */
public String getCreditNote() {
return (this.creditNote != null) ? this.creditNote.getId() : null;
}
public void setCreditNote(String id) {
this.creditNote = ApiResource.setExpandableFieldId(id, this.creditNote);
}
/** Get expanded {@code creditNote}. */
public CreditNote getCreditNoteObject() {
return (this.creditNote != null) ? this.creditNote.getExpanded() : null;
}
public void setCreditNoteObject(CreditNote expandableObject) {
this.creditNote = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code customer} object. */
public String getCustomer() {
return (this.customer != null) ? this.customer.getId() : null;
}
public void setCustomer(String id) {
this.customer = ApiResource.setExpandableFieldId(id, this.customer);
}
/** Get expanded {@code customer}. */
public Customer getCustomerObject() {
return (this.customer != null) ? this.customer.getExpanded() : null;
}
public void setCustomerObject(Customer expandableObject) {
this.customer = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code invoice} object. */
public String getInvoice() {
return (this.invoice != null) ? this.invoice.getId() : null;
}
public void setInvoice(String id) {
this.invoice = ApiResource.setExpandableFieldId(id, this.invoice);
}
/** Get expanded {@code invoice}. */
public Invoice getInvoiceObject() {
return (this.invoice != null) ? this.invoice.getExpanded() : null;
}
public void setInvoiceObject(Invoice expandableObject) {
this.invoice = new ExpandableField(expandableObject.getId(), expandableObject);
}
/**
* Most credit balance transaction fields are immutable, but you may update its {@code
* description} and {@code metadata}.
*/
@Override
public CustomerBalanceTransaction update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Most credit balance transaction fields are immutable, but you may update its {@code
* description} and {@code metadata}.
*/
@Override
public CustomerBalanceTransaction update(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/customers/%s/balance_transactions/%s",
ApiResource.urlEncodeId(this.getCustomer()), ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options);
return getResponseGetter().request(request, CustomerBalanceTransaction.class);
}
/**
* Most credit balance transaction fields are immutable, but you may update its {@code
* description} and {@code metadata}.
*/
public CustomerBalanceTransaction update(CustomerBalanceTransactionUpdateParams params)
throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Most credit balance transaction fields are immutable, but you may update its {@code
* description} and {@code metadata}.
*/
public CustomerBalanceTransaction update(
CustomerBalanceTransactionUpdateParams params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/customers/%s/balance_transactions/%s",
ApiResource.urlEncodeId(this.getCustomer()), ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options);
return getResponseGetter().request(request, CustomerBalanceTransaction.class);
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(creditNote, responseGetter);
trySetResponseGetter(customer, responseGetter);
trySetResponseGetter(invoice, responseGetter);
}
}