PATCH/partners/customers/{domainId}/subscription/set-max-member-count

顧客企業の最大ユーザー数を設定する。

  • 顧客企業が月額契約の場合のみ設定可能。
  • Free プラン 顧客の場合、上限は 30 名。
  • Trial プラン 顧客の場合、上限は 1,000 名。
  • 最大ユーザー数を予約設定している場合、予約設定は削除される。

注意
この API は、将来の提供終了を予定しています。
今後は、使用状況情報の部分更新 をご利用ください。

Authorization

oauth2

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

Scope

partner

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/partners/customers/{domainId}/subscription/set-max-member-count

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
maxMemberCount integer 

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

  • null: 制限しない
  • Free プラン 顧客の場合、上限は 30 名。
  • Trial プラン 顧客の場合、上限は 1,000 名。

required
maximum : 1000000
nullable : true 

Request Example

最大ユーザー数 200 に設定

1{2  "maxMemberCount": 2003}

最大ユーザー数を設定しない

1{2  "maxMemberCount": null3}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

ドメイン ID


readOnly : 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 
plan string 

プラン

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

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
planStartDate string 

プラン開始日


format : date
readOnly : true 
planEndDate string 

プラン終了日

  • 有料プラン の場合はプラン終了日
  • Trial プラン の場合はトライアル期間終了日
  • 無料プラン の場合は null

format : date
readOnly : true 
licenseCount integer 

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

 
memberCount integer 

利用ユーザー数


readOnly : true 
maxMemberCount integer 

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


nullable : true 
optionPlus boolean 

オプションプラス申請済みフラグ (廃止済み。常に true)

 
status string 

ステータス

  • ACTIVE : 正常
  • UPGRADING : アップグレード中
  • SUSPENDED_TRIALEND : 停止 (トライアル終了による停止)
  • SUSPENDED_ADMIN : 停止 (管理者による停止)
  • SUSPENDED_WITHDRAWAL: 停止 (解約待機による停止)

Allowed values : ACTIVE, UPGRADING, SUSPENDED_TRIALEND, SUSPENDED_ADMIN, SUSPENDED_WITHDRAWAL 
withdrawalDate string 

解約日

  • 契約ステータス (status) が解約待機による停止 (SUSPENDED_WITHDRAWAL) の場合、顧客企業の削除 (解約) 日付
  • その他のステータス (status) の場合は null

readOnly : true 
renewal object (renewal) 

顧客企業の契約更新を設定するモデル
type 属性で現在と同条件で更新するか、もしくは契約内容を変更するか選択可能。
更新の際にライセンスを減らすことも可能。

 
reservation object (reservation) 

顧客企業の予約を設定するモデル
有料転換及び解約は、翌日から契約終了日の翌日まで適用日を指定でき、最大ユーザー数の設定は翌日から契約終了日の翌日まで適用日を指定可能。

 

renewal

PropertyTypeDescription
type string 

契約更新設定タイプ

  • STAY : 現在の契約と同条件で契約更新
  • CHANGE : 契約内容を変更して契約更新 (内容はパラメータで指定)

Allowed values : STAY, CHANGE 
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 

契約更新時に設定するドメイン名

  • アップグレードドメインの登録 で登録したドメイン名のみ利用可能。
 
plan string 

プラン

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

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

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


maximum : 1000000 
maxMemberCount integer 

契約更新時設定する最大ユーザー数 (月額契約)


nullable : true 

reservation

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  "domainId": 10000001,3  "productId": "STD",4  "plan": "MONTHLY",5  "planStartDate": "2021-11-01",6  "planEndDate": "2021-11-30",7  "memberCount": 100,8  "maxMemberCount": 100,9  "optionPlus": true,10  "status": "ACTIVE",11  "renewal": {12    "type": "STAY",13    "productId": "STD",14    "plan": "MONTHLY",15    "maxMemberCount": 10016  },17  "reservation": {18    "type": "SET_MAX_USER",19    "applyDate": "2021-12-01",20    "plan": "MONTHLY",21    "maxMemberCount": 200,22    "productId": "STD",23    "domain": "example.com"24  }25}