定期課金 – UPDATE
定期課金オブジェクトに対するUPDATEリクエストには以下が必要です。（括弧内は入力箇所）
- 店舗ID（URLの
{storeId}部分） - 定期課金ID（URLの
{subscriptionId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request PATCH \
--url https://api.univapay.com/stores/{storeId}/subscriptions/{subscriptionId} \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| transaction_token_id | string (UUID) | 定期課金で使用するトランザクショントークン クレジットカードの有効期限が切れ、他のカードの切り替える為などに使用 定期課金の状態が unconfirmed, unpaid, current, suspended の場合に変更可能 |
| amount | number | 定期課金の課金額 ※回数指定の定期課金では利用不可 |
| metadata | json | 定期課金に紐づいているメタデータ |
| status | string | 定期課金の状態suspended：ステータスを一時停止unpaid：一時停止の定期課金を再開 |
| schedule_settings.termination_mode | string | 定期課金の停止リクエストが送信されたときの処理 指定する値によって停止のタイミングを指定 immediate：即座に停止または終了on_next_payment：次回課金日の直前に停止または終了 |
| schedule_settings.start_on | string (ISO-8601) | 定期課金開始日 初回がカード登録のみの定期課金で、初めて課金が実行される日（初めて課金額が発生する日）を変更する為などに使用 |
| next_payment.due_date | string (ISO-8601) | 定期課金の次回課金日 ※次回課金日の編集を許可している加盟店さまのみ利用可 |
| next_payment.amount | number | 定期課金の次回課金額 ※回数指定の定期課金では利用不可 ※次回課金額の編集を許可している加盟店さまのみ利用可 |
Bodyの記述例
curl --request PATCH \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/subscriptions/11ef335e-9aa5-c54a-8313-7f9847da313a \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \
--data '{
"metadata":{
"ServiceId": 7843568
},
"transaction_token_id": "11ef3362-3700-c54a-9baa-6f7e6527c9d9",
"schedule_settings": {
"termination_mode": "on_next_payment"
},
"next_payment": {
"due_date": "2030-01-01"
}
}'レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"id": "11ef335e-9aa5-c54a-8313-7f9847da313a",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"transaction_token_id": "11ef3362-3700-c54a-9baa-6f7e6527c9d9",
"amount": 1250,
"currency": "USD",
"amount_formatted": 12.50,
"initial_amount": null,
"initial_amount_formatted": null,
"subsequent_cycles_start": null,
"schedule_settings": {
"start_on": null,
"zone_id": "Asia/Tokyo",
"preserve_end_of_month": null,
"retry_interval": null,
"termination_mode": "on_next_payment"
},
"only_direct_currency": false,
"first_charge_capture_after": null,
"first_charge_authorization_only": false,
"status": "current",
"metadata": {
"ServiceId": 7843568
},
"mode": "test",
"created_on": "2024-06-26T01:51:28.627023Z",
"period": "monthly",
"next_payment": {
"id": "11ef335e-9ae2-8322-8e79-e7ba4b56234e",
"due_date": "2030-01-01",
"zone_id": "Asia/Tokyo",
"amount": 1250,
"currency": "USD",
"amount_formatted": 12.50,
"is_paid": false,
"is_last_payment": false,
"created_on": "2024-06-26T01:51:29.025129Z",
"updated_on": "2024-06-26T01:51:29.025129Z",
"retry_date": null
}
}