POST
/
api
/
v1
/
server-to-server-interface
/
subscription
/
{subscription_id}
/
resume
curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/api/v1/server-to-server-interface/subscription/{subscription_id}/resume \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "status_code": 200,
  "is_live": false,
  "gateway_response": {
    "version": "1",
    "type": "INFO",
    "message": "Subscription Updated.",
    "code": "INFO3000"
  },
  "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を使用して以前に一時停止されたサブスクリプションを再開し、通常の請求とサービスを回復させます。

  • 再開後、サブスクリプションはアクティブな状態に戻り、今後の請求サイクルは元々予定されていた通りに進行します。

​
請求サイクルと状態

  • サブスクリプションはアクティブ状態に戻され、請求は中断した地点から再開されます。次の請求サイクルが到来している場合、自動的に処理されます。

  • 元のサブスクリプションで設定された割引や試用期間は、最初に設定された通りに継続されます。

​
必要なパラメータ

  • サブスクリプションID：再開するサブスクリプションの一意の識別子。

​
フローダイアグラム

​
APIパラメータ

Authorizations

​
Authorization
string
header
required

認証のためのAPIキー。形式：'Basic YOUR_API_KEY_HERE'

​
x-api-key
string
header
required

x-api-key専用のAPIキー。

Path Parameters

​
subscription_id
string
required

サブスクリプションのサブスクリプションID。例: 664dc930-88bd-4696-8807-5e0f1fedba0b。

Maximum length: 36

Response

200 - application/json
サブスクリプションが再開されたことを示す成功した応答。
​
success
boolean

操作が成功したかどうかを示します。

Example:

true

​
status_code
integer

応答のHTTPステータスコード。

Example:

200

​
is_live
boolean

取引が本番環境かテスト環境かを示します。

Example:

false

​
gateway_response
object

ゲートウェイからの応答の詳細。

​
subscription_details
object

サブスクリプションの詳細。