POST/partners/customers/{domainId}/option-products

Adds an option.

  • An option cannot be added during the Trial grace period.

  • If an option is added, any scheduled tasks for the option will be deleted.

  • For a Trial subscription, you can only add Trial options. In case of paid plan conversion, you need to separately convert options to a paid subscription.

  • For a paid subscription, you can add a Trial or paid option.

  • LINE WORKS Options

    • Archive (Talk): Available on a trial basis.
      • Available for purchase with the Standard, Standard Trial, Advanced, or Advanced Trial plan.
    • Shared Storage
      • Available for purchase with the Standard or Advanced plan.
    • Drive: Available on a trial basis.
      • Available for purchase with the Standard, Standard Trial, Advanced, or Advanced Trial plan.
    • Extend contacts
      • Available for purchase with the Standard or Advanced plan.

Authorization

oauth2

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

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/option-products

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
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 
quantity integer 

Purchased quantity

  • Specify the quantity of an addable option.

nullable : true 

Request Example

Purchase 5 TB of Shared Storage

1{2  "optionProductId": "SSTG2",3  "subOptionId": "SSTG202"4}

Purchase Archive (Talk)

1{2  "optionProductId": "ACV2",3  "subOptionId": "ACV201"4}

Response

HTTP 201

OK

PropertyTypeDescription
subscriptionId integer 

Subscription ID


required 
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 
appliedTime string 

Date and time when the option is added (purchased)


required
format : date-time
readOnly : true 
quantity integer 

Quantity

  • It is 1 if optionProductId is SSTG2 or BCT.
  • It is null if not.

readOnly : true
nullable : 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 
planStartDate string 

Start date


required
format : date
readOnly : true 
planEndDate string 

End date

  • For a paid plan, it is the plan end date.
  • For a Trial plan, it is when the Trial period ends.

required
format : date
readOnly : true