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

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

  • 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}/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 

Request Example

Change the scheduled date to "2025-02-20"

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

Response

HTTP 200

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}