Package com.stripe.model.billing

Class CreditBalanceSummary

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.billing.CreditBalanceSummary
All Implemented Interfaces:
StripeActiveObject, StripeObjectInterface
public class CreditBalanceSummary extends ApiResource
Indicates the billing credit balance for billing credits granted to a customer.

  • Constructor Details

    • CreditBalanceSummary

      public CreditBalanceSummary()

  • 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)

    • retrieve

      public static CreditBalanceSummary retrieve() throws StripeException
      Retrieves the credit balance summary for a customer.
      Throws:
      StripeException

    • retrieve

      public static CreditBalanceSummary retrieve(RequestOptions options) throws StripeException
      Retrieves the credit balance summary for a customer.
      Throws:
      StripeException

    • retrieve

      public static CreditBalanceSummary retrieve(Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the credit balance summary for a customer.
      Throws:
      StripeException

    • retrieve

      public static CreditBalanceSummary retrieve(CreditBalanceSummaryRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the credit balance summary for a customer.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      A positive integer representing the amount.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getBalances

      public List<CreditBalanceSummary.Balance> getBalances()
      The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.

    • getCustomerAccount

      public String getCustomerAccount()
      The account the balance is for.

    • 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_summary.

    • setBalances

      public void setBalances(List<CreditBalanceSummary.Balance> balances)
      The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.

    • setCustomerAccount

      public void setCustomerAccount(String customerAccount)
      The account the balance is for.

    • 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_summary.

    • 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