com.stripe.param

Class CustomerCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.CustomerCreateParams

public class CustomerCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomerCreateParams.Address
static class	CustomerCreateParams.Builder
static class	CustomerCreateParams.InvoiceSettings Add all map key/value pairs to `extraParams` map.
static class	CustomerCreateParams.Shipping The value of the custom field.
static class	CustomerCreateParams.TaxExempt
static class	CustomerCreateParams.TaxIdData Add all map key/value pairs to `extraParams` map.
static class	CustomerCreateParams.TaxInfo

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static CustomerCreateParams.Builder	builder()
java.lang.Object	getAddress() The customer's address.
java.lang.Long	getBalance() An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices.
java.lang.String	getCoupon()
java.lang.String	getDescription() An arbitrary string that you can attach to a customer object.
java.lang.String	getEmail() Customer's email address.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.String	getInvoicePrefix() The prefix for the customer used to generate unique invoice numbers.
CustomerCreateParams.InvoiceSettings	getInvoiceSettings() Default invoice settings for this customer.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() A set of key-value pairs that you can attach to a customer object.
java.lang.String	getName() The customer's full name or business name.
java.lang.String	getPaymentMethod()
java.lang.String	getPhone() The customer's phone number.
java.util.List<java.lang.String>	getPreferredLocales() Customer's preferred languages, ordered by preference.
java.lang.Object	getShipping() The customer's shipping information.
java.lang.String	getSource()
ApiRequestParams.EnumParam	getTaxExempt() The customer's tax exemption.
java.util.List<CustomerCreateParams.TaxIdData>	getTaxIdData() The customer's tax IDs.
CustomerCreateParams.TaxInfo	getTaxInfo() The customer's tax information.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static CustomerCreateParams.Builder builder()

getAddress

public java.lang.Object getAddress()

The customer's address.

getBalance

public java.lang.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.

getCoupon

public java.lang.String getCoupon()

getDescription

public java.lang.String getDescription()

An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

getEmail

public java.lang.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 java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.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 java.lang.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 java.util.Map<java.lang.String,java.lang.String> getMetadata()

A set of key-value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

getName

public java.lang.String getName()

The customer's full name or business name.

getPaymentMethod

public java.lang.String getPaymentMethod()

getPhone

public java.lang.String getPhone()

The customer's phone number.

getPreferredLocales

public java.util.List<java.lang.String> getPreferredLocales()

Customer's preferred languages, ordered by preference.

getShipping

public java.lang.Object getShipping()

The customer's shipping information. Appears on invoices emailed to this customer.

getSource

public java.lang.String getSource()

getTaxExempt

public ApiRequestParams.EnumParam getTaxExempt()

The customer's tax exemption. One of `none`, `exempt`, or `reverse`.

getTaxIdData

public java.util.List<CustomerCreateParams.TaxIdData> getTaxIdData()

The customer's tax IDs.

getTaxInfo

public CustomerCreateParams.TaxInfo getTaxInfo()

The customer's tax information. Appears on invoices emailed to this customer. This parameter has been deprecated and will be removed in a future API version, for further information view the [migration guide](https://stripe.com/docs/billing/migration/taxes#moving-from-taxinfo-to-customer-tax-ids).