Customer (ChargeBee Java 2.8.3 API)

java.lang.Object
- com.chargebee.internal.Resource<Customer>
- - com.chargebee.models.Customer

public class Customer
extends Resource<Customer>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Customer.AddContactRequest`
`static class`	`Customer.AddPromotionalCreditsRequest`
`static class`	`Customer.AssignPaymentRoleRequest`
`static class`	`Customer.Balance`
`static class`	`Customer.BillingAddress`
`static class`	`Customer.BillingDayOfWeek`
`static class`	`Customer.CardStatus` Deprecated.
`static class`	`Customer.ChangeBillingDateRequest`
`static class`	`Customer.ChildAccountAccess`
`static class`	`Customer.CollectPaymentRequest`
`static class`	`Customer.Contact`
`static class`	`Customer.CreateRequest`
`static class`	`Customer.CustomerListRequest`
`static class`	`Customer.DeductPromotionalCreditsRequest`
`static class`	`Customer.DeleteContactRequest`
`static class`	`Customer.DeleteRequest`
`static class`	`Customer.FraudFlag`
`static class`	`Customer.HierarchyRequest`
`static class`	`Customer.MergeRequest`
`static class`	`Customer.MoveRequest`
`static class`	`Customer.ParentAccountAccess`
`static class`	`Customer.PaymentMethod`
`static class`	`Customer.PiiCleared`
`static class`	`Customer.RecordExcessPaymentRequest`
`static class`	`Customer.ReferralUrl`
`static class`	`Customer.Relationship`
`static class`	`Customer.RelationshipsRequest`
`static class`	`Customer.SetPromotionalCreditsRequest`
`static class`	`Customer.UpdateBillingInfoRequest`
`static class`	`Customer.UpdateContactRequest`
`static class`	`Customer.UpdateHierarchySettingsRequest`
`static class`	`Customer.UpdatePaymentMethodRequest`
`static class`	`Customer.UpdateRequest`
`static class`	`Customer.VatNumberStatus`

Field Summary
- Fields inherited from class com.chargebee.internal.Resource
  jsonObj

Constructor Summary

Constructors
Constructor and Description

Customer(org.json.JSONObject jsonObj)

Customer(String jsonStr)

Constructors
Constructor and Description
`Customer(org.json.JSONObject jsonObj)`
`Customer(String jsonStr)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Customer.AddContactRequest`	`addContact(String id)`
`static Customer.AddPromotionalCreditsRequest`	`addPromotionalCredits(String id)` Deprecated.
`Boolean`	`allowDirectDebit()`
`static Customer.AssignPaymentRoleRequest`	`assignPaymentRole(String id)`
`AutoCollection`	`autoCollection()`
`String`	`backupPaymentSourceId()`
`List<Customer.Balance>`	`balances()`
`Customer.BillingAddress`	`billingAddress()`
`Integer`	`billingDate()`
`BillingDateMode`	`billingDateMode()`
`Customer.BillingDayOfWeek`	`billingDayOfWeek()`
`BillingDayOfWeekMode`	`billingDayOfWeekMode()`
`Boolean`	`businessCustomerWithoutVatNumber()`
`Customer.CardStatus`	`cardStatus()` Deprecated.
`static Customer.ChangeBillingDateRequest`	`changeBillingDate(String id)`
`Customer.ChildAccountAccess`	`childAccountAccess()`
`static Request`	`clearPersonalData(String id)`
`String`	`clientProfileId()`
`static Customer.CollectPaymentRequest`	`collectPayment(String id)`
`String`	`company()`
`Boolean`	`consolidatedInvoicing()`
`List<Customer.Contact>`	`contacts()`
`static ListRequest`	`contactsForCustomer(String id)`
`static Customer.CreateRequest`	`create()`
`Timestamp`	`createdAt()`
`String`	`createdFromIp()`
`CustomerType`	`customerType()`
`static Customer.DeductPromotionalCreditsRequest`	`deductPromotionalCredits(String id)` Deprecated.
`static Customer.DeleteRequest`	`delete(String id)`
`static Customer.DeleteContactRequest`	`deleteContact(String id)`
`Boolean`	`deleted()`
`static Request`	`deleteRelationship(String id)`
`String`	`email()`
`EntityCode`	`entityCode()`
`Integer`	`excessPayments()`
`org.json.JSONArray`	`exemptionDetails()`
`String`	`exemptNumber()`
`String`	`firstName()`
`Customer.FraudFlag`	`fraudFlag()`
`static Customer.HierarchyRequest`	`hierarchy(String id)`
`String`	`id()`
`String`	`invoiceNotes()`
`Boolean`	`isLocationValid()`
`String`	`lastName()`
`static Customer.CustomerListRequest`	`list()`
`String`	`locale()`
`static Customer.MergeRequest`	`merge()`
`org.json.JSONObject`	`metaData()`
`static Customer.MoveRequest`	`move()`
`Integer`	`netTermDays()`
`OfflinePaymentMethod`	`offlinePaymentMethod()`
`Customer.ParentAccountAccess`	`parentAccountAccess()`
`Customer.PaymentMethod`	`paymentMethod()`
`String`	`phone()`
`Customer.PiiCleared`	`piiCleared()`
`String`	`preferredCurrencyCode()`
`String`	`primaryPaymentSourceId()`
`Integer`	`promotionalCredits()`
`static Customer.RecordExcessPaymentRequest`	`recordExcessPayment(String id)`
`List<Customer.ReferralUrl>`	`referralUrls()`
`Integer`	`refundableCredits()`
`Boolean`	`registeredForGst()`
`Customer.Relationship`	`relationship()`
`static Customer.RelationshipsRequest`	`relationships(String id)`
`Long`	`resourceVersion()`
`static Request`	`retrieve(String id)`
`static Customer.SetPromotionalCreditsRequest`	`setPromotionalCredits(String id)` Deprecated.
`Taxability`	`taxability()`
`Integer`	`unbilledCharges()`
`static Customer.UpdateRequest`	`update(String id)`
`static Customer.UpdateBillingInfoRequest`	`updateBillingInfo(String id)`
`static Customer.UpdateContactRequest`	`updateContact(String id)`
`Timestamp`	`updatedAt()`
`static Customer.UpdateHierarchySettingsRequest`	`updateHierarchySettings(String id)`
`static Customer.UpdatePaymentMethodRequest`	`updatePaymentMethod(String id)`
`Boolean`	`useDefaultHierarchySettings()`
`String`	`vatNumber()`
`Customer.VatNumberStatus`	`vatNumberStatus()`
`Timestamp`	`vatNumberValidatedTime()`

Methods inherited from class com.chargebee.internal.Resource
apiVersionCheck, nullCheck, optBigDecimal, optBoolean, optDouble, optEnum, optInteger, optJSONArray, optJSONObject, optList, optLong, optString, optSubResource, optTimestamp, reqBigDecimal, reqBoolean, reqDouble, reqEnum, reqInteger, reqJSONArray, reqJSONObject, reqList, reqLong, reqString, reqSubResource, reqTimestamp, toJson, toString, uri

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

Constructor Detail

Customer
```
public Customer(String jsonStr)
```

Customer

public Customer(org.json.JSONObject jsonObj)

Method Detail

id
```
public String id()
```

firstName
```
public String firstName()
```

lastName
```
public String lastName()
```

email
```
public String email()
```

phone
```
public String phone()
```

company
```
public String company()
```

vatNumber
```
public String vatNumber()
```

autoCollection

public AutoCollection autoCollection()

offlinePaymentMethod

public OfflinePaymentMethod offlinePaymentMethod()

netTermDays
```
public Integer netTermDays()
```

vatNumberValidatedTime

public Timestamp vatNumberValidatedTime()

vatNumberStatus

public Customer.VatNumberStatus vatNumberStatus()

allowDirectDebit
```
public Boolean allowDirectDebit()
```

isLocationValid
```
public Boolean isLocationValid()
```

createdAt
```
public Timestamp createdAt()
```

createdFromIp
```
public String createdFromIp()
```

exemptionDetails

public org.json.JSONArray exemptionDetails()

taxability
```
public Taxability taxability()
```

entityCode
```
public EntityCode entityCode()
```

exemptNumber
```
public String exemptNumber()
```

resourceVersion
```
public Long resourceVersion()
```

updatedAt
```
public Timestamp updatedAt()
```

locale
```
public String locale()
```

billingDate
```
public Integer billingDate()
```

billingDateMode

public BillingDateMode billingDateMode()

billingDayOfWeek

public Customer.BillingDayOfWeek billingDayOfWeek()

billingDayOfWeekMode

public BillingDayOfWeekMode billingDayOfWeekMode()

piiCleared

public Customer.PiiCleared piiCleared()

cardStatus

@Deprecated
public Customer.CardStatus cardStatus()

Deprecated.

fraudFlag
```
public Customer.FraudFlag fraudFlag()
```

primaryPaymentSourceId

public String primaryPaymentSourceId()

backupPaymentSourceId
```
public String backupPaymentSourceId()
```

billingAddress

public Customer.BillingAddress billingAddress()

referralUrls

public List<Customer.ReferralUrl> referralUrls()

contacts

public List<Customer.Contact> contacts()

paymentMethod

public Customer.PaymentMethod paymentMethod()

invoiceNotes
```
public String invoiceNotes()
```

preferredCurrencyCode
```
public String preferredCurrencyCode()
```

promotionalCredits
```
public Integer promotionalCredits()
```

unbilledCharges
```
public Integer unbilledCharges()
```

refundableCredits
```
public Integer refundableCredits()
```

excessPayments
```
public Integer excessPayments()
```

balances

public List<Customer.Balance> balances()

metaData
```
public org.json.JSONObject metaData()
```

deleted
```
public Boolean deleted()
```

registeredForGst
```
public Boolean registeredForGst()
```

consolidatedInvoicing

public Boolean consolidatedInvoicing()

customerType
```
public CustomerType customerType()
```

businessCustomerWithoutVatNumber

public Boolean businessCustomerWithoutVatNumber()

clientProfileId
```
public String clientProfileId()
```

relationship

public Customer.Relationship relationship()

useDefaultHierarchySettings

public Boolean useDefaultHierarchySettings()

parentAccountAccess

public Customer.ParentAccountAccess parentAccountAccess()

childAccountAccess

public Customer.ChildAccountAccess childAccountAccess()

create

public static Customer.CreateRequest create()

list

public static Customer.CustomerListRequest list()

retrieve

public static Request retrieve(String id)

update

public static Customer.UpdateRequest update(String id)

updatePaymentMethod

public static Customer.UpdatePaymentMethodRequest updatePaymentMethod(String id)

updateBillingInfo

public static Customer.UpdateBillingInfoRequest updateBillingInfo(String id)

contactsForCustomer

public static ListRequest contactsForCustomer(String id)

assignPaymentRole

public static Customer.AssignPaymentRoleRequest assignPaymentRole(String id)

addContact

public static Customer.AddContactRequest addContact(String id)

updateContact

public static Customer.UpdateContactRequest updateContact(String id)

deleteContact

public static Customer.DeleteContactRequest deleteContact(String id)

addPromotionalCredits

@Deprecated
public static Customer.AddPromotionalCreditsRequest addPromotionalCredits(String id)

Deprecated.

deductPromotionalCredits

@Deprecated
public static Customer.DeductPromotionalCreditsRequest deductPromotionalCredits(String id)

Deprecated.

setPromotionalCredits

@Deprecated
public static Customer.SetPromotionalCreditsRequest setPromotionalCredits(String id)

Deprecated.

recordExcessPayment

public static Customer.RecordExcessPaymentRequest recordExcessPayment(String id)

collectPayment

public static Customer.CollectPaymentRequest collectPayment(String id)

delete

public static Customer.DeleteRequest delete(String id)

move

public static Customer.MoveRequest move()

changeBillingDate

public static Customer.ChangeBillingDateRequest changeBillingDate(String id)

merge

public static Customer.MergeRequest merge()

clearPersonalData

public static Request clearPersonalData(String id)

relationships

public static Customer.RelationshipsRequest relationships(String id)

deleteRelationship

public static Request deleteRelationship(String id)

hierarchy

public static Customer.HierarchyRequest hierarchy(String id)

updateHierarchySettings

public static Customer.UpdateHierarchySettingsRequest updateHierarchySettings(String id)

Class Customer

Nested Class Summary

Field Summary

Fields inherited from class com.chargebee.internal.Resource

Constructor Summary

Method Summary

Methods inherited from class com.chargebee.internal.Resource

Methods inherited from class java.lang.Object

Constructor Detail

Customer

Customer

Method Detail

id

firstName

lastName

email

phone

company

vatNumber

autoCollection

offlinePaymentMethod

netTermDays

vatNumberValidatedTime

vatNumberStatus

allowDirectDebit

isLocationValid

createdAt

createdFromIp

exemptionDetails

taxability

entityCode

exemptNumber

resourceVersion

updatedAt

locale

billingDate

billingDateMode

billingDayOfWeek

billingDayOfWeekMode

piiCleared

cardStatus

fraudFlag

primaryPaymentSourceId

backupPaymentSourceId

billingAddress

referralUrls

contacts

paymentMethod

invoiceNotes

preferredCurrencyCode

promotionalCredits

unbilledCharges

refundableCredits

excessPayments

balances

metaData

deleted

registeredForGst

consolidatedInvoicing

customerType

businessCustomerWithoutVatNumber

clientProfileId

relationship

useDefaultHierarchySettings

parentAccountAccess

childAccountAccess

create

list

retrieve

update

updatePaymentMethod

updateBillingInfo

contactsForCustomer

assignPaymentRole

addContact

updateContact

deleteContact

addPromotionalCredits

deductPromotionalCredits

setPromotionalCredits