定期課金 – GET
定期課金オブジェクトに対するGETリクエストには以下が必要です。（括弧内は入力箇所）
- 店舗ID（URLの
{storeId}部分） - 定期課金ID（URLの
{subscriptionId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/subscriptions/{subscriptionId} \
--header 'Authorization: Bearer {secret}.{jwt}'利用できるパラメータ
リクエストURLに追加できるクエリパラメータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| polling | boolean | ステータスが pending（初期ステータス）から別のステータスに変更されるまで課金のステータスを内部でポーリングする |
記述例
curl --request GET \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/subscriptions/11ef335e-9aa5-c54a-8313-7f9847da313a \
--header 'Authorization: Bearer {secret}.{jwt}'レスポンス
下記は記述例でリクエストした場合の例です。
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": "11ef32a7-3a71-8662-803f-1bc27702eeec",
"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": "immediate"
},
"only_direct_currency": false,
"first_charge_capture_after": null,
"first_charge_authorization_only": false,
"status": "current",
"metadata": {
"ServiceId": 78435694
},
"mode": "test",
"created_on": "2024-06-26T01:51:28.627023Z",
"period": "monthly",
"next_payment": {
"id": "11ef335e-9ae2-8322-8e79-e7ba4b56234e",
"due_date": "2024-07-26",
"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
}
}