定期課金: Update

このリクエストでは、アプリトークン・シークレット・店舗ID・定期課金IDを指定することで、作成された既存の定期課金についての情報を更新することができます。
作成済の定期課金に任意のメタデータを更新、または定期課金で利用しているカード情報を更新したい場合に利用できます。

Request

PATCH https://api.univapay.com/stores/{storeId}/subscriptions/{subscriptionId}

Parameters:

Parameters
transaction_token_idstring (UUID)
定期課金で使用するトランザクショントークンを指定します。例えば、クレジットカードの有効期限が切れた場合などに他のカードの切り替える為などに使用します。定期課金の状態が unconfirmed, unpaid, current, suspended の場合に変更できます。
amountnumber
定期課金の課金額を変更します。
metadatajson
定期課金に紐づいているメタデータ。
statusstring
定期課金の状態を変更します。
suspended:ステータスを一時停止に変更します。
unpaid:一時停止の定期課金を再開します。
schedule_settingsjson
定期課金の停止リクエストが送信されたときの処理を変更します。
termination_modeの値によって停止のタイミングを指定できます。
immediate:定期課金は即座に停止または終了します。
on_next_payment:次回課金日の直前に停止または終了します。

例：{"termination_mode": "on_next_payment"}

Headers:

Content-Type: application/json
Authorization: Bearer {secret}.{jwt}

Body:

curl --request PATCH \
--url https://api.univapay.com/stores/37ff5664-18c6-11e7-8221-ff4914d76afc/subscriptions/66598d16-18e6-11e7-9651-7fa7e8a309b1 \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \
--data '{
  "metadata":{
      "ServiceId": 7843568
  },
  "transaction_token_id": "81c6fd76-18ec-11e7-85f3-1bd5cafc6101",
  "schedule_settings": {"termination_mode": "on_next_payment"}
}'

Response

Code: 200

Headers:

Content-Type: application/json

Body:

{
  "id": "66598d16-18e6-11e7-9651-7fa7e8a309b1",
  "merchant_id": "371f512c-18c6-11e7-b12b-53d631f886c5",
  "store_id": "37ff5664-18c6-11e7-8221-ff4914d76afc",
  "amount": 3350,
  "currency": "USD",
  "amount_formatted": 33.5,
  "period": "daily",
  "status": "unverified",
  "metadata": {
    "ServiceId": 7843568
  },
  "mode": "test",
  "created_on": "2020-11-30T06:25:00.07367Z"
}