com.stripe.param

Class CustomerUpdateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.CustomerUpdateParams

public class CustomerUpdateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

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

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 CustomerUpdateParams.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.Object	getCoupon()
java.lang.Object	getDefaultSource() Provide the ID of a payment source already attached to this customer to make it this customer's default payment source.
java.lang.Object	getDescription() An arbitrary string that you can attach to a customer object.
java.lang.Object	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.Object	getInvoicePrefix() The prefix for the customer used to generate unique invoice numbers.
CustomerUpdateParams.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.Object	getName() The customer's full name or business name.
java.lang.Object	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.Object	getSource()
ApiRequestParams.EnumParam	getTaxExempt() The customer's tax exemption.
CustomerUpdateParams.TaxInfo	getTaxInfo() The customer's tax information.
java.lang.Object	getTrialEnd() 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

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CustomerUpdateParams.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.Object getCoupon()

getDefaultSource

public java.lang.Object getDefaultSource()

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](https://stripe.com/docs/api/customers/update#update_customer-source) property.

getDescription

public java.lang.Object 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.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 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.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 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.Object getName()

The customer's full name or business name.

getPhone

public java.lang.Object 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.Object getSource()

getTaxExempt

public ApiRequestParams.EnumParam getTaxExempt()

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

getTaxInfo

public CustomerUpdateParams.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).

getTrialEnd

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