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

サブスクリプションを一時停止

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

POST

api

server-to-server-interface

subscription

{subscription_id}

pause

サブスクリプションを一時停止

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

"PAUSED"

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

請求サイクルの種類（例：DAYS または MONTHS）。

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

トライアル期間の種類（例：DAYS または MONTHS）。

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パラメータ