継続課金

継続課金で利用するオブジェクトにplanオブジェクトとsubscriptionオブジェクトがあります。

subscriptionオブジェクト
項目属性
id: string
プランへの申込みを一意に識別するためのID。subs_の接頭字からはじまります。
object: string(初期値 "subscription")
display_id: string
ユーザーを一意に識別するためのIDとなります。このIDが同じ場合、同一ユーザーであることを意味します。
status: string
inactive(申込確認待ち) - ユーザーからプランへの申込みがあり、確認待ちの状態。
active(有効) - 申込みが確定され、継続課金が有効な状態。
suspended(停止) - 継続課金の失敗により継続課金が停止になった状態。
cancelled(解約済) - 解約済みの状態
cancelled_date: unix timestamp
statusがcancelled(解約済)になった日時。
suspended_date: unix timestamp
statusがsuspended(停止)になった日時。カードが無効化されるなどして継続課金が失敗した際にsuspendedとなります。Dashboardより解約処理を実施の上、ユーザーに再申し込みを行ってもらってください。
activation_date: unix timestamp
申込確定日。継続課金の基準日となります。締めタイミングが申込日締めで確定日が15日の場合、毎月15日に課金処理がされます。
created: unix timestamp
ユーザーからプランへの申込みがあった日時
created: unix timestamp
ユーザーからプランへの申込みがあった日時
plan: hash(planオブジェクト)
ユーザーが申し込んだプラン情報を格納したhashになります。詳細は下記参照
planオブジェクト
項目属性
id: string
object: string(初期値 "plan")
name: string
プラン名
amount: number
プランの金額
interval: string
fixed - 月末締め。プランへの申込日にかかわらず、毎月1日に課金がされます。
month - 申込日締め。継続課金が有効にされた日に課金がされます。
interval_count: number
課金間隔(月単位)。指定月間隔にて課金がされます。2の場合2ヵ月毎に課金されます。
trial_count: number
無料期間。1の場合1カ月間無料。
livemode: boolean
trueの場合本番環境。falseの場合テスト環境用のプランになります。
サンプルオブジェクト
{
  "plan": {
    "amount": 1000,
    "trial_count": 0,
    "interval_count": 2,
    "interval": "fixed",
    "name": "テストプラン",
    "livemode": false,
    "object": "plan",
    "id": "plan_voDzVcnIyEo4TfqOy7PNGl1V"
  },
  "id": "subs_FMvoWYnanQKiH6fRw9NIYVHg",
  "object": "subscription",
  "display_id": "X73CETTGJVW45WYZW2VQIJ37BI",
  "status": "active",
  "suspended_date": null,
  "activation_date": 1407724208,
  "created": 1407724208
}