PATCH/partners/customers/{domainId}/subscriptions/pre-orders/{preOrderId}

Updates a scheduled task to apply for a subscription.

  • This API operation can update only the scheduled date (applyDate) of a scheduled task that has already been created.

Authorization

oauth2

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

Scope

partner

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/partners/customers/{domainId}/subscriptions/pre-orders/{preOrderId}

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 
preOrderId integer 

Scheduled task ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
applyDate string 

Scheduled date

  • It can range from the next day to 31 days later.

format : date 

Request Example

Change the scheduled date to 2025-02-10

1{2  "applyDate": "2025-02-10"3}

Response

HTTP 200

OK

PropertyTypeDescription
subscriptionPreOrders array (SubscriptionsPreOrders) 
 

SubscriptionsPreOrders

PropertyTypeDescription
preOrderId integer 

Scheduled task ID


required 
productId string 

Paid plan ID

  • LINE WORKS Service
    • STD: Standard plan
    • ADV: Advanced plan

Allowed values : STD, ADV 
applyDate string 

Scheduled date


required
format : date 
plan string 

Paid contract type

  • 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
    • MONTHLY: Monthly contract postpay
    • ANNUAL_LICENSE: Annual contract monthly license
    • ANNUAL_PREPAY_LICENSE: Annual contract lump sum license

Allowed values : MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

Number of licenses to apply.

  • It is required if the contract type (Plan) is license-based.