PATCH/partners/customers/{domainId}/usage-status

最大ユーザー数 (maxMemberCount) の設定、またはプラットフォームの退会予約日 (withdrawalDate) を設定する。

  • 最大ユーザー数 (maxMemberCount) 設定

    • 最大ユーザー数の設定が予約されている場合、予約設定は削除される。

  • プラットフォームの退会予約日 (withdrawalDate) 設定

    • パートナードメインについては退会予約は設定できない。
    • プラットフォームの退会予約をした後、退会予約日 (withdrawalDate) 前日までに商品を使用すると、利用した商品の利用料金及び違約金が次の請求に反映されるので、契約期間満了で解約するには退会予約日を契約期間満了日の翌日に設定する。
    • プラットフォームの退会予約で退会予約日(withdrawalDate) に到達したとき :
      • リアルタイム課金ができない有料アプリをインストールしたことがある顧客の場合、オプションプラス料金確定のためにドメイン状態が解約待機になる。
        • 解約待機の場合、使用状況の取得 の状態 (status) が解約待機による停止 (SUSPENDED_WITHDRAWAL) となり、顧客企業の削除(退会)日は 使用状況の取得 の解約日 (withdrawalDate) で確認可能。
        • 解約待機中はオプションプラス以外の料金は発生しない。また、解約待機のキャンセルはできない。
        • 予約解約設定の適用日として 2 日から 24 日を指定した場合、適用月の翌月 1 日の請求が最後となり、解約日は、翌月 2 日となる。
        • 予約解約設定の適用日として 25 日から翌月 1 日を指定した場合、適用月の翌々月 1 日にオプションプラスの料金のみが請求される可能性があり、解約日は翌々月 2 日となる。24 日までに予約解約設定を行い、適用日を 25 日から翌月 1 日に指定すれば、25 日にリアルタイム課金できないアプリの利用が停止されるため、適用月の翌々月 1 日にオプションプラスの料金は発生しないが、解約日は翌々月 2 日となる。
      • リアルタイム課金ができない有料アプリをインストールしたことがない顧客の場合、顧客が削除 (解約) される。
      • リアルタイム課金ができない有料アプリは次の通り :
        • 宅急便を送る (ヤマト運輸)

Authorization

oauth2

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

Scope

partner

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/partners/customers/{domainId}/usage-status

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
maxMemberCount integer 

設定する最大ユーザー数

  • null の場合には制限なし
  • 最大で 1,000,000 まで指定できる

maximum : 1000000
nullable : true 
withdrawalDate string 

退会予約日

  • null の場合には、退会予約の削除
  • 最大で 1 年後まで指定できる

format : date
nullable : true 

Request Example

最大ユーザー数を 10 に、退会予約日を 2025-12-31 に設定

1{2  "maxMemberCount": 10,3  "withdrawalDate": "2025-12-31"4}

設定された予約退会を削除し、最大ユーザー数を 10 に設定

1{2  "maxMemberCount": 10,3  "withdrawalDate": null4}

最大ユーザー数と退会予約時を削除

1{2  "maxMemberCount": null,3  "withdrawalDate": null4}

退会予約日を 2025-12-31 に設定し、最大ユーザー数設定を削除

1{2  "maxMemberCount": null,3  "withdrawalDate": "2025-12-31"4}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

ドメイン ID

 
status string 

顧客企業の状態

  • ACTIVE : 正常
  • SUSPENDED_ADMIN : 停止 (管理者による停止)
  • SUSPENDED_WITHDRAWAL :停止 (脱退待機による停止)

Allowed values : ACTIVE, SUSPENDED_ADMIN, SUSPENDED_WITHDRAWAL 
memberCount integer 

利用ユーザー数

 
maxMemberCount integer 

最大ユーザー数


nullable : true 
withdrawalDate string 

解約日

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

format : date
nullable : true 
renewal object (renewal) 

予約情報

 

renewal

PropertyTypeDescription
maxMemberCount integer 

最大ユーザー数


nullable : true 
applyDate string 

予約適用日


required
format : date 

Response Example

Example 1

1{2  "domainId": 0,3  "status": "ACTIVE",4  "memberCount": 0,5  "maxMemberCount": 0,6  "withdrawalDate": "2019-08-24"7}