Package com.stripe.param
Class CustomerUpdateParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.CustomerUpdateParams
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
State, county, province, or region.static class
Method for using the customer balance to pay outstandingcustomer_balance
PaymentIntents.static class
The value of the custom field.static class
State, county, province, or region.static enum
A recent IP address of the customer used for tax reporting and tax location inference.static enum
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 TypeMethodDescriptionstatic CustomerUpdateParams.Builder
builder()
The customer's address.An integer amount in %s that represents the customer's current balance, which affect the customer's future invoices.Balance information and default balance settings for this customer.If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter.An arbitrary string that you can attach to a customer object.getEmail()
Customer's email address.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.The prefix for the customer used to generate unique invoice numbers.Default invoice settings for this customer.Set of key-value pairs that you can attach to an object.getName()
The customer's full name or business name.The sequence to be used on the customer's next invoice.getPhone()
The customer's phone number.Customer's preferred languages, ordered by preference.The API ID of a promotion code to apply to the customer.The customer's shipping information.getTax()
Tax details about the customer.The customer's tax exemption.Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
Method Details
-
builder
-
getAddress
The customer's address. -
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
Balance information and default balance settings for this customer. -
getCoupon
-
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
An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. -
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
Specifies which fields in the response should be expanded. -
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
The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. -
getInvoiceSettings
Default invoice settings for this customer. -
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 tometadata
. -
getName
The customer's full name or business name. -
getNextInvoiceSequence
The sequence to be used on the customer's next invoice. Defaults to 1. -
getPhone
The customer's phone number. -
getPreferredLocales
Customer's preferred languages, ordered by preference. -
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
The customer's shipping information. Appears on invoices emailed to this customer. -
getSource
-
getTax
Tax details about the customer. -
getTaxExempt
The customer's tax exemption. One ofnone
,exempt
, orreverse
. -
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 valuenow
can be provided to end the customer's trial immediately. Can be at most two years frombilling_cycle_anchor
.
-