POST/partners/customers/{domainId}/option-product-orders

Adds scheduled tasks for options.

  • A scheduled task cannot be added during the Trial grace period.

  • If an annual subscription option is canceled, it can be added again starting the following month.

  • Note

    • If the type is APPLY
      • Specify the quantity if the option is addable (it is null if not).
      • If there is a scheduled task for the subscription, you can add one for an option only on the same scheduled date.
      • If there is a scheduled task to apply for a new subscription, you can add a scheduled task to apply for an option.
      • For a paid subscription, you can add a scheduled task to apply for a Trial or paid option.
      • For a Trial subscription, you can add a scheduled task to apply for a Trial option.
      • For a Free or Trial subscription, you can add a scheduled task to apply for a paid option only when paid plan conversion (START_PAID_SERVICE) is scheduled.
      • Scheduled date (applyDate)
        • Application for both a subscription and an option is scheduled: It is the same as the scheduled date for the subscription.
        • Both paid plan conversion and application for an option are scheduled: It is the same as the scheduled date for the subscription.
        • Application for an option is scheduled while using a paid subscription: It can be from the next day to the subscription renewal date (planEndDate +1 day).
    • If the type is CANCEL
      • You can add a scheduled task to cancel a Trial or paid option.
      • For a Trial subscription, you can add a scheduled task to cancel an option only when paid plan conversion (START_PAID_SERVICE) is scheduled.
      • Scheduled date (applyDate)
        • Both paid plan conversion and option cancellation are scheduled: It is the same as the scheduled date for the subscription.
        • Cancellation of an option is scheduled while using a paid subscription: It can be from the next day to the option renewal date (planEndDate +1 day).
    • If the type is START_PAID_SERVICE
      • You can add a scheduled task to convert a Trial option to a paid one.
      • For subOptionId, specify a paid option ID to convert to.
      • After paid plan conversion, the same subscription plan (contract type) automatically applies to the option.
      • Scheduled date (applyDate)
        • Paid plan conversion is scheduled for both a subscription and a Trial option: It is the same as the scheduled date for the subscription.
        • A Trial option is scheduled to convert to a paid one while using a paid subscription: It can be from the next day to the day after the option’s Trial ends (no grace period).
    • If the type is MODIFY
      • You can add a scheduled task to upgrade an option such as Drive, Shared Storage, and Extend contacts to a higher one.
      • An option cannot be upgraded to the same one.
      • An option can only be upgraded to a higher one.
      • Scheduled date (applyDate)
        • It can be from the next day to the day after the subscription ends.
    • If the type is CHANGE_QUANTITY
      • You can add a scheduled task to change the quantity of an addable option on a monthly basis.
      • The quantity must be greater than the current value.
      • Scheduled date (type: CHANGE_QUANTITY)
        • It can only be the first of the following month. (Note that the first of the following month must fall within the subscription period).
        • You cannot add a scheduled task in the subscription end month.

  • LINE WORKS Options

    • Archive (Talk)
      • Available with the Standard, Standard Trial, Advanced, or Advanced Trial plan.
      • You can schedule an application (APPLY), cancellation (CANCEL), or paid plan conversion (START_PAID_SERVICE).
    • Shared Storage
      • Available with the Standard or Advanced plan.
      • You can schedule an application (APPLY), cancellation (CANCEL), or upgrade (MODIFY).
    • Drive
      • Available with the Standard, Standard Trial, Advanced, or Advanced Trial plan.
      • You can schedule an application (APPLY), cancellation (CANCEL), conversion from trial to paid (START_PAID_SERVICE), or upgrade (MODIFY).
    • Extend contacts
      • Available with the Standard or Advanced plan.
      • You can schedule an application (APPLY), cancellation (CANCEL), or upgrade (MODIFY).

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-product-orders

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)

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

Scheduled task type

  • APPLY: Apply for an option
  • START_PAID_SERVICE: Convert an option to paid
  • CHANGE_QUANTITY: Update the quantity of an option
  • CANCEL: Cancel an option

required
Allowed values : APPLY, START_PAID_SERVICE, CHANGE_QUANTITY, CANCEL 
quantity integer 

Quantity The maximum quantity varies depending on the plan.

 
applyDate string 

Scheduled date


required
example : 2021-11-01 

Request Example

Cancel Drivate on 2021-11-01

1{2  "optionProductId": "DRV",3  "subOptionId": "DRV01",4  "type": "CANCEL",5  "applyDate": "2021-11-01"6}

Add an option for extending the number of clients/partners contacts to a maximum of 250,000 on 2021-11-01

1{2  "optionProductId": "BCT",3  "subOptionId": "BCT01",4  "type": "APPLY",5  "applyDate": "2021-11-01"6}

Convert Trial Drive (for STD) to paid on 2021-11-01

1{2  "optionProductId": "DRV",3  "subOptionId": "DRV_PS",4  "type": "START_PAID_SERVICE",5  "applyDate": "2021-11-01"6}

Response

HTTP 201

OK

PropertyTypeDescription
subscriptionId integer 

Subscription ID

  • It is null if an option is scheduled to be added after a subscription.
  • It is the subscriptionId if an option is scheduled to be added for the subscription currently in use.
 
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 
type string 

Scheduled task type

  • APPLY: Apply for an option
  • START_PAID_SERVICE: Convert an option to paid
  • CHANGE_QUANTITY: Update the quantity of an option
  • CANCEL: Cancel an option

required
Allowed values : APPLY, START_PAID_SERVICE, CHANGE_QUANTITY, CANCEL 
quantity integer 

Quantity

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

readOnly : true
nullable : true 
applyDate string 

Scheduled date


required
format : date 

Response Example

Example 1

1{2  "subscriptionId": 0,3  "optionProductId": "ACV2",4  "subOptionId": "ACV201",5  "type": "APPLY",6  "quantity": null,7  "applyDate": "2019-08-24"8}