Package com.stripe.param

Class CustomerCreateParams.Builder

java.lang.Object
com.stripe.param.CustomerCreateParams.Builder
Enclosing class:
CustomerCreateParams
public static class CustomerCreateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public CustomerCreateParams build()
      Finalize and obtain parameter instance from this builder.

    • setAddress

      public CustomerCreateParams.Builder setAddress(CustomerCreateParams.Address address)
      The customer's address.

    • setAddress

      public CustomerCreateParams.Builder setAddress(EmptyParam address)
      The customer's address.

    • setBalance

      public CustomerCreateParams.Builder setBalance(Long balance)
      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.

    • setCashBalance

      public CustomerCreateParams.Builder setCashBalance(CustomerCreateParams.CashBalance cashBalance)
      Balance information and default balance settings for this customer.

    • setCoupon

      public CustomerCreateParams.Builder setCoupon(String coupon)

    • setDescription

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

    • setEmail

      public CustomerCreateParams.Builder setEmail(String email)
      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.

    • addExpand

      public CustomerCreateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CustomerCreateParams.expand for the field documentation.

    • addAllExpand

      public CustomerCreateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CustomerCreateParams.expand for the field documentation.

    • putExtraParam

      public CustomerCreateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See CustomerCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public CustomerCreateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See CustomerCreateParams.extraParams for the field documentation.

    • setInvoicePrefix

      public CustomerCreateParams.Builder setInvoicePrefix(String invoicePrefix)
      The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.

    • setInvoiceSettings

      public CustomerCreateParams.Builder setInvoiceSettings(CustomerCreateParams.InvoiceSettings invoiceSettings)
      Default invoice settings for this customer.

    • putMetadata

      public CustomerCreateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See CustomerCreateParams.metadata for the field documentation.

    • putAllMetadata

      public CustomerCreateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See CustomerCreateParams.metadata for the field documentation.

    • setMetadata

      public CustomerCreateParams.Builder setMetadata(EmptyParam 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • setMetadata

      public CustomerCreateParams.Builder setMetadata(Map<String,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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • setName

      public CustomerCreateParams.Builder setName(String name)
      The customer's full name or business name.

    • setNextInvoiceSequence

      public CustomerCreateParams.Builder setNextInvoiceSequence(Long nextInvoiceSequence)
      The sequence to be used on the customer's next invoice. Defaults to 1.

    • setPaymentMethod

      public CustomerCreateParams.Builder setPaymentMethod(String paymentMethod)

    • setPhone

      public CustomerCreateParams.Builder setPhone(String phone)
      The customer's phone number.

    • addPreferredLocale

      public CustomerCreateParams.Builder addPreferredLocale(String element)
      Add an element to `preferredLocales` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CustomerCreateParams.preferredLocales for the field documentation.

    • addAllPreferredLocale

      public CustomerCreateParams.Builder addAllPreferredLocale(List<String> elements)
      Add all elements to `preferredLocales` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CustomerCreateParams.preferredLocales for the field documentation.

    • setPromotionCode

      public CustomerCreateParams.Builder setPromotionCode(String promotionCode)
      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.

    • setShipping

      public CustomerCreateParams.Builder setShipping(CustomerCreateParams.Shipping shipping)
      The customer's shipping information. Appears on invoices emailed to this customer.

    • setShipping

      public CustomerCreateParams.Builder setShipping(EmptyParam shipping)
      The customer's shipping information. Appears on invoices emailed to this customer.

    • setSource

      public CustomerCreateParams.Builder setSource(String source)

    • setTax

      public CustomerCreateParams.Builder setTax(CustomerCreateParams.Tax tax)
      Tax details about the customer.

    • setTaxExempt

      public CustomerCreateParams.Builder setTaxExempt(CustomerCreateParams.TaxExempt taxExempt)
      The customer's tax exemption. One of none, exempt, or reverse.

    • setTaxExempt

      public CustomerCreateParams.Builder setTaxExempt(EmptyParam taxExempt)
      The customer's tax exemption. One of none, exempt, or reverse.

    • addTaxIdData

      public CustomerCreateParams.Builder addTaxIdData(CustomerCreateParams.TaxIdData element)
      Add an element to `taxIdData` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CustomerCreateParams.taxIdData for the field documentation.

    • addAllTaxIdData

      public CustomerCreateParams.Builder addAllTaxIdData(List<CustomerCreateParams.TaxIdData> elements)
      Add all elements to `taxIdData` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See CustomerCreateParams.taxIdData for the field documentation.

    • setTestClock

      public CustomerCreateParams.Builder setTestClock(String testClock)
      ID of the test clock to attach to the customer.

    • setValidate

      public CustomerCreateParams.Builder setValidate(Boolean validate)