GET/partners/customers/{domainId}/usages

顧客の利用履歴を取得する。

注意
この API は引き続きご利用いただけますが、ドキュメントは、顧客の利用履歴の取得 をご参照ください。

Authorization

oauth2

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

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/usages

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Query Parameters

ParameterTypeDescription
year integer 

取得年


required
example : 2021 
month integer 

取得月


required
minimum : 1
maximum : 12
example : 6 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
usages array (Usages) 

利用履歴は毎日 0 時に顧客企業の商品、プラン、ユーザー数などがメーターリングされる。
メーターリングされた利用履歴の商品、プラン、ライセンス、ユーザー数によって利用金額が計算される。

 

Usages

PropertyTypeDescription
usedDate string 

日付


format : date
readOnly : true 
productId string 

商品 ID

  • FR : Free
  • LT_T : Lite Trial
  • BS_T : Basic Trial
  • PRM_T : Premium Trial
  • LT : Lite
  • BS : Basic
  • PRM : Premium
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

Allowed values : FR, LT_T, BS_T, PRM_T, LT, BS, PRM, STD_T, ADV_T, STD, ADV
nullable : true 
plan string 

プラン

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

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

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


readOnly : true 
memberCount integer 

ユーザー数


readOnly : true 
maxMemberCount integer 

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

 
status string 

ステータス

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

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

Response Example

example

1{2  "usages": [3    {4      "usedDate": "2021-11-01",5      "productId": "STD",6      "plan": "MONTHLY",7      "memberCount": 100,8      "maxMemberCount": 100,9      "status": "ACTIVE"10    }11  ]12}