BCSubscription (java-sdk 3.4.10 API)

java.lang.Object
- cn.beecloud.bean.BCObject
- - cn.beecloud.bean.BCSubscription

```
public class BCSubscription
extends BCObject
```
订阅类，封装了BeeCloud订阅信息

Since:

2016.7.26

Author:

Rui.Feng

Constructor Summary

Constructors
Constructor and Description

BCSubscription()

Constructors
Constructor and Description
`BCSubscription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccountType()` 访问字段 `accountType`
`Double`	`getAmount()` 访问字段 `amount`
`String`	`getBankName()` 访问字段 `bankName`
`String`	`getBuyerId()` 访问字段 `buyerId`
`Boolean`	`getCancelAtPeriodEnd()` 访问字段 `cancelAtPeriodEnd`
`String`	`getCardId()` 访问字段 `cardId`
`String`	`getCardNo()` 访问字段 `cardNo`
`String`	`getCouponId()` 访问字段, 只在查询时返回 `couponId`
`String`	`getIdName()` 访问字段 `idName`
`String`	`getIdNo()` 访问字段 `idNo`
`String`	`getLast4()` 访问字段 `last4`
`String`	`getMobile()` 访问字段 `mobile`
`Map<String,Object>`	`getOptional()` 访问字段 `optional`
`String`	`getOptionalString()` 访问字段 `getOptionalString()`
`String`	`getPlanId()` 访问字段 `planId`
`String`	`getSmsCode()` 访问字段 `smsCode`
`String`	`getSmsId()` 访问字段 `smsId`
`String`	`getStatus()` 访问字段 `status`
`Date`	`getTrialEnd()` 访问字段 `trialEnd`
`Boolean`	`getValid()` 访问字段 `valid`
`void`	`setAccountType(String accountType)` 设置字段 `accountType`
`void`	`setAmount(Double amount)`
`void`	`setBankName(String bankName)`
`void`	`setBuyerId(String buyerId)`
`void`	`setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd)`
`void`	`setCardId(String cardId)`
`void`	`setCardNo(String cardNo)`
`void`	`setCouponId(String couponId)` 设置字段 `couponId`
`void`	`setIdName(String idName)`
`void`	`setIdNo(String idNo)`
`void`	`setLast4(String last4)` 设置字段 `last4`
`void`	`setMobile(String mobile)`
`void`	`setOptional(Map<String,Object> optional)`
`void`	`setOptionalString(String optionalString)` 设置字段 `optionalString`
`void`	`setPlanId(String planId)`
`void`	`setSmsCode(String smsCode)`
`void`	`setSmsId(String smsId)`
`void`	`setStatus(String status)` 设置字段 `status`
`void`	`setTrialEnd(Date trialEnd)`
`void`	`setValid(Boolean valid)` 设置字段 `valid`

Methods inherited from class cn.beecloud.bean.BCObject
getCreateDate, getObjectId, getType, getUpdateDate, setCreateDate, setObjectId, setType, setUpdateDate

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

- Constructor Detail
  - BCSubscription
```
public BCSubscription()
```
- Method Detail
  - getBuyerId
```
public String getBuyerId()
```
    访问字段 buyerId
  - setBuyerId
```
public void setBuyerId(String buyerId)
```
    Parameters:
    
    buyerId - 订阅的buyer ID，可以是用户email，也可以是商户系统中的用户ID (必填)
  - getPlanId
```
public String getPlanId()
```
    访问字段 planId
  - setPlanId
```
public void setPlanId(String planId)
```
    Parameters:
    
    planId - 对应的计划id (必填)
  - getCardId
```
public String getCardId()
```
    访问字段 cardId
  - setCardId
```
public void setCardId(String cardId)
```
    Parameters:
    
    cardId - 第一次订阅成功的情况下，webhook会返回，之后订阅可以直接使用cardId代替以下5个参数，即（{bank_name、card_no、id_name、id_no、mobile}和{cardId} 二选一）（选填）
  - getBankName
```
public String getBankName()
```
    访问字段 bankName
  - setBankName
```
public void setBankName(String bankName)
```
    Parameters:
    
    bankName - 订阅用户银行名称（支持列表可参考API获取支持银行列表) (选填)
  - getCardNo
```
public String getCardNo()
```
    访问字段 cardNo
  - setCardNo
```
public void setCardNo(String cardNo)
```
    Parameters:
    
    cardNo - 订阅用户银行卡号，（选填）
  - getIdName
