GET/partners/customers/{domainId}/usages

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

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 
productGroupId string 

商品グループ ID

  • WORKS : LINE WORKSサービス
  • ROGER : LINE WORKSラジャーサービス
  • NOTE_AI : LINE WORKS AiNoteサービス
  • JP_PAPER_ON : LINE WORKS PaperOnサービス
  • JP_AI_STUDIO : LINE WORKS AiStudioサービス

Allowed values : WORKS, NOTE_AI, ROGER, JP_PAPER_ON, JP_AI_STUDIO 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
usages array (Usages) 

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

 

Usages

PropertyTypeDescription
productGroupId string 

商品グループ ID

  • WORKS : LINE WORKSサービス
  • ROGER : LINE WORKSラジャーサービス
  • NOTE_AI : LINE WORKS AiNoteサービス
  • JP_PAPER_ON : LINE WORKS PaperOnサービス
  • JP_AI_STUDIO : LINE WORKS AiStudioサービス

required
Allowed values : WORKS, NOTE_AI, ROGER, JP_PAPER_ON, JP_AI_STUDIO 
usedDate string 

日付


required
format : date
readOnly : true 
productId string 

商品ID

  • LINE WORKSサービス

    • FR : フリープラン
    • LT_T : ライトプラントライアル
    • BS_T : ベーシックプラントライアル
    • PRM_T : プレミアムプラントライアル
    • LT : ライトプラン
    • BS : ベーシックプラン
    • PRM : プレミアムプラン
    • STD_T : スタンダードプラントライアル
    • ADV_T : アドバンストプラントライアル
    • STD : スタンダードプラン
    • ADV : アドバンストプラン

  • LINE WORKSラジャーサービス

    • ROG_FR : フリープラン
    • ROG_STD_T : スタンダードプラントライアル
    • ROG_ADV_T : アドバンストプラントライアル
    • ROG_STD : スタンダードプラン
    • ROG_ADV : アドバンストプラン

  • LINE WORKS AiNoteサービス

    • NTA_FR : フリープラン
    • NTA_SL_T : ソロプラントライアル
    • NTA_TM_T : チームプラントライアル
    • NTA_BZ_T : ビジネスプラントライアル
    • NTA_EP_T : エンタープライズプラントライアル
    • NTA_SL : ソロプラン
    • NTA_TM : チームプラン
    • NTA_BZ : ビジネスプラン
    • NTA_EP : エンタープライズプラン

  • LINE WORKS PaperOnサービス

    • JP_PPO_LT_T : ライトプラントライアル
    • JP_PPO_STD_T : スタンダードプラントライアル
    • JP_PPO_ADV_T : アドバンストプラントライアル
    • JP_PPO_LT : ライトプラン
    • JP_PPO_STD : スタンダードプラン
    • JP_PPO_ADV : アドバンストプラン

  • LINE WORKS AiStudioサービス

    • JP_AIS_STD : スタンダードプラン
    • JP_AIS_STD_T : スタンダードプラントライアル

required
Allowed values : FR, LT_T, BS_T, PRM_T, LT, BS, PRM, STD_T, ADV_T, STD, ADV, ROG_FR, ROG_STD_T, ROG_ADV_T, ROG_STD, ROG_ADV, NTA_FR, NTA_SL_T, NTA_TM_T, NTA_BZ_T, NTA_EP_T, NTA_SL, NTA_TM, NTA_BZ, NTA_EP, JP_PPO_LT_T, JP_PPO_STD_T, JP_PPO_ADV_T, JP_PPO_LT, JP_PPO_STD, JP_PPO_ADV, JP_AIS_STD_T, JP_AIS_STD 
plan string 

プラン (契約タイプ)

  • FREE : フリー
  • FREE_LICENSE : フリー ライセンス
  • TRIAL : トライアル
  • TRIAL_LICENSE : トライアル ライセンス
  • MONTHLY : 月額契約 後払い
  • MONTHLY_LICENSE : 月額契約 後払い ライセンス
  • ANNUAL : 年額契約 月払い
  • ANNUAL_LICENSE : 年額契約 月払い ライセンス
  • ANNUAL_PREPAY : 年額契約 一括払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

商品グループ別の適用可能なプラン

  • LINE WORKSサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKSラジャーサービス
    • FREE_LICENSE : フリー ライセンス
    • TRIAL_LICENSE : トライアル ライセンス
    • MONTHLY_LICENSE : 月額契約 後払い ライセンス
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKS AiNoteサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS PaperOnサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS AiStudioサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い

required
Allowed values : FREE, TRIAL, MONTHLY, ANNUAL, ANNUAL_PREPAY, FREE_LICENSE, TRIAL_LICENSE, MONTHLY_LICENSE, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

ライセンス数


readOnly : true 
memberCount integer 

ユーザー数


readOnly : true 
maxMemberCount integer 

最大ユーザー数

 
status string 

顧客企業の状態

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

required
Allowed values : ACTIVE, SUSPENDED_ADMIN, SUSPENDED_WITHDRAWAL 

Response Example

Example 1

1{2  "usages": [3    {4      "productGroupId": "WORKS",5      "usedDate": "2019-08-24",6      "productId": "FR",7      "plan": "FREE",8      "licenseCount": 0,9      "memberCount": 0,10      "maxMemberCount": 0,11      "status": "ACTIVE"12    }13  ]14}