POST/partners/customers/{domainId}/usage-status/renewal

Creates a scheduled task to change the maximum number of users (maxMemberCount).

  • The scheduled date (applyDate) can range from the next day to one year later.

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}/usage-status/renewal

Path Parameters

ParameterTypeDescription
domainId integer 

Domain ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
applyDate string 

Scheduled date

  • The date can range from the next day to 1 year later.

required
format : date 
maxMemberCount integer 

Maximum number of users to apply


nullable : true 

Request Example

Set the maximum number of users to 100 on 2025-02-15

1{2  "applyDate": "2025-02-15",3  "maxMemberCount": 1004}

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

Domain ID

 
status string 

Customer status

  • ACTIVE: Active
  • SUSPENDED_ADMIN: Suspended (by the administrator)
  • SUSPENDED_WITHDRAWAL: Suspended (pending cancellation)

Allowed values : ACTIVE, SUSPENDED_ADMIN, SUSPENDED_WITHDRAWAL 
memberCount integer 

Number of users

 
maxMemberCount integer 

Maximum number of users


nullable : true 
withdrawalDate string 

Cancellation date

  • It is the date when the customer’s subscription is deleted (canceled) if the status is SUSPENDED_WITHDRAWAL.
  • Otherwise, it is null.

format : date
nullable : true 
renewal object (renewal) 

Scheduled subscription information

 

renewal

PropertyTypeDescription
maxMemberCount integer 

Maximum number of users


nullable : true 
applyDate string 

Scheduled date


required
format : date 

Response Example

Example 1

1{2  "domainId": 0,3  "status": "ACTIVE",4  "memberCount": 0,5  "maxMemberCount": 0,6  "withdrawalDate": "2019-08-24"7}