Class CustomerUpdateParams


public class CustomerUpdateParams extends ApiRequestParams
  • Method Details

    • builder

      public static CustomerUpdateParams.Builder builder()
    • getAddress

      public Object getAddress()
      The customer's address.
    • getBalance

      public Long getBalance()
      An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
    • getCashBalance

      public CustomerUpdateParams.CashBalance getCashBalance()
      Balance information and default balance settings for this customer.
    • getCoupon

      public Object getCoupon()
    • getDefaultSource

      public Object getDefaultSource()
      If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter.

      Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.

      If you want to add a new payment source and make it the default, see the source property.

    • getDescription

      public Object getDescription()
      An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
    • getEmail

      public Object getEmail()
      Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getInvoicePrefix

      public Object getInvoicePrefix()
      The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
    • getInvoiceSettings

      public CustomerUpdateParams.InvoiceSettings getInvoiceSettings()
      Default invoice settings for this customer.
    • getMetadata

      public Object 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    • getName

      public Object getName()
      The customer's full name or business name.
    • getNextInvoiceSequence

      public Long getNextInvoiceSequence()
      The sequence to be used on the customer's next invoice. Defaults to 1.
    • getPhone

      public Object getPhone()
      The customer's phone number.
    • getPreferredLocales

      public List<String> getPreferredLocales()
      Customer's preferred languages, ordered by preference.
    • getPromotionCode

      public Object getPromotionCode()
      The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
    • getShipping

      public Object getShipping()
      The customer's shipping information. Appears on invoices emailed to this customer.
    • getSource

      public Object getSource()
    • getTax

      public CustomerUpdateParams.Tax getTax()
      Tax details about the customer.
    • getTaxExempt

      public ApiRequestParams.EnumParam getTaxExempt()
      The customer's tax exemption. One of none, exempt, or reverse.
    • getTrialEnd

      public Object getTrialEnd()
      Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value now can be provided to end the customer's trial immediately. Can be at most two years from billing_cycle_anchor.