Customer (stripe-java 5.50.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.APIResource
  - - com.stripe.model.Customer

All Implemented Interfaces:: HasId, MetadataStore<Customer>

public class Customer
extends APIResource
implements MetadataStore<Customer>, HasId

Nested Class Summary
- Nested classes/interfaces inherited from class com.stripe.net.APIResource
  APIResource.RequestMethod, APIResource.RequestType

Field Summary
- Fields inherited from class com.stripe.net.APIResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Constructor Summary

Constructors
Constructor and Description

Customer()

Constructors
Constructor and Description
`Customer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static CustomerCollection`	`all(java.util.Map<java.lang.String,java.lang.Object> params)` Deprecated. Use the `list(Map)` method instead. This method will be removed in the next major version.
`static CustomerCollection`	`all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deprecated. Use the `list(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`static CustomerCollection`	`all(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use the `list(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`cancelSubscription()` Deprecated. Use the `Subscription.cancel(Map)` method instead. This method will be removed in the next major version.
`Subscription`	`cancelSubscription(java.util.Map<java.lang.String,java.lang.Object> params)` Deprecated. Use the `Subscription.cancel(Map)` method instead. This method will be removed in the next major version.
`Subscription`	`cancelSubscription(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deprecated. Use the `Subscription.cancel(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`cancelSubscription(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use the `Subscription.cancel(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`cancelSubscription(RequestOptions options)` Deprecated. Use the `Subscription.cancel(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`cancelSubscription(java.lang.String apiKey)` Deprecated. Use the `Subscription.cancel(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`protected boolean`	`canEqual(java.lang.Object other)`
`static Customer`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` Create a customer.
`static Customer`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Create a customer.
`static Customer`	`create(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use the `create(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`BankAccount`	`createBankAccount(java.util.Map<java.lang.String,java.lang.Object> params)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map)` instead. This method will be removed in the next major version.
`BankAccount`	`createBankAccount(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map, RequestOptions)` instead. This method will be removed in the next major version.
`BankAccount`	`createBankAccount(java.lang.String token)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map)` instead. This method will be removed in the next major version.
`BankAccount`	`createBankAccount(java.lang.String token, RequestOptions options)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map, RequestOptions)` instead. This method will be removed in the next major version.
`Card`	`createCard(java.util.Map<java.lang.String,java.lang.Object> params)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map)` instead. This method will be removed in the next major version.
`Card`	`createCard(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map, RequestOptions)` instead. This method will be removed in the next major version.
`Card`	`createCard(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map, RequestOptions)` instead. This method will be removed in the next major version.
`Card`	`createCard(java.lang.String token)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map)` instead. This method will be removed in the next major version.
`Card`	`createCard(java.lang.String token, RequestOptions options)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map, RequestOptions)` instead. This method will be removed in the next major version.
`Card`	`createCard(java.lang.String token, java.lang.String apiKey)` Deprecated. Use `getSources()` and `ExternalAccountCollection.create(Map, RequestOptions)` instead. This method will be removed in the next major version.
`Subscription`	`createSubscription(java.util.Map<java.lang.String,java.lang.Object> params)` Deprecated. Use the `Subscription.create(Map)` method instead. This method will be removed in the next major version.
`Subscription`	`createSubscription(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deprecated. Use the `Subscription.create(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`createSubscription(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use the `Subscription.create(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`DeletedCustomer`	`delete()` Delete a customer.
`DeletedCustomer`	`delete(RequestOptions options)` Delete a customer.
`DeletedCustomer`	`delete(java.lang.String apiKey)` Deprecated. Use the `delete(RequestOptions)` method instead. This method will be removed in the next major version.
`void`	`deleteDiscount()` Delete a customer discount.
`void`	`deleteDiscount(RequestOptions options)` Delete a customer discount.
`void`	`deleteDiscount(java.lang.String apiKey)` Deprecated. Use the `deleteDiscount(RequestOptions)` method instead. This method will be removed in the next major version.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Long`	`getAccountBalance()`
`java.lang.String`	`getBusinessVatId()`
`CustomerCardCollection`	`getCards()` Deprecated. Prefer using the `sources` attribute instead.
`java.lang.Long`	`getCreated()`
`java.lang.String`	`getCurrency()`
`java.lang.String`	`getDefaultCard()` Deprecated. Prefer using the `defaultSource` attribute instead.
`java.lang.String`	`getDefaultSource()`
`ExternalAccount`	`getDefaultSourceObject()`
`java.lang.Boolean`	`getDeleted()`
`java.lang.Boolean`	`getDelinquent()`
`java.lang.String`	`getDescription()`
`Discount`	`getDiscount()`
`java.lang.String`	`getEmail()`
`java.lang.String`	`getId()`
`java.lang.Boolean`	`getLivemode()`
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()`
`NextRecurringCharge`	`getNextRecurringCharge()` Deprecated. Prefer using the `Invoice.upcoming(java.util.Map<java.lang.String, java.lang.Object>)` method instead.
`java.lang.String`	`getObject()`
`ShippingDetails`	`getShipping()`
`ExternalAccountCollection`	`getSources()`
`Subscription`	`getSubscription()` Deprecated. Prefer using the `subscriptions` attribute instead.
`CustomerSubscriptionCollection`	`getSubscriptions()`
`java.lang.Long`	`getTrialEnd()` Deprecated. Prefer using the `subscriptions` attribute instead.
`int`	`hashCode()`
`static CustomerCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` List all customers.
`static CustomerCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` List all customers.
`static Customer`	`retrieve(java.lang.String id)` Retrieve a customer.
`static Customer`	`retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieve a customer.
`static Customer`	`retrieve(java.lang.String id, RequestOptions options)` Retrieve a customer.
`static Customer`	`retrieve(java.lang.String id, java.lang.String apiKey)` Deprecated. Use the `retrieve(String, RequestOptions)` method instead. This method will be removed in the next major version.
`void`	`setAccountBalance(java.lang.Long accountBalance)`
`void`	`setBusinessVatId(java.lang.String businessVatId)`
`void`	`setCards(CustomerCardCollection cards)` Deprecated. Prefer using the `sources` attribute instead.
`void`	`setCreated(java.lang.Long created)`
`void`	`setCurrency(java.lang.String currency)`
`void`	`setDefaultCard(java.lang.String defaultCard)` Deprecated. Prefer using the `defaultSource` attribute instead.
`void`	`setDefaultSource(java.lang.String defaultSourceID)`
`void`	`setDefaultSourceObject(ExternalAccount c)`
`void`	`setDeleted(java.lang.Boolean deleted)`
`void`	`setDelinquent(java.lang.Boolean delinquent)`
`void`	`setDescription(java.lang.String description)`
`void`	`setDiscount(Discount discount)`
`void`	`setEmail(java.lang.String email)`
`void`	`setId(java.lang.String id)`
`void`	`setLivemode(java.lang.Boolean livemode)`
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`void`	`setNextRecurringCharge(NextRecurringCharge nextRecurringCharge)` Deprecated. Prefer using the `Invoice.upcoming(java.util.Map<java.lang.String, java.lang.Object>)` method instead.
`void`	`setObject(java.lang.String object)`
`void`	`setShipping(ShippingDetails shipping)`
`void`	`setSources(ExternalAccountCollection sources)`
`void`	`setSubscription(Subscription subscription)` Deprecated. Prefer using the `subscriptions` attribute instead.
`void`	`setSubscriptions(CustomerSubscriptionCollection subscriptions)`
`void`	`setTrialEnd(java.lang.Long trialEnd)` Deprecated. Prefer using the `subscriptions` attribute instead.
`Customer`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` Update a customer.
`Customer`	`update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Update a customer.
`Customer`	`update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use the `update(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`updateSubscription(java.util.Map<java.lang.String,java.lang.Object> params)` Deprecated. Use the `Subscription.update(Map)` method instead. This method will be removed in the next major version.
`Subscription`	`updateSubscription(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Deprecated. Use the `Subscription.update(Map, RequestOptions)` method instead. This method will be removed in the next major version.
`Subscription`	`updateSubscription(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)` Deprecated. Use the `Subscription.update(Map, RequestOptions)` method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource
classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- Customer
```
public Customer()
```

Method Detail

getDefaultSource

public java.lang.String getDefaultSource()

setDefaultSource

public void setDefaultSource(java.lang.String defaultSourceID)

getDefaultSourceObject

public ExternalAccount getDefaultSourceObject()

setDefaultSourceObject

public void setDefaultSourceObject(ExternalAccount c)

all

@Deprecated
public static CustomerCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all customers.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static CustomerCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                                 RequestOptions options)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all customers.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static CustomerCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                                 java.lang.String apiKey)
                                          throws AuthenticationException,
                                                 InvalidRequestException,
                                                 APIConnectionException,
                                                 CardException,
                                                 APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all customers.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

cancelSubscription

@Deprecated
public Subscription cancelSubscription()
                                            throws AuthenticationException,
                                                   InvalidRequestException,
                                                   APIConnectionException,
                                                   CardException,
                                                   APIException

Deprecated. Use the Subscription.cancel(Map) method instead. This method will be removed in the next major version.