更新の保留

更新の保留は、サブスクリプションの更新、サブスクリプションアイテムの作成、サブスクリプションアイテムの更新の各コールで使用できます。更新を作成する際には、payment_behavior=pending_if_incomplete を設定します。以下の例では、サブスクリプションに新しい料金を追加しています。proration_behavior=always_invoice が設定されているため、更新が作成されると、請求書が作成されて支払いが試行されます。

curl https://api.stripe.com/v1/subscriptions/sub_49ty4767H20z6a \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "payment_behavior"="pending_if_incomplete" \
  -d "proration_behavior"="always_invoice" \
  -d "items[0][id]"="si_09IkI4u3ZypJUk5onGUZpe8O" \
  -d "items[0][price]"="price_CBb6IXqvTLXp3f"

支払いが成功すると、サブスクリプションが更新されます。支払いが失敗すると、返された Subscription オブジェクトには、変更とともに pending_update ハッシュが含まれます。

{
  "id": "sub_49ty4767H20z6a",
  "object": "subscription",
  "application_fee_percent": null,
  "pending_update": {
    "expires_at": 1571194285,
    "subscription_items": [
      {
        "id": "si_09IkI4u3ZypJUk5onGUZpe8O",
        "price": "price_CBb6IXqvTLXp3f"
      }
    ]
  },
}

更新を行った後、サブスクリプションの pending_update ハッシュを確認します。自動通知を受け取りたい場合は、customer.subscription.updated イベントをリッスンする Webhook を作成できます。pending_update ハッシュが入力されている場合に、支払いが失敗すると、サブスクリプションは更新リクエストが行われなかったかのように引き続き繰り返されます。

支払い方法が拒否されたため、または顧客認証が必要なために、多くの支払いが失敗します。これらのシナリオの両方を処理するロジックを構築する必要があります。

カードの拒否を処理するには、支払いの失敗の手順を使用します。新しい支払い方法を顧客に設定してから、pay (支払う) エンドポイントを使用して、更新によって生成された請求書を支払う必要があります。

顧客のアクションの手順を参照して、顧客認証を処理します。これにより、ユーザーは認証プロセスを行ってから請求書を支払います。

支払いが成功すると、下記が行われます。

• pending_update ハッシュの変更をすぐに適用する。
• 請求書を paid に更新する。

支払いが再度失敗した場合、pending_update ハッシュは元の有効期限のままサブスクリプションに残ります。変更は適用されません。