年次の定期課金、はじめました

機能紹介 お知らせ

こんにちは、Takumaです。

今までは月に一度課金を実行する月次プランの定期課金のみがサポート対象でしたが、年に一度課金を実行できる年次プランのサポートを本日開始しました。

年次プランとその定期課金の作成

年次プランを作成するには、期間(interval) にyearを指定します。以下が年次プラン作成リクエストのサンプルです。

リクエスト：

curl https://api.pay.jp/v1/plans \
-u sk_test_c62fade9d045b54cd76d7036: \
-d amount=775 \
-d currency=jpy \
-d interval=year \
-XPOST

以下のようなレスポンスが返れば、年次プランの作成は成功です。

レスポンス：

{
  "amount": 775,
  "billing_day": null,
  "created": 1484278427,
  "currency": "jpy",
  "id": "pln_72eb1066416083d0a70d67531751",
  "interval": "year",
  "livemode": false,
  "metadata": {},
  "name": null,
  "object": "plan",
  "trial_days": 0
}

上のプランidを定期課金作成APIで指定すれば、年次の定期課金を作成することができます。以下がサンプルリクエストです。

リクエスト:

curl https://api.pay.jp/v1/subscriptions \
-u sk_test_c62fade9d045b54cd76d7036: \
-d plan=pln_72eb1066416083d0a70d67531751 \
-d customer=cus_5de245838f5c36462b328534b9b4 \
-XPOST

年次定期課金の作成に成功すると以下のようなレスポンスが返ります。

レスポンス:

{
  "canceled_at": null,
  "created": 1484279234,
  "current_period_end": 1515815234,
  "current_period_start": 1484279234,
  "customer": "cus_5de245838f5c36462b328534b9b4",
  "id": "sub_a95d445900798b36b10c72d6b8d6",
  "livemode": false,
  "metadata": {},
  "object": "subscription",
  "paused_at": null,
  "plan": {
    "amount": 775,
    "billing_day": null,
    "created": 1484278427,
    "currency": "jpy",
    "id": "pln_72eb1066416083d0a70d67531751",
    "interval": "year",
    "livemode": false,
    "metadata": {},
    "name": null,
    "object": "plan",
    "trial_days": 0
  },
  "prorate": false,
  "resumed_at": null,
  "start": 1484279234,
  "status": "active",
  "trial_end": null,
  "trial_start": null
}

この時点で、初回分の課金は実行済みです。次回の課金実行日時(current_period_end)は作成日時からちょうど１年後です(上の例だと2018年1月13日 3:47am UTC)。

年次プランについて

年次プランは期間(interval)がyearのプランです。このプランを購読してる定期課金は更新周期が一年になります。

トライアル日数(trial_days)を設定することは可能ですが、課金日(billing_day)を設定することはできません。

プラン変更について

定期課金のプラン変更は、変更前と変更後のプランの期間(interval)が異なる場合でも可能です。

プラン変更時に、課金周期が更新されるのは、以下のいずれかが当てはまるケースです。

  • 日割り課金設定が無効
  • 更新前と更新後のプラン期間が異なる
  • 更新前と更新後のプラン課金日が異なる
  • 変更時にトライアル(trial_end)が付与される

トライアルが付与された場合を除き、プラン変更時には課金が実行されます。 課金金額の計算式等に関して、詳しくはこちらの記事を参照ください。

月次と年次プランを組み合わせて利用することにより、PAY.JPをご利用しているサービスの有料オプションに幅を持たせる事ができます。ぜひご利用ください。