POST/partners/customers/{domainId}/subscriptions/{subscriptionId}/reservation

利用中の商品に予約設定を登録する。 商品に対して、有料転換 (START_PAID_SERVICE)、ライセンス追加 (type:ADD_LICENSE)、商品解約 (type:CANCEL) のうち、一つの予約のみ設定ができる。

  • 有料転換 (type:START_PAID_SERVICE) は、フリープランまたはトライアルプランで利用している商品にのみ予約が設定できる。
    • フリープランの商品を有料転換する場合には、有料転換する商品 ID (productId) と契約タイプ (plan) を指定する。
    • フリープラン以外の商品を有料転換する場合には、契約タイプ (plan) を指定する。商品 ID (productId) は指定しない。
    • LINE WORKS のフリープランまたはスタンダードプラントライアルからアドバンストプランへの有料転換を予約する場合、アップグレードドメインを先に登録してワークグループからドメインに変更する必要がある。
    • 商品の有料転換の際に、トライアル中のオプション商品に関する予約が設定されていない場合には、トライアル中のオプション商品も有料転換されます。
  • ライセンス追加 (type:ADD_LICENSE) は、商品の契約タイプ (plan) がライセンスの場合に予約できる。
  • 商品解約 (type:CANCEL) は、有料商品のみ解約設定の予約ができる。
    • 商品解約 (type:CANCEL) の場合、適用時にオプション商品の使用状況や解約予約設定にかかわらず、一緒に解約される。

Authorization

oauth2

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

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/subscriptions/{subscriptionId}/reservation

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 

商品契約予約タイプ

  • CANCEL : 商品解約
  • START_PAID_SERVICE : 有料転換
  • ADD_LICENSE : ライセンス追加

required
Allowed values : CANCEL, START_PAID_SERVICE, ADD_LICENSE 
applyDate string 

適用日

  • 有料転換 (type:START_PAID_SERVICE) の場合
    • フリープランから : 翌日から 60 日後まで
    • トライアルプランから : トライアル猶予期間終了日まで
  • ライセンス追加 (type:ADD_LICENSE) の場合
    • 翌日から契約終了日まで
  • 商品解約 (type:CANCEL) の場合
    • 翌日から契約終了日の翌日まで

required 
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 

ライセンス数

  • 有料転換 (type:START_PAID_SERVICE) の場合、設定するライセンス数
  • ライセンス追加 (type:ADD_LICENSE) の場合、追加するライセンス数

maximum : 1000000 
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 

Request Example

2021-11-01 にLINE WORKSフリープランからアドバンストプランの月額契約 後払いへの有料転換を予約する (ドメインを使用している場合のみ可能)

1{2  "type": "START_PAID_SERVICE",3  "applyDate": "2021-11-01",4  "plan": "MONTHLY",5  "productId": "ADV"6}

2021-08-11 にライセンス 100 個追加を予約する

1{2  "type": "ADD_LICENSE",3  "applyDate": "2021-08-11",4  "licenseCount": 1005}

2021-11-01 に利用中の商品を解約する

1{2  "type": "CANCEL",3  "applyDate": "2021-11-01"4}

Response

HTTP 201

OK

PropertyTypeDescription
subscriptionId integer 

商品契約 ID


required 
type string 

商品契約予約タイプ

  • CANCEL : 商品解約
  • START_PAID_SERVICE : 有料転換
  • ADD_LICENSE : ライセンス追加

required
Allowed values : CANCEL, START_PAID_SERVICE, ADD_LICENSE 
applyDate string 

適用日


required
format : date 
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 
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 
licenseCount integer 
  • 有料転換予約時 : 有料転換時に設定するライセンス数 (指定したライセンス数に 設定される)
  • ライセンス追加予約時 : 追加するライセンス数 (指定したライセンス数が 追加される)