サブスクリプションキャンセルAPI

サブスクリプションをキャンセル

curl --request POST \
  --url https://api-dev.paymentoptions.com/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"
      }
    ]
  }
}

POST

api

server-to-server-interface

subscription

{subscription_id}

cancel

サブスクリプションをキャンセル

curl --request POST \
  --url https://api-dev.paymentoptions.com/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。サブスクリプションの一意のサブスクリプション ID。

Maximum string length: 36

Response

200 - application/json

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

success

boolean

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

Example:

true

status_code

integer

レスポンスの HTTP ステータスコード。

Example:

200

is_live

boolean

取引がライブ取引かテスト取引かを示します。

Example:

false

gateway_response

object

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

表示子属性

gateway_response.version

string

ゲートウェイのバージョン。

Example:

"1"

gateway_response.type

string

応答の種類（例：INFO は情報提供の応答）。

Example:

"INFO"

gateway_response.message

string

ゲートウェイからのメッセージ応答。

Example:

"Subscription Updated."

gateway_response.code

string

ゲートウェイの応答コード。

Example:

"INFO3000"

subscription_details

object

キャンセルされたサブスクリプションの詳細。

表示子属性

subscription_details.id

string

サブスクリプション ID。

Example:

"664dc930-88bd-4696-8807-5e0f1fedba0b"

subscription_details.type

string

サブスクリプションの種類（例：CYCLE または Unlimited）。

Example:

"CYCLE"

subscription_details.max_cycle_count

integer

最大請求サイクル数。

Example:

10

subscription_details.status

string

サブスクリプションの更新されたステータス。

Example:

"CANCELLED"

subscription_details.completed_payment_cycle

integer

完了した請求サイクルの数。

Example:

1

subscription_details.last_payment_status

string

このサブスクリプションの最後の支払いステータス。

Example:

"SUCCESSFUL"

subscription_details.next_payment_date

string<date-time>

サブスクリプションの次回支払日。

Example:

"2024-11-28T01:31:29.154Z"

subscription_details.next_payment_cycle

integer

次の支払いサイクルの番号。

Example:

2

subscription_details.subscription_plan_details

object

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

表示子属性

subscription_details.subscription_plan_details.name

string

サブスクリプションプランの名前。

Example:

"Three weeks plan"

subscription_details.subscription_plan_details.desc

string

サブスクリプションプランの説明。

Example:

"Billed every two days"

subscription_details.subscription_plan_details.billing_cycle_type

string

請求サイクルの種類（例：日単位または月単位）。

Example:

"DAYS"

subscription_details.subscription_plan_details.billing_cycle_interval

integer

請求サイクル間隔。

Example:

2

subscription_details.subscription_plan_details.amount

integer

サブスクリプションプランの支払額。

Example:

1000

subscription_details.subscription_plan_details.ccy

string

サブスクリプション取引の通貨。

Example:

"JPY"

subscription_details.subscription_plan_details.trial_period_duration

string

試用期間の長さ（該当する場合）。

Example:

""

subscription_details.subscription_plan_details.trial_period_duration_type

string

試用期間の種類（例：日単位または月単位）。

Example:

"NONE"

subscription_details.subscription_plan_details.plan_discount_percentage

number

サブスクリプションプランの割引率。

Example:

10

subscription_details.subscription_plan_details.plan_discount_duration

integer

割引の適用期間（請求サイクル単位）。

Example:

2

subscription_details.subscription_transaction_details

object[]

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

表示子属性

subscription_details.subscription_transaction_details.id

string

このサブスクリプション取引の取引 ID。

Example:

"359f39bd-673a-47b3-b9ec-cbd6cd313b8e"

subscription_details.subscription_transaction_details.ref

integer

サブスクリプション取引の参照番号。

Example:

74860

subscription_details.subscription_transaction_details.cycle

integer

取引の支払いサイクル番号。

Example:

1

subscription_details.subscription_transaction_details.status

string

サブスクリプション取引のステータス。

Example:

"SUCCESSFUL"

subscription_details.subscription_transaction_details.transaction_date

string<date-time>

サブスクリプション取引の日付。

Example:

"2024-11-26T01:31:29.000Z"

subscription_details.subscription_transaction_details.amount

integer

取引の支払額。

Example:

900

subscription_details.subscription_transaction_details.ccy

string

取引の通貨。

Example:

"JPY"

subscription_details.subscription_transaction_details.event

string

取引のイベントタイプ（例：CAPTURED）。

Example:

"CAPTURED"

サブスクリプション作成API サブスクリプション一時停止API

⌘I

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

サブスクリプションキャンセルAPI

重要なポイント

サブスクリプションをキャンセル

サブスクリプションの状態

必要なパラメータ

フローダイアグラム

APIパラメータ

Authorizations

Path Parameters

Response

入門

APIエンドポイント

エラーとレスポンス

ウェブフック

​重要なポイント

​サブスクリプションをキャンセル

​サブスクリプションの状態

​必要なパラメータ

​フローダイアグラム

​APIパラメータ

Authorizations

Path Parameters

Response

重要なポイント

サブスクリプションをキャンセル

サブスクリプションの状態

必要なパラメータ

フローダイアグラム

APIパラメータ