PATCH/partners/customers/{domainId}/subscription/renewal

顧客企業のLINE WORKSサービス契約更新設定を更新する。

  • Free/Trial プラン は更新設定不可能。
  • 契約内容を変更して契約更新 (CHANGE) の場合、Standard プラン は、Advanced プラン に更新可能 (指定がない場合は Standard プラン)。

注意
この API は、将来の提供終了を予定しています。
今後は、商品の更新設定の変更 をご利用ください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/partners/customers/{domainId}/subscription/renewal

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
type string 

契約更新設定タイプ

  • STAY : 現在の契約と同条件で契約更新
  • CHANGE : 契約内容を変更して契約更新 (内容はパラメータで指定)

required
Allowed values : STAY, CHANGE 
productId string 

商品 ID

  • STD : Standard
  • ADV : Advanced

Allowed values : STD, ADV 
domain string 

ドメイン名

  • Standard プラン から Advanced プラン にアップグレードする場合に設定するドメイン名。
    • アップグレードドメインの登録 で登録したドメイン名のみ利用可能。

minLength : 2
maxLength : 22 
plan string 

プラン

  • MONTHLY : 月額契約 後払
  • ANNUAL_LICENSE : 年額契約 月払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い

Allowed values : MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

ライセンス数 (年額契約)

  • 年額契約で更新する場合は必須

maximum : 1000000 
maxMemberCount integer 

最大ユーザー数 (月額契約)

  • null: 制限しない

maximum : 1000000
nullable : true 

Request Example

Standard プランから Advanced プランにアップグレードする

1{2  "type": "CHANGE",3  "productId": "ADV",4  "domain": "example.com"5}

月額後払 (最大ユーザー数 : 100) で更新する

1{2  "type": "CHANGE",3  "plan": "MONTHLY",4  "maxMemberCount": 1005}

年額契約 月払い (ライセンス数 : 50) で更新する

1{2  "type": "CHANGE",3  "plan": "ANNUAL_LICENSE",4  "licenseCount": 505}

現在の契約と同じ条件で更新する

1{2  "type": "STAY"3}

Response

HTTP 200

OK

PropertyTypeDescription
type string 

契約更新設定タイプ

  • STAY : 現在の契約と同条件で契約更新
  • CHANGE : 契約内容を変更して契約更新 (内容はパラメータで指定)

Allowed values : STAY, CHANGE 
productId string 

商品 ID

  • FR : Free
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • STD : Standard
  • ADV : Advanced

Allowed values : FR, STD_T, ADV_T, STD, ADV 
domain string 

契約更新時に設定するドメイン名

  • アップグレードドメインの登録 で登録したドメイン名のみ利用可能。
 
plan string 

プラン

  • FREE : Free
  • TRIAL : Trial
  • MONTHLY : 月額契約 後払
  • ANNUAL_LICENSE : 年額契約 月払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

契約更新時に設定するライセンス数 (年額契約)


maximum : 1000000 
maxMemberCount integer 

契約更新時設定する最大ユーザー数 (月額契約)


nullable : true 

Response Example

example

1{2  "type": "STAY",3  "productId": "STD",4  "plan": "MONTHLY",5  "maxMemberCount": 1006}