```
public String getIdName()
```
    访问字段 idName
  - setIdName
```
public void setIdName(String idName)
```
    Parameters:
    
    idName - 订阅用户身份证姓名，（选填）
  - getIdNo
```
public String getIdNo()
```
    访问字段 idNo
  - setIdNo
```
public void setIdNo(String idNo)
```
    Parameters:
    
    idNo - 订阅用户身份证号，选填）
  - getMobile
```
public String getMobile()
```
    访问字段 mobile
  - setMobile
```
public void setMobile(String mobile)
```
    Parameters:
    
    mobile - 订阅用户银行预留手机号，选填）
  - getAmount
```
public Double getAmount()
```
    访问字段 amount
  - setAmount
```
public void setAmount(Double amount)
```
    Parameters:
    
    amount - 对于类似收取电费的场景，计划的收费金额fee应当是电费的单价，用户每月使用的度数在订阅中的amount设置，在每次扣款时间点之前，商户的系统需要更新每个注册用户对应订阅的amount数值，默认1（选填）
  - getCouponId
```
public String getCouponId()
```
    访问字段, 只在查询时返回 couponId
  - setCouponId
```
public void setCouponId(String couponId)
```
    设置字段 couponId
  - getOptional
```
public Map<String,Object> getOptional()
```
    访问字段 optional
  - setOptional
```
public void setOptional(Map<String,Object> optional)
```
    Parameters:
    
    optional - 补充说明，（选填）
  - getSmsId
```
public String getSmsId()
```
    访问字段 smsId
  - setSmsId
```
public void setSmsId(String smsId)
```
    Parameters:
    
    smsId - 短信验证码id，通过短信验证接口获得（必填）
  - setTrialEnd
```
public void setTrialEnd(Date trialEnd)
```
    Parameters:
    
    trialEnd - 试用截止时间点，默认值为null，如果设置了，当前订阅直接从trialEnd的下一天进行第一次扣费，之后按照计划中设定的时间间隔，周期性扣费。该参量可以用来统一订阅用户的收费时间，（选填）
  - getTrialEnd
```
public Date getTrialEnd()
```
    访问字段 trialEnd
  - getSmsCode
```
public String getSmsCode()
```
    访问字段 smsCode
  - setSmsCode
```
public void setSmsCode(String smsCode)
```
    Parameters:
    
    smsCode - 短信验证码，（必填）
  - getCancelAtPeriodEnd
```
public Boolean getCancelAtPeriodEnd()
```
    访问字段 cancelAtPeriodEnd
  - setCancelAtPeriodEnd
```
public void setCancelAtPeriodEnd(Boolean cancelAtPeriodEnd)
```
    Parameters:
    
    cancelAtPeriodEnd - 是否在到期扣款后再取消订阅，默认为false, 即立即使该订阅失效, 如为true, 则在期数结束扣款后使该订阅失效,（选填）
  - getValid
```
public Boolean getValid()
```
    访问字段 valid
  - setValid
```
public void setValid(Boolean valid)
```
    设置字段 valid
  - getStatus
```
public String getStatus()
```
    访问字段 status
  - setStatus
```
public void setStatus(String status)
```
    设置字段 status
  - getAccountType
```
public String getAccountType()
```
    访问字段 accountType
  - setAccountType
```
public void setAccountType(String accountType)
```
    设置字段 accountType
  - getLast4
```
public String getLast4()
```
    访问字段 last4
  - setLast4
```
public void setLast4(String last4)
```
    设置字段 last4
  - getOptionalString
```
public String getOptionalString()
```
    访问字段 getOptionalString()
  - setOptionalString
```
public void setOptionalString(String optionalString)
```
    设置字段 optionalString

Class BCSubscription

Constructor Summary

Method Summary

Methods inherited from class cn.beecloud.bean.BCObject

Methods inherited from class java.lang.Object

Constructor Detail

BCSubscription

Method Detail

getBuyerId

setBuyerId

getPlanId

setPlanId

getCardId

setCardId

getBankName

setBankName

getCardNo

setCardNo

getIdName

setIdName

getIdNo

setIdNo

getMobile

setMobile

getAmount

setAmount

getCouponId

setCouponId

getOptional

setOptional

getSmsId

setSmsId

setTrialEnd

getTrialEnd

getSmsCode

setSmsCode

getCancelAtPeriodEnd

setCancelAtPeriodEnd

getValid

setValid

getStatus

setStatus

getAccountType

setAccountType

getLast4

setLast4

getOptionalString

setOptionalString