GET/partners/customers/{domainId}/subscriptions/{subscriptionId}/renewal

Gets subscription renewal information.

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}/subscriptions/{subscriptionId}/renewal

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 
subscriptionId string 

Subscription ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
subscriptionId integer 

Subscription ID


required 
type string 

Subscription renewal type

  • STAY: Renew the subscription under the same conditions.
  • CHANGE: Renew the subscription with changes (which are specified as parameters)
  • CANCEL: No renewal (cancellation)

required
Allowed values : STAY, CHANGE, CANCEL 
productId string 

Paid plan ID

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

Allowed values : STD, ADV 
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 at the time of renewal


maximum : 1000000 

Response Example

Example1

1{2  "subscriptionId": 0,3  "type": "STAY",4  "productId": "STD",5  "plan": "MONTHLY",6  "licenseCount": 10000007}