Customer (stripe-java 2.0.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(Map<String,Object> params)` Deprecated.
`static CustomerCollection`	`all(Map<String,Object> params, RequestOptions options)` Deprecated.
`static CustomerCollection`	`all(Map<String,Object> params, String apiKey)` Deprecated.
`Subscription`	`cancelSubscription()` 1/2014: Legacy (from before multiple subscriptions per customer)
`Subscription`	`cancelSubscription(Map<String,Object> params)` 1/2014: Legacy (from before multiple subscriptions per customer)
`Subscription`	`cancelSubscription(Map<String,Object> params, RequestOptions options)`
`Subscription`	`cancelSubscription(Map<String,Object> params, String apiKey)` Deprecated.
`Subscription`	`cancelSubscription(RequestOptions options)`
`Subscription`	`cancelSubscription(String apiKey)` Deprecated.
`static Customer`	`create(Map<String,Object> params)`
`static Customer`	`create(Map<String,Object> params, RequestOptions options)`
`static Customer`	`create(Map<String,Object> params, String apiKey)` Deprecated.
`BankAccount`	`createBankAccount(Map<String,Object> params)`
`BankAccount`	`createBankAccount(Map<String,Object> params, RequestOptions options)`
`BankAccount`	`createBankAccount(String token)`
`BankAccount`	`createBankAccount(String token, RequestOptions options)`
`Card`	`createCard(Map<String,Object> params)`
`Card`	`createCard(Map<String,Object> params, RequestOptions options)`
`Card`	`createCard(Map<String,Object> params, String apiKey)` Deprecated.
`Card`	`createCard(String token)`
`Card`	`createCard(String token, RequestOptions options)`
`Card`	`createCard(String token, String apiKey)` Deprecated.
`Subscription`	`createSubscription(Map<String,Object> params)`
`Subscription`	`createSubscription(Map<String,Object> params, RequestOptions options)`
`Subscription`	`createSubscription(Map<String,Object> params, String apiKey)` Deprecated.
`DeletedCustomer`	`delete()`
`DeletedCustomer`	`delete(RequestOptions options)`
`DeletedCustomer`	`delete(String apiKey)` Deprecated.
`void`	`deleteDiscount()`
`void`	`deleteDiscount(RequestOptions options)`
`void`	`deleteDiscount(String apiKey)` Deprecated.
`Integer`	`getAccountBalance()`
`CustomerCardCollection`	`getCards()`
`Long`	`getCreated()`
`String`	`getCurrency()`
`String`	`getDefaultCard()`
`String`	`getDefaultSource()`
`Boolean`	`getDeleted()`
`Boolean`	`getDelinquent()`
`String`	`getDescription()`
`Discount`	`getDiscount()`
`String`	`getEmail()`
`String`	`getId()`
`Boolean`	`getLivemode()`
`Map<String,String>`	`getMetadata()`
`NextRecurringCharge`	`getNextRecurringCharge()`
`ShippingDetails`	`getShipping()`
`ExternalAccountCollection`	`getSources()`
`Subscription`	`getSubscription()` 1/2014: Legacy (from before multiple subscriptions per customer)
`CustomerSubscriptionCollection`	`getSubscriptions()`
`Long`	`getTrialEnd()`
`static CustomerCollection`	`list(Map<String,Object> params)`
`static CustomerCollection`	`list(Map<String,Object> params, RequestOptions options)`
`static Customer`	`retrieve(String id)`
`static Customer`	`retrieve(String id, RequestOptions options)`
`static Customer`	`retrieve(String id, String apiKey)` Deprecated.
`void`	`setAccountBalance(Integer accountBalance)`
`void`	`setCreated(Long created)`
`void`	`setCurrency(String currency)`
`void`	`setDefaultCard(String defaultCard)`
`void`	`setDefaultSource(String defaultSource)`
`void`	`setDelinquent(Boolean delinquent)`
`void`	`setDescription(String description)`
`void`	`setDiscount(Discount discount)`
`void`	`setEmail(String email)`
`void`	`setId(String id)`
`void`	`setLivemode(Boolean livemode)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setNextRecurringCharge(NextRecurringCharge nextRecurringCharge)`
`void`	`setShipping(ShippingDetails shipping)`
`void`	`setSources(ExternalAccountCollection sources)`
`void`	`setSubscription(Subscription subscription)` 1/2014: Legacy (from before multiple subscriptions per customer)
`void`	`setTrialEnd(Long trialEnd)`
`Customer`	`update(Map<String,Object> params)`
`Customer`	`update(Map<String,Object> params, RequestOptions options)`
`Customer`	`update(Map<String,Object> params, String apiKey)` Deprecated.
`Subscription`	`updateSubscription(Map<String,Object> params)` 1/2014: Legacy (from before multiple subscriptions per customer)
`Subscription`	`updateSubscription(Map<String,Object> params, RequestOptions options)` 1/2014: Legacy (from before multiple subscriptions per customer)
`Subscription`	`updateSubscription(Map<String,Object> params, String apiKey)` Deprecated.

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

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

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

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

Method Detail

getCreated
```
public Long getCreated()
```

setCreated
```
public void setCreated(Long created)
```

getId
```
public String getId()
```
Specified by:

getId in interface HasId

setId
```
public void setId(String id)
```

getLivemode
```
public Boolean getLivemode()
```

setLivemode

public void setLivemode(Boolean livemode)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getDefaultCard
```
public String getDefaultCard()
```

setDefaultCard

public void setDefaultCard(String defaultCard)

getDefaultSource
```
public String getDefaultSource()
```

setDefaultSource

public void setDefaultSource(String defaultSource)

getCards

public CustomerCardCollection getCards()

getSources

public ExternalAccountCollection getSources()

setSources

public void setSources(ExternalAccountCollection sources)

getEmail
```
public String getEmail()
```

setEmail
```
public void setEmail(String email)
```

getTrialEnd
```
public Long getTrialEnd()
```

setTrialEnd

public void setTrialEnd(Long trialEnd)

getDiscount
```
public Discount getDiscount()
```

setDiscount

public void setDiscount(Discount discount)

getNextRecurringCharge

public NextRecurringCharge getNextRecurringCharge()

setNextRecurringCharge

public void setNextRecurringCharge(NextRecurringCharge nextRecurringCharge)

getSubscription
```
public Subscription getSubscription()
```
1/2014: Legacy (from before multiple subscriptions per customer)

setSubscription
```
public void setSubscription(Subscription subscription)
```
1/2014: Legacy (from before multiple subscriptions per customer)

getSubscriptions

public CustomerSubscriptionCollection getSubscriptions()

getDeleted
```
public Boolean getDeleted()
```

getDelinquent
```
public Boolean getDelinquent()
```

setDelinquent

public void setDelinquent(Boolean delinquent)

getAccountBalance
```
public Integer getAccountBalance()
```

setAccountBalance

public void setAccountBalance(Integer accountBalance)

getCurrency
```
public String getCurrency()
```

setCurrency

public void setCurrency(String currency)

getMetadata
```
public Map<String,String> getMetadata()
```
Specified by:

getMetadata in interface MetadataStore<Customer>

setMetadata

public void setMetadata(Map<String,String> metadata)

getShipping
```
public ShippingDetails getShipping()
```

setShipping

public void setShipping(ShippingDetails shipping)

create

public static Customer create(Map<String,Object> params)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

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

retrieve

public static Customer retrieve(String id)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                CardException,
                                APIException

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

update

public Customer update(Map<String,Object> params)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Specified by:: update in interface MetadataStore<Customer>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

public DeletedCustomer delete()
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

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

createCard

public Card createCard(String token)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

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

createCard

public Card createCard(Map<String,Object> params)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

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

createBankAccount

public BankAccount createBankAccount(String token)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

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

createBankAccount

public BankAccount createBankAccount(String token,
                                     RequestOptions options)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

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

createBankAccount

public BankAccount createBankAccount(Map<String,Object> params)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

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

createBankAccount

public BankAccount createBankAccount(Map<String,Object> params,
                                     RequestOptions options)
                              throws AuthenticationException,
                                     InvalidRequestException,
                                     APIConnectionException,
                                     CardException,
                                     APIException

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

createSubscription

public Subscription createSubscription(Map<String,Object> params)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

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

updateSubscription

public Subscription updateSubscription(Map<String,Object> params)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

1/2014: Legacy (from before multiple subscriptions per customer)

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

cancelSubscription

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

1/2014: Legacy (from before multiple subscriptions per customer)

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

cancelSubscription

public Subscription cancelSubscription(Map<String,Object> params)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

1/2014: Legacy (from before multiple subscriptions per customer)

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

deleteDiscount

public void deleteDiscount()
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

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

create

@Deprecated
public static Customer create(Map<String,Object> params,
                                          String apiKey)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

Deprecated.

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

create

public static Customer create(Map<String,Object> params,
                              RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

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

retrieve

@Deprecated
public static Customer retrieve(String id,
                                            String apiKey)
                                     throws AuthenticationException,
                                            InvalidRequestException,
                                            APIConnectionException,
                                            CardException,
                                            APIException

Deprecated.

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

retrieve

public static Customer retrieve(String id,
                                RequestOptions options)
                         throws AuthenticationException,
                                InvalidRequestException,
                                APIConnectionException,
                                CardException,
                                APIException

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

list

public static CustomerCollection list(Map<String,Object> params)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

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

list

public static CustomerCollection list(Map<String,Object> params,
                                      RequestOptions options)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

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

all

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

Deprecated.

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

all

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

Deprecated.

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

all

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

Deprecated.

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

update

@Deprecated
public Customer update(Map<String,Object> params,
                                   String apiKey)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated.

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

update

public Customer update(Map<String,Object> params,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Specified by:: update in interface MetadataStore<Customer>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

@Deprecated
public DeletedCustomer delete(String apiKey)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

Deprecated.

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

delete

public DeletedCustomer delete(RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

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

createCard

@Deprecated
public Card createCard(String token,
                                   String apiKey)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated.

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

createCard

public Card createCard(String token,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

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

createCard

@Deprecated
public Card createCard(Map<String,Object> params,
                                   String apiKey)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated.

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

createCard

public Card createCard(Map<String,Object> params,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

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

createSubscription

@Deprecated
public Subscription createSubscription(Map<String,Object> params,
                                                   String apiKey)
                                            throws AuthenticationException,
                                                   InvalidRequestException,
                                                   APIConnectionException,
                                                   CardException,
                                                   APIException

Deprecated.

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

createSubscription

public Subscription createSubscription(Map<String,Object> params,
                                       RequestOptions options)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

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

updateSubscription

@Deprecated
public Subscription updateSubscription(Map<String,Object> params,
                                                   String apiKey)
                                            throws AuthenticationException,
                                                   InvalidRequestException,
                                                   APIConnectionException,
                                                   CardException,
                                                   APIException

Deprecated.

1/2014: Legacy (from before multiple subscriptions per customer)

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

updateSubscription

public Subscription updateSubscription(Map<String,Object> params,
                                       RequestOptions options)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

1/2014: Legacy (from before multiple subscriptions per customer)

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

cancelSubscription

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

Deprecated.

1/2014: Legacy (from before multiple subscriptions per customer)

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

cancelSubscription

public Subscription cancelSubscription(RequestOptions options)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

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

cancelSubscription

@Deprecated
public Subscription cancelSubscription(Map<String,Object> params,
                                                   String apiKey)
                                            throws AuthenticationException,
                                                   InvalidRequestException,
                                                   APIConnectionException,
                                                   CardException,
                                                   APIException

Deprecated.

1/2014: Legacy (from before multiple subscriptions per customer)

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

cancelSubscription

public Subscription cancelSubscription(Map<String,Object> params,
                                       RequestOptions options)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

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

deleteDiscount

@Deprecated
public void deleteDiscount(String apiKey)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

Deprecated.

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

deleteDiscount

public void deleteDiscount(RequestOptions options)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

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

Class Customer

Nested Class Summary

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

Field Summary

Fields inherited from class com.stripe.net.APIResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.APIResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Customer

Method Detail

getCreated

setCreated

getId

setId

getLivemode

setLivemode

getDescription

setDescription

getDefaultCard

setDefaultCard

getDefaultSource

setDefaultSource

getCards

getSources

setSources

getEmail

setEmail

getTrialEnd

setTrialEnd

getDiscount

setDiscount

getNextRecurringCharge

setNextRecurringCharge

getSubscription

setSubscription

getSubscriptions

getDeleted

getDelinquent

setDelinquent

getAccountBalance

setAccountBalance

getCurrency

setCurrency

getMetadata

setMetadata

getShipping

setShipping

create

retrieve

update

delete

createCard

createCard

createBankAccount

createBankAccount

createBankAccount

createBankAccount

createSubscription

updateSubscription

cancelSubscription

cancelSubscription

deleteDiscount

create

create

retrieve

retrieve

list

list

all

all

all

update

update

delete

delete

createCard