PATCH/partners/customers/{domainId}/subscriptions/{subscriptionId}/reservation

Updates a scheduled task 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/{subscriptionId}/reservation

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 
subscriptionId string 

Subscription ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
applyDate string 

Scheduled date

  • If type is START_PAID_SERVICE
  • If type is ADD_LICENSE
    • The date can range from the next day to the end of the contract.
  • If type is CANCEL
    • The date can range from the next day to the day after the contract ends.
 

Request Example

Change the scheduled date for cancellation to 2021-11-01

1{2  "applyDate": "2021-11-01"3}

Response

HTTP 200

OK

PropertyTypeDescription
subscriptionId integer 

Subscription ID


required 
type string 

Scheduled subscription type

  • CANCEL: Cancel a subscription
  • START_PAID_SERVICE: Start a paid subscription
  • ADD_LICENSE: Add licenses

required
Allowed values : CANCEL, START_PAID_SERVICE, ADD_LICENSE 
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 
productId string 

Paid plan ID

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

Allowed values : STD, ADV 
licenseCount integer 
  • When starting a paid subscription: Number of licenses to apply (the specified number of licenses is applied)
  • When adding licenses: Number of licenses to add (the specified number of licenses is added)