日本語
cURL
curl --request GET \ --url https://api-dev.paymentoptions.com/api/v1/server-to-server-interface/subscription/{subscription_id} \ --header 'Authorization: <api-key>' \ --header 'x-api-key: <api-key>'
{ "success": true, "status_code": 200, "is_live": false, "subscription_details": { "id": "664dc930-88bd-4696-8807-5e0f1fedba0b", "type": "CYCLE", "max_cycle_count": 10, "status": "ACTIVE", "completed_payment_cycle": 1, "last_payment_status": "SUCCESSFUL", "next_payment_date": "2024-11-28T01:31:29.154Z", "next_payment_cycle": 2, "subscription_plan_details": { "name": "Three weeks plan", "desc": "Billed every two days", "billing_cycle_type": "DAYS", "billing_cycle_interval": 2, "amount": 1000, "ccy": "JPY", "trial_period_duration": "", "trial_period_duration_type": "NONE", "plan_discount_percentage": 10, "plan_discount_duration": 2 }, "subscription_transaction_details": [ { "id": "359f39bd-673a-47b3-b9ec-cbd6cd313b8e", "ref": 74860, "cycle": 1, "status": "SUCCESSFUL", "transaction_date": "2024-11-26T01:31:29.000Z", "amount": 900, "ccy": "JPY", "event": "CAPTURED" } ] } }
サブスクリプション詳細APIは、特定のサブスクリプションに関する詳細情報を取得するために使用され、その現在の状態、請求履歴、今後の支払いなどを含みます。
認証のためのAPIキー。形式:'Basic YOUR_API_KEY_HERE'
x-api-key専用のAPIキー。
サブスクリプションのサブスクリプションID。例: 664dc930-88bd-4696-8807-5e0f1fedba0b。 サブスクリプションの一意のサブスクリプションID。
36
サブスクリプションの詳細を含む成功した応答。
取引が成功したかどうかを示します。
true
応答のHTTPステータスコード。
200
取引が本番環境かテスト環境かを示します。
false
サブスクリプションの詳細。
表示 子属性
サブスクリプションID。
"664dc930-88bd-4696-8807-5e0f1fedba0b"
サブスクリプションの種類(例:CYCLE または Unlimited)。
"CYCLE"
最大請求サイクル数。
10
サブスクリプションのステータス。
"ACTIVE"
完了した支払いサイクルの数。
1
このサブスクリプションで行われた最新の支払いのステータス。
"SUCCESSFUL"
サブスクリプションの次回支払い日。
"2024-11-28T01:31:29.154Z"
次回の支払いサイクル番号。
2
サブスクリプションプランの詳細。
サブスクリプションプランの名前。
"Three weeks plan"
サブスクリプションプランの説明。
"Billed every two days"
請求サイクルの種類(例:DAYS または MONTHS)。
"DAYS"
請求サイクルの間隔。
サブスクリプションプランの支払い金額。
1000
サブスクリプション取引の通貨。
"JPY"
トライアル期間の長さ(該当する場合)。
""
トライアル期間の種類(例:DAYS または MONTHS)。
"NONE"
サブスクリプションプランの割引率。
割引が適用される請求サイクルの期間。
サブスクリプションの取引詳細の一覧。
このサブスクリプション取引の取引ID。
"359f39bd-673a-47b3-b9ec-cbd6cd313b8e"
サブスクリプション取引の参照番号。
74860
取引の支払いサイクル番号。
サブスクリプション取引のステータス。
サブスクリプション取引の日付。
"2024-11-26T01:31:29.000Z"
取引の決済金額。
900
取引の通貨。
取引のイベントタイプ(例:CAPTURED)。
"CAPTURED"