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

サブスクリプションがキャンセルされたことを示す成功レスポンス。

The response is of type object.