Package com.stripe.param

Class CustomerCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.CustomerCreateParams
public class CustomerCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static CustomerCreateParams.Builder builder()

    • getAddress

      public Object getAddress()
      The customer's address.

    • getBalance

      public Long getBalance()
      An integer amount in cents (or local equivalent) 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 CustomerCreateParams.CashBalance getCashBalance()
      Balance information and default balance settings for this customer.

    • getCoupon

      public String getCoupon()

    • getDescription

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

    • getEmail

      public String 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 String getInvoicePrefix()
      The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

    • getInvoiceSettings

      public CustomerCreateParams.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 String 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.

    • getPaymentMethod

      public String getPaymentMethod()

    • getPhone

      public String getPhone()
      The customer's phone number.

    • getPreferredLocales

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

    • getPromotionCode

      public String getPromotionCode()
      The 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 String getSource()

    • getTax

      public CustomerCreateParams.Tax getTax()
      Tax details about the customer.

    • getTaxExempt

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

    • getTaxIdData

      public List<CustomerCreateParams.TaxIdData> getTaxIdData()
      The customer's tax IDs.

    • getTestClock

      public String getTestClock()
      ID of the test clock to attach to the customer.

    • getValidate

      public Boolean getValidate()