POST
/
api
/
v1
/
server-to-server-interface
/
subscription
/
{subscription_id}
/
pause
curl --request POST \
  --url https://api-dev.paymentoptions.com/api/v1/api/v1/server-to-server-interface/subscription/{subscription_id}/pause \
  --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": "PAUSED",
    "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

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