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

商品の更新設定を変更する。

  • フリープランまたはトライアル商品では、更新設定はできない。
  • 契約内容を同一に維持して更新 (STAY) する場合、現在と同じ商品と契約タイプ (plan) が維持される。
  • 契約内容を変更して更新 (CHANGE) する場合、更新時に商品 ID、契約タイプ (plan)、ライセンス数を変更することができる。

Authorization

oauth2

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

Scope

partner

HTTP Request

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

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 
subscriptionId string 

商品契約 ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
type string 

契約更新設定タイプ

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

required
Allowed values : STAY, CHANGE, CANCEL 
productId string 

有料商品 ID

  • LINE WORKSサービス

    • STD : スタンダードプラン
    • ADV : アドバンストプラン

  • LINE WORKSラジャーサービス

    • ROG_STD : スタンダードプラン
    • ROG_ADV : アドバンストプラン

  • LINE WORKS AiNoteサービス

    • NTA_SL : ソロプラン
    • NTA_TM : チームプラン
    • NTA_BZ : ビジネスプラン
    • NTA_EP : エンタープライズプラン

  • LINE WORKS PaperOnサービス

    • JP_PPO_LT : ライトプラン
    • JP_PPO_STD : スタンダードプラン
    • JP_PPO_ADV : アドバンストプラン

  • LINE WORKS AiStudioサービス

    • JP_AIS_STD : スタンダードプラン

Allowed values : STD, ADV, ROG_STD, ROG_ADV, NTA_SL, NTA_TM, NTA_BZ, NTA_EP, JP_PPO_LT, JP_PPO_STD, JP_PPO_ADV, JP_AIS_STD 
plan string 

有料プラン (契約タイプ)

  • MONTHLY : 月額契約 後払い
  • MONTHLY_LICENSE : 月額契約 後払い ライセンス
  • ANNUAL : 年額契約 月払い
  • ANNUAL_LICENSE : 年額契約 月払い ライセンス
  • ANNUAL_PREPAY : 年額契約 一括払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

商品グループ別の適用可能なプラン

  • LINE WORKSサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

  • LINE WORKSラジャーサービス

    • MONTHLY_LICENSE : 月額契約 後払い ライセンス
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

  • LINE WORKS AiNoteサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い

  • LINE WORKS PaperOnサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い

  • LINE WORKS AiStudioサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い

Allowed values : MONTHLY, MONTHLY_LICENSE, ANNUAL, ANNUAL_LICENSE, ANNUAL_PREPAY, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

更新時に変更するライセンス数

  • 契約タイプがライセンスの場合に指定する

maximum : 1000000 

Request Example

更新時に LINE WORKSスタンダードプランからアドバンストプランにアップグレードする (ドメインを使用している場合のみ可能)

1{2  "type": "CHANGE",3  "productId": "ADV"4}

月額契約 後払いで更新する

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

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

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

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

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

Response

HTTP 200

OK

PropertyTypeDescription
subscriptionId integer 

商品契約 ID


required 
type string 

契約更新設定タイプ

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

required
Allowed values : STAY, CHANGE, CANCEL 
productId string 

有料商品 ID

  • LINE WORKSサービス

    • STD : スタンダードプラン
    • ADV : アドバンストプラン

  • LINE WORKSラジャーサービス

    • ROG_STD : スタンダードプラン
    • ROG_ADV : アドバンストプラン

  • LINE WORKS AiNoteサービス

    • NTA_SL : ソロプラン
    • NTA_TM : チームプラン
    • NTA_BZ : ビジネスプラン
    • NTA_EP : エンタープライズプラン

  • LINE WORKS PaperOnサービス

    • JP_PPO_LT : ライトプラン
    • JP_PPO_STD : スタンダードプラン
    • JP_PPO_ADV : アドバンストプラン

  • LINE WORKS AiStudioサービス

    • JP_AIS_STD : スタンダードプラン

Allowed values : STD, ADV, ROG_STD, ROG_ADV, NTA_SL, NTA_TM, NTA_BZ, NTA_EP, JP_PPO_LT, JP_PPO_STD, JP_PPO_ADV, JP_AIS_STD 
plan string 

有料プラン (契約タイプ)

  • MONTHLY : 月額契約 後払い
  • MONTHLY_LICENSE : 月額契約 後払い ライセンス
  • ANNUAL : 年額契約 月払い
  • ANNUAL_LICENSE : 年額契約 月払い ライセンス
  • ANNUAL_PREPAY : 年額契約 一括払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

商品グループ別の適用可能なプラン

  • LINE WORKSサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

  • LINE WORKSラジャーサービス

    • MONTHLY_LICENSE : 月額契約 後払い ライセンス
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

  • LINE WORKS AiNoteサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い

  • LINE WORKS PaperOnサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い

  • LINE WORKS AiStudioサービス

    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い

Allowed values : MONTHLY, MONTHLY_LICENSE, ANNUAL, ANNUAL_LICENSE, ANNUAL_PREPAY, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

契約更新時に適用するライセンス数


maximum : 1000000 

Response Example

Example1

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