GET/partners/customers/{domainId}/usages

Gets customer usage information.

Authorization

oauth2

OAuth 2.0 authentication. For more information, see Authentication and Authorization.

Scope

partner
partner.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 

Query Parameters

ParameterTypeDescription
year integer 

Year


required
example : 2021 
month integer 

Month


required
minimum : 1
maximum : 12
example : 6 
productGroupId string 

Plan group ID

  • WORKS: LINE WORKS Service

Allowed values : WORKS 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
usages array (Usages) 

The usage is metered at midnight every day, including the subscription, plan, and number of users.
The charges will be calculated based on the metered usage, including subscription, plan, number of licenses, and number of users.

 

Usages

PropertyTypeDescription
productGroupId string 

Plan group ID

  • WORKS: LINE WORKS Service

required
Allowed values : WORKS, NOTE_AI, ROGER 
usedDate string 

Date


required
format : date
readOnly : true 
productId string 

Plan ID

  • LINE WORKS Service
    • STD_T: Standard Trial plan
    • ADV_T: Advanced Trial plan
    • STD: Standard plan
    • ADV: Advanced plan

required
Allowed values : STD_T, ADV_T, STD, ADV 
plan string 

Contract type

  • TRIAL: Trial
  • MONTHLY: Monthly contract postpay
  • ANNUAL_LICENSE: Annual contract monthly license
  • ANNUAL_PREPAY_LICENSE: Annual contract lump sum license

Applicable contract types by plan group

  • LINE WORKS Service
    • TRIAL: Trial
    • MONTHLY: Monthly contract postpay
    • ANNUAL_LICENSE: Annual contract monthly license
    • ANNUAL_PREPAY_LICENSE: Annual contract lump sum license

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

Number of licenses


readOnly : true 
memberCount integer 

Number of users


readOnly : true 
maxMemberCount integer 

Maximum number of users

 
status string 

Customer status

  • ACTIVE: Active
  • SUSPENDED_ADMIN: Suspended (by the administrator)
  • SUSPENDED_WITHDRAWAL: Suspended (pending cancellation)

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": "STD_T",7      "plan": "TRIAL",8      "licenseCount": 0,9      "memberCount": 0,10      "maxMemberCount": 0,11      "status": "ACTIVE"12    }13  ]14}