PATCH/partners/customers/{domainId}/option-product-orders/{optionProductId}

オプション商品の予約設定を変更する。オプション商品の予約設定の種類 (type) に応じて設定項目を変更できる。

  • オプション商品の予約設定がある場合のみ変更できる。

  • 商品が年額契約の場合、解約したオプション商品の再申し込みは、翌月から可能になる。

  • 予約適用日の範囲 (applyDate)

    • 申込み予約の適用日 (type: APPLY)
      • 基本商品の申し込み予約 + オプション商品の申し込み予約 : 基本商品の申し込み予約と同日 (翌日から、31日後まで)
      • 基本商品の有料転換予約 + オプション商品の申し込み予約 : 基本商品がトライアル: 翌日から、トライアル猶予期間終了日、基本商品がフリープラン: 翌日から60日後まで
      • 基本商品を有料利用中 + オプション商品の申し込み予約 : 翌日から、基本商品の更新日 (planEndDate +1日) まで
    • 解約予約の適用日 (type: CANCEL)
      • 基本商品の有料転換予約 + オプション商品の解約予約 : 基本商品の予約日と同じ日付を指定する
      • 基本商品を有料利用中 + オプション商品の解約予約 : 翌日から、オプション商品の更新日 (planEndDate +1日) まで
    • 有料転換予約の適用日 (type: START_PAID_SERVICE)
      • 基本商品の有料転換予約 + トライアル中のオプション商品の有料転換 : 基本商品の予約日と同じ日付を指定する
      • 基本商品を有料利用中 + トライアル中のオプション商品の有料転換 : 翌日から、オプション商品のトライアル終了日の翌日まで (猶予はありません)
    • アップグレード予約の適用日 (type: MODIFY)
      • アップグレードの際、翌日から契約終了日の翌日まで適用日を指定可能。
    • 数量変更予約の適用日 (type:CHANGE_QUANTITY)
      • 適用日は翌月1日のみを指定可能。(ただし、翌月1日が契約期間に含まれている場合にのみ変更予約を設定できる)
      • 契約の最終月には予約を登録できない。

  • LINE WORKSサービス

    • アーカイブ(トーク)
      • スタンダード、スタンダードトライアル、アドバンスト、アドバンストトライアル プラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、トライアルの有料転換予約 (START_PAID_SERVICE) ができる。
    • アーカイブ(メール)
      • アドバンスト、アドバンストトライアル プラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、トライアルの有料転換予約 (START_PAID_SERVICE) ができる。
    • 追加ストレージ
      • スタンダード、アドバンスト プラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、アップグレード予約 (MODIFY) ができる。
    • Drive
      • スタンダード、スタンダードトライアル、アドバンスト、アドバンストトライアル プラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、トライアルの有料転換予約 (START_PAID_SERVICE)、アップグレード予約 (MODIFY) ができる。
    • アドレス帳登録数拡張
      • スタンダード、アドバンスト プラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、アップグレード予約 (MODIFY) ができる。
    • CXトーク
      • CXトーク 対応者5席の窓口/対応者30席の窓口/対応者100席の窓口 : スタンダード、スタンダードトライアル、アドバンスト、アドバンストトライアル プラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、有償転換予約 (START_PAID_SERVICE)、数量変更予約 (CHANGE_QUANTITY) ができる。

  • LINE WORKS AiNoteサービス

    • 追加文字起こし時間
      • 追加文字起こし時間 100分 (単月追加/毎月追加): ソロ/チーム/ビジネス/エンタープライズプラン で登録できる。
      • 追加文字起こし時間 6,000分 (単月追加/毎月追加): エンタープライズプラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、数量変更予約 (CHANGE_QUANTITY) ができる。
      • 適用 (購入) 時の注意点 (type:APPLY)
        • quantity は最大 999 まで可能である。
      • 数量変更時の注意事項 (type: CHANGE_QUANTITY)
        • 毎月追加オプションで、quantity は最大 999 まで指定可能である。

  • LINE WORKS PaperOnサービス

    • 読み取り回数追加
      • 読み取り回数追加 (単月追加/毎月追加): ライト/スタンダード/アドバンストプラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、数量変更予約 (CHANGE_QUANTITY) ができる。
      • 適用 (購入) 時の注意点 (type:APPLY)
        • quantity
          • 単月追加オプションは、最大 10 まで指定可能である。
          • 毎月追加オプションは、最大 20 まで指定可能である。
      • 数量変更時の注意事項 (type: CHANGE_QUANTITY)
        • 毎月追加オプションで、quantity は最大 20 まで指定可能である。

  • LINE WORKS AiStudioサービス

    • 追加トークン
      • 追加トークン (単月追加/毎月追加) : スタンダードプラン で登録できる。
      • 申し込み予約 (APPLY)、解約予約 (CANCEL)、数量変更予約 (CHANGE_QUANTITY) ができる。
      • 適用 (購入) 時の注意点 (type:APPLY)
        • quantity は最大 999 まで指定可能である。
      • 数量変更時の注意事項 (type: CHANGE_QUANTITY)
        • 毎月追加オプションで、quantity は最大 999 まで指定可能である。

Authorization

oauth2

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

Scope

partner

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/partners/customers/{domainId}/option-product-orders/{optionProductId}

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 
optionProductId string 

オプション商品 ID

  • ACV2 : アーカイブ (トーク)
  • ACV3 : アーカイブ (メール)
  • DRV : Drive
  • SSTG2 : 追加ストレージ
  • BCT : アドレス帳登録数拡張
  • CST_S/CST_M/CST_L : CXトーク
  • QTA_O1/QTA_M1/QTA_O2/QTA_M2 : AiNote 追加文字起こし時間
  • JP_PPO_O/JP_PPO_M : PaperOn 読み取り回数追加
  • JP_AIS_O/JP_AIS_M : AiStudio 追加トークン

required
Allowed values : ACV2, ACV3, SSTG2, DRV, BCT, CST_S, CST_M, CST_L, QTA_O1, QTA_O2, QTA_M1, QTA_M2, JP_PPO_O, JP_PPO_M, JP_AIS_O, JP_AIS_M 
optionProductId string 

オプション商品 ID

  • ACV2 : アーカイブ (トーク)
  • ACV3 : アーカイブ (メール)
  • DRV : Drive
  • SSTG2 : 追加ストレージ
  • BCT : アドレス帳登録数拡張
  • CST_S/CST_M/CST_L : CXトーク
  • QTA_O1/QTA_M1/QTA_O2/QTA_M2 : AiNote 追加文字起こし時間
  • JP_PPO_O/JP_PPO_M : PaperOn 読み取り回数追加
  • JP_AIS_O/JP_AIS_M : AiStudio 追加トークン

required
Allowed values : ACV2, ACV3, SSTG2, DRV, BCT, CST_S, CST_M, CST_L, QTA_O1, QTA_O2, QTA_M1, QTA_M2, JP_PPO_O, JP_PPO_M, JP_AIS_O, JP_AIS_M 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
subOptionId string 

サブオプション商品 ID

  • LINE WORKSサービスのオプション商品

    • オプション商品 ID が ACV2 の場合
      • ACV200 : アーカイブ (トーク) Trial
      • ACV201 : アーカイブ (トーク)
    • オプション商品 ID が ACV3 の場合
      • ACV300 : アーカイブ (メール) Trial
      • ACV301 : アーカイブ (メール)
    • オプション商品 ID が DRV の場合
      • DRV00: Drive Trial (for STD)
      • DRV01: Drive (for STD)
      • DRV_PS_T: Drive Plus Trial (for STD)
      • DRV_PS: Drive Plus (for STD)
      • DRV_PA_T: Drive Plus Trial (for ADV)
      • DRV_PA: Drive Plus (for ADV)
    • オプション商品 ID が SSTG2 の場合
      • SSTG201 : 追加ストレージ (1TB)
      • SSTG202 : 追加ストレージ (5TB)
      • SSTG203 : 追加ストレージ (10TB)
      • SSTG204 : 追加ストレージ (25TB)
      • SSTG205 : 追加ストレージ (50TB)
      • SSTG206 : 追加ストレージ (100TB)
      • SSTG207 : 追加ストレージ (500TB)
    • オプション商品 ID が BCT の場合
      • BCT01 : アドレス帳登録数拡張 (25 万件まで)
      • BCT02 : アドレス帳登録数拡張 (50 万件まで)
      • BCT03 : アドレス帳登録数拡張 (150 万件まで)
      • BCT04 : アドレス帳登録数拡張 (500 万件まで)
    • オプション商品 ID が CST_S の場合
      • CST_S00 : CXトーク 対応者5席の窓口 Trial
      • CST_S01 : CXトーク 対応者5席の窓口
    • オプション商品 ID が CST_M の場合
      • CST_M00 : CXトーク 対応者30席の窓口 Trial
      • CST_M01 : CXトーク 対応者30席の窓口
    • オプション商品 ID が CST_L の場合
      • CST_L00 : CXトーク 対応者100席の窓口 Trial
      • CST_L01 : CXトーク 対応者100席の窓口

  • LINE WORKS AiNoteサービスのオプション商品

    • オプション商品 ID が QTA_O1 の場合
      • QTA_O101 : 追加文字起こし時間 100分(単月追加)
    • オプション商品 ID が QTA_O2 の場合
      • QTA_O201 : 追加文字起こし時間 6,000分(単月追加)
    • オプション商品 ID が QTA_M1 の場合
      • QTA_M101 : 追加文字起こし時間 100分(毎月追加)
    • オプション商品 ID が QTA_M2 の場合
      • QTA_M201 : 追加文字起こし時間 6,000分(毎月追加)

  • LINE WORKS PaperOnサービスのオプション商品

    • オプション商品 ID が JP_PPO_O の場合
      • JP_PPO_O01 : 読み取り回数追加(単月追加)
    • オプション商品 ID が JP_PPO_M の場合
      • JP_PPO_M01 : 読み取り回数追加(毎月追加)

  • LINE WORKS AiStudioサービスのオプション商品

    • オプション商品 ID が JP_AIS_O の場合
      • JP_AIS_O01 : 追加トークン(単月追加)
    • オプション商品 ID が JP_AIS_M の場合
      • JP_AIS_M01 : 追加トークン(毎月追加)

Allowed values : ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01, QTA_O101, QTA_O201, QTA_M101, QTA_M201, JP_PPO_O01, JP_PPO_M01, JP_AIS_O01, JP_AIS_M01 
quantity integer 

購入数量。
数量型オプション商品の場合に指定。商品により購入できる最大数は異なる。

  • CXトーク : CST_* 50
  • AiNote : QTA_* 999
  • PaperOn : JP_PPO_O 10
  • PaperOn : JP_PPO_M 20
  • AiStudio : JP_AIS_* 999
 
applyDate string 

適用日


required
example : 2021-11-01 

Request Example

Drive の適用日を 2021-11-01 に変更する

1{2  "applyDate": "2021-11-01"3}

Response

HTTP 200

OK

PropertyTypeDescription
subscriptionId integer 

商品契約 ID

  • 商品の申し込み予約後に、オプション商品の申し込み予約をした場合には null
  • 利用中の商品に対するオプション商品の予約の場合には、当該の商品契約の商品契約 ID (subscriptionId)
 
optionProductId string 

オプション商品 ID

  • LINE WORKSサービスのオプション商品
    • ACV2 : アーカイブ(トーク)
    • ACV3 : アーカイブ(メール)
    • DRV : Drive
    • SSTG2 : 追加ストレージ
    • BCT : アドレス帳登録数拡張
    • CST_S : CXトーク 対応者5席の窓口
    • CST_M : CXトーク 対応者30席の窓口
    • CST_L : CXトーク 対応者100席の窓口
  • LINE WORKS AiNoteサービスのオプション商品
    • QTA_O1 : 追加文字起こし時間 100分(単月追加)
    • QTA_O2 : 追加文字起こし時間 6,000分(単月追加)
    • QTA_M1 : 追加文字起こし時間 100分(毎月追加)
    • QTA_M2 : 追加文字起こし時間 6,000分(毎月追加)
  • LINE WORKS PaperOnサービスのオプション商品
    • JP_PPO_O : 読み取り回数追加(単月追加)
    • JP_PPO_M : 読み取り回数追加(毎月追加)
  • LINE WORKS AiStudioサービスのオプション商品
    • JP_AIS_O : 追加トークン(単月追加)
    • JP_AIS_M : 追加トークン(毎月追加)

required
Allowed values : ACV2, ACV3, DRV, SSTG2, BCT, CST_S, CST_M, CST_L, QTA_O1, QTA_O2, QTA_M1, QTA_M2, JP_PPO_O, JP_PPO_M, JP_AIS_O, JP_AIS_M 
subOptionId string 

サブオプション商品 ID

  • LINE WORKSサービスのオプション商品

    • オプション商品 ID が ACV2 の場合
      • ACV200 : アーカイブ (トーク) Trial
      • ACV201 : アーカイブ (トーク)
    • オプション商品 ID が ACV3 の場合
      • ACV300 : アーカイブ (メール) Trial
      • ACV301 : アーカイブ (メール)
    • オプション商品 ID が DRV の場合
      • DRV00: Drive Trial (for STD)
      • DRV01: Drive (for STD)
      • DRV_PS_T: Drive Plus Trial (for STD)
      • DRV_PS: Drive Plus (for STD)
      • DRV_PA_T: Drive Plus Trial (for ADV)
      • DRV_PA: Drive Plus (for ADV)
    • オプション商品 ID が SSTG2 の場合
      • SSTG201 : 追加ストレージ (1TB)
      • SSTG202 : 追加ストレージ (5TB)
      • SSTG203 : 追加ストレージ (10TB)
      • SSTG204 : 追加ストレージ (25TB)
      • SSTG205 : 追加ストレージ (50TB)
      • SSTG206 : 追加ストレージ (100TB)
      • SSTG207 : 追加ストレージ (500TB)
    • オプション商品 ID が BCT の場合
      • BCT01 : アドレス帳登録数拡張 (25 万件まで)
      • BCT02 : アドレス帳登録数拡張 (50 万件まで)
      • BCT03 : アドレス帳登録数拡張 (150 万件まで)
      • BCT04 : アドレス帳登録数拡張 (500 万件まで)
    • オプション商品 ID が CST_S の場合
      • CST_S00 : CXトーク 対応者5席の窓口 Trial
      • CST_S01 : CXトーク 対応者5席の窓口
    • オプション商品 ID が CST_M の場合
      • CST_M00 : CXトーク 対応者30席の窓口 Trial
      • CST_M01 : CXトーク 対応者30席の窓口
    • オプション商品 ID が CST_L の場合
      • CST_L00 : CXトーク 対応者100席の窓口 Trial
      • CST_L01 : CXトーク 対応者100席の窓口

  • LINE WORKS AiNoteサービスのオプション商品

    • オプション商品 ID が QTA_O1 の場合
      • QTA_O101 : 追加文字起こし時間 100分(単月追加)
    • オプション商品 ID が QTA_O2 の場合
      • QTA_O201 : 追加文字起こし時間 6,000分(単月追加)
    • オプション商品 ID が QTA_M1 の場合
      • QTA_M101 : 追加文字起こし時間 100分(毎月追加)
    • オプション商品 ID が QTA_M2 の場合
      • QTA_M201 : 追加文字起こし時間 6,000分(毎月追加)

  • LINE WORKS PaperOnサービスのオプション商品

    • オプション商品 ID が JP_PPO_O の場合
      • JP_PPO_O01 : 読み取り回数追加(単月追加)
    • オプション商品 ID が JP_PPO_M の場合
      • JP_PPO_M01 : 読み取り回数追加(毎月追加)

  • LINE WORKS AiStudioサービスのオプション商品

    • オプション商品 ID が JP_AIS_O の場合
      • JP_AIS_O01 : 追加トークン(単月追加)
    • オプション商品 ID が JP_AIS_M の場合
      • JP_AIS_M01 : 追加トークン(毎月追加)

required
Allowed values : ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01, QTA_O101, QTA_O201, QTA_M101, QTA_M201, JP_PPO_O01, JP_PPO_M01, JP_AIS_O01, JP_AIS_M01 
type string 

オプション商品の予約タイプ

  • APPLY : オプション商品の申し込み予約
  • START_PAID_SERVICE : オプション商品の有料転換予約
  • CHANGE_QUANTITY : オプション商品の数量変更
  • CANCEL : オプション商品の解約予約

required
Allowed values : APPLY, START_PAID_SERVICE, CHANGE_QUANTITY, CANCEL 
quantity integer 

契約数

  • optionProductId が SSTG2、BCT の場合には 1
  • optionProductId が 以下の数量追加型の商品では使用数
    • LINE WORKSサービス
      • CXトーク : CST_S、CST_M、CST_L
    • AiNoteサービス
      • 追加文字起こし時間 : QTA_O1、QTA_O2、QTA_M1、QTA_M2
    • PaperOnサービス
      • 読み取り回数追加 : JP_PPO_O、JP_PPO_M
    • AiStudioサービス
      • 追加トークン : JP_AIS_O, JP_AIS_M
  • その他は null

readOnly : true
nullable : true 
applyDate string 

適用日


required
format : date 

Response Example

Example 1

1{2  "subscriptionId": 0,3  "optionProductId": "ACV2",4  "subOptionId": "ACV201",5  "type": "APPLY",6  "quantity": null,7  "applyDate": "2019-08-24"8}