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

顧客企業の使用状況に関する情報を取得する。

Authorization

oauth2

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

Scope

partner
partner.read

HTTP Request

GEThttps://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 

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}