GET/partners/customers/{domainId}/option-product-usages

Gets the usage list of an option.

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}/option-product-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
optionProductUsages array (OptionProductUsages) 
 

OptionProductUsages

PropertyTypeDescription
productGroupId string 

Plan group ID

  • WORKS: LINE WORKS Service

required
Allowed values : WORKS, NOTE_AI, ROGER 
optionProductId string 

Option ID

  • LINE WORKS options
    • ACV2: Archive (Talk)
    • DRV: Drive
    • SSTG2: Shared Storage
    • BCT: Extend contacts

required
Allowed values : ACV2, DRV, SSTG2, BCT 
subOptionId string 

Sub option ID

  • LINE WORKS options
    • If the option ID is ACV2
      • ACV200: Archive (Talk) Trial
      • ACV201: Archive (Talk)
    • If the option ID is DRV
      • DRV00: Drive Trial (for STD)
      • DRV01: Drive (for STD)
      • DRV_PS_T: Drive Plus Trial (for STD)
      • DRV_PS: Drive Plus (for STD)
      • DRV_PA_T: Drive Plus Trial (for ADV)
      • DRV_PA: Drive Plus (for ADV)
    • If the option ID is SSTG2
      • SSTG201: Shared Storage (1 TB)
      • SSTG202: Shared Storage (5 TB)
      • SSTG203: Shared Storage (10 TB)
      • SSTG204: Shared Storage (25 TB)
      • SSTG205: Shared Storage (50 TB)
      • SSTG206: Shared Storage (100 TB)
      • SSTG207: Shared Storage (500 TB)
    • If the option ID is BCT
      • BCT01: Extend contacts (up to 250,000 contacts)
      • BCT02: Extend contacts (up to 500,000 contacts)
      • BCT03: Extend contacts (up to 1,500,000 contacts)
      • BCT04: Extend contacts (up to 5,000,000 contacts)

required
Allowed values : ACV200, ACV201, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04 
usedDate string 

Date


required
format : date
readOnly : true 
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 
memberCount integer 

Number of users


readOnly : true 
licenseCount integer 

Number of licenses


readOnly : true
nullable : true 
quantity integer 

Quantity

  • If optionProductId is SSTG, the unit is TB.
  • It is null if not.

readOnly : true
nullable : true 
usageCount integer 

Usage count


nullable : true 

Response Example

Get the annual license usage history of LINE WORKS Email Archive

1{2  "optionProductUsages": [3    {4      "productGroupId": "WORKS",5      "optionProductId": "ACV2",6      "subOptionId": "ACV201",7      "usedDate": "2025-02-01",8      "plan": "ANNUAL_LICENSE",9      "memberCount": 1,10      "licenseCount": 1,11      "quantity": null,12      "usageCount": null13    },14    {15      "productGroupId": "WORKS",16      "optionProductId": "ACV2",17      "subOptionId": "ACV201",18      "usedDate": "2025-02-02",19      "plan": "ANNUAL_LICENSE",20      "memberCount": 1,21      "licenseCount": 1,22      "quantity": null,23      "usageCount": null24    },25    {26      "productGroupId": "WORKS",27      "optionProductId": "ACV2",28      "subOptionId": "ACV201",29      "usedDate": "2025-02-03",30      "plan": "ANNUAL_LICENSE",31      "memberCount": 1,32      "licenseCount": 1,33      "quantity": null,34      "usageCount": null35    },36    {37      "productGroupId": "WORKS",38      "optionProductId": "ACV2",39      "subOptionId": "ACV201",40      "usedDate": "2025-02-04",41      "plan": "ANNUAL_LICENSE",42      "memberCount": 1,43      "licenseCount": 1,44      "quantity": null,45      "usageCount": null46    },47    {48      "productGroupId": "WORKS",49      "optionProductId": "ACV2",50      "subOptionId": "ACV201",51      "usedDate": "2025-02-05",52      "plan": "ANNUAL_LICENSE",53      "memberCount": 1,54      "licenseCount": 1,55      "quantity": null,56      "usageCount": null57    },58    {59      "productGroupId": "WORKS",60      "optionProductId": "ACV2",61      "subOptionId": "ACV201",62      "usedDate": "2025-02-06",63      "plan": "ANNUAL_LICENSE",64      "memberCount": 1,65      "licenseCount": 1,66      "quantity": null,67      "usageCount": null68    },69    {70      "productGroupId": "WORKS",71      "optionProductId": "ACV2",72      "subOptionId": "ACV201",73      "usedDate": "2025-02-07",74      "plan": "ANNUAL_LICENSE",75      "memberCount": 1,76      "licenseCount": 1,77      "quantity": null,78      "usageCount": null79    }80  ]81}