POST/partners/customers/{domainId}/subscription/reservation

顧客企業のLINE WORKSサービス予約設定を登録する。

  • パートナードメインに対しては、解約 (type: DELETE) 予約は設定不可能。
  • 有料プランの解約 (type: DELETE) 予約設定の場合、適用日 (applyDate) の前日までの利用料金及び違約金が次回の請求に反映されるため、契約期間満了で解約するには、適用日を契約期間満了日の翌日で設定する。
  • 有料プランの解約 (type: DELETE) 予約設定で適用日 (applyDate) に達した際に、
    • リアルタイム課金ができない有料アプリをインストールしたことがある顧客企業の場合、オプションプラスの料金確定のため契約ステータスが解約待機となる。
      • 解約待機の場合、契約情報の取得 のステータス (status) が解約待機による停止 (SUSPENDED_WITHDRAWAL) となり、顧客企業の削除 (解約) 日は、契約情報の取得 の解約日 (withdrawalDate) で確認可能。
      • 解約待機中は、オプションプラス以外の料金は発生しない。また、解約待機のキャンセルは不可。
      • 予約解約設定の適用日として 2 日から 24 日を指定した場合、適用月の翌月 1 日の請求が最後となり、解約日は、翌月 2 日となる。
      • 予約解約設定の適用日として 25 日から翌月 1 日を指定した場合、適用月の翌々月 1 日にオプションプラスの料金のみが請求される可能性があり、解約日は翌々月 2 日となる。24 日までに予約解約設定を行い、適用日を 25 日から翌月 1 日に指定すれば、25 日にリアルタイム課金できないアプリの利用が停止されるため、適用月の翌々月 1 日にオプションプラスの料金は発生しないが、解約日は翌々月 2 日となる。
    • リアルタイム課金ができない有料アプリをインストールしたことがない顧客企業の場合、顧客企業が削除 (解約) される。
    • リアルタイム課金ができない有料アプリは、以下の通り。
      • 宅急便を送る (ヤマト運輸)
  • 有料転換 (type: START_PAID_SERVICE) の場合、Free/Trial プラン を利用する顧客企業のみ設定可能。
  • ライセンス追加 (type: ADD_LICENSE) は、年額契約を利用する顧客企業のみ設定可能。
  • 最大ユーザー数の設定 (type: SET_MAX_USER) の場合、月額契約を利用する顧客企業のみ設定可能。
  • Free プラン を有料転換予約する際、有料転換する商品 ID (productId) を指定する必要がある。
  • Free プラン を Advanced プラン に有料転換予約する際、アップグレードドメインにドメインを登録する必要がある。

注意
この API は、将来の提供終了を予定しています。
解約 (type: DELETE) 予約設定は、LINE WORKSプラットフォームの解約 の予約となります。
今後は、商品の有料転換、ライセンス追加、解約に関する予約は 商品の予約設定の登録 をご利用ください。
ドメインの解約予約は 使用状況情報の部分更新 をご利用ください。
ドメインの最大ユーザー数の変更予約は 使用状況情報の変更予約の設定 をご利用ください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/subscription/reservation

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
type string 

予約タイプ

  • DELETE : LINE WORKS サービス及びプラットフォームの解約
  • START_PAID_SERVICE : 有料転換
  • ADD_LICENSE : ライセンス追加
  • SET_MAX_USER : 最大ユーザー数設定

required
Allowed values : DELETE, START_PAID_SERVICE, ADD_LICENSE, SET_MAX_USER 
applyDate string 

適用日

  • type が START_PAID_SERVICE の場合
    • Free プラン: 翌日 ~ + 60 日
    • Trial プラン: 猶予期間終了日
  • type が DELETEの 場合
    • Trial/有料プラン: 翌日~契約終了日の翌日
    • Free プラン: 翌日 ~ + 60 日
  • type が ADD_LICENSE、SET_MAX_USER の場合
    • 翌日 ~ 契約終了日

required 
plan string 

プラン

  • FREE : Free
  • TRIAL : Trial
  • MONTHLY : 月額契約 後払
  • ANNUAL_LICENSE : 年額契約 月払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

ライセンス数 (年額契約)

  • type が START_PAID_SERVICE の場合、設定するライセンス数
  • type が ADD_LICENSE の場合、追加するライセンス数

maximum : 1000000 
maxMemberCount integer 

最大ユーザー数 (月額契約)

  • type が START_PAID_SERVICE の場合、設定する最大ユーザー数
  • type が SET_MAX_USER の場合、設定する最大ユーザー数

nullable : true 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

Allowed values : FR, STD_T, ADV_T, STD, ADV 
domain string 

ドメイン名

  • Free プラン から Advanced プラン に有料転換する際に使用するドメイン名。
    • アップグレードドメインの登録 で登録したドメイン名のみ利用可能。
  • Standard プラン に有料転換する場合は指定しない。

minLength : 2
maxLength : 22 

Request Example

2021-11-01 に解約を予約する

1{2  "type": "DELETE",3  "applyDate": "2021-11-01"4}

2021-11-01 に Free プランの顧客企業を Advanced プランの月額契約 (最大ユーザー数 30) で有料転換を予約する

1{2  "type": "START_PAID_SERVICE",3  "applyDate": "2021-11-01",4  "plan": "MONTHLY",5  "maxMemberCount": 30,6  "productId": "ADV",7  "domain": "example.com"8}

2021-08-11 にライセンス 100 個追加を予約する

1{2  "type": "ADD_LICENSE",3  "applyDate": "2021-08-11",4  "licenseCount": 1005}

2021-11-01 に最大ユーザーの制限解除を予約する

1{2  "type": "SET_MAX_USER",3  "applyDate": "2021-11-01",4  "maxMemberCount": null5}

Response

HTTP 201

OK

PropertyTypeDescription
type string 

予約タイプ

  • DELETE : LINE WORKS サービス及びプラットフォームの解約
  • START_PAID_SERVICE : 有料転換
  • ADD_LICENSE : ライセンス追加
  • SET_MAX_USER : 最大ユーザー数設定

Allowed values : DELETE, START_PAID_SERVICE, ADD_LICENSE, SET_MAX_USER 
applyDate string 

適用日


format : date 
plan string 

プラン

  • FREE : Free
  • TRIAL : Trial
  • MONTHLY : 月額契約 後払
  • ANNUAL_LICENSE : 年額契約 月払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

適用時に設定するライセンス数 (年額契約)

 
maxMemberCount integer 

適用時に設定する最大ユーザー数 (月額契約)

 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

Allowed values : FR, STD_T, ADV_T, STD, ADV 
domain string 

適用時に設定するドメイン名

 

Response Example

example

1{2  "type": "SET_MAX_USER",3  "applyDate": "2021-12-01",4  "plan": "MONTHLY",5  "maxMemberCount": 200,6  "productId": "STD",7  "domain": "example.com"8}