GET/partners/customers/{domainId}/subscriptions/{subscriptionId}

契約している商品の情報を取得する。

Authorization

oauth2

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

Scope

partner
partner.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 
subscriptionId string 

商品契約 ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

ドメイン ID


required
readOnly : true 
subscriptionId integer 

商品契約 ID


required 
productId string 

  • LINE WORKSサービス

    • FR : フリープラン
    • STD_T : スタンダードプラントライアル
    • ADV_T : アドバンストプラントライアル
    • STD : スタンダードプラン
    • ADV : アドバンストプラン

  • LINE WORKSラジャーサービス

    • ROG_FR : フリープラン
    • ROG_STD_T : スタンダードプラントライアル
    • ROG_ADV_T : アドバンストプラントライアル
    • ROG_STD : スタンダードプラン
    • ROG_ADV : アドバンストプラン

  • LINE WORKS AiNoteサービス

    • NTA_FR : フリープラン
    • NTA_SL_T : ソロプラントライアル
    • NTA_TM_T : チームプラントライアル
    • NTA_BZ_T : ビジネスプラントライアル
    • NTA_EP_T : エンタープライズプラントライアル
    • NTA_SL : ソロプラン
    • NTA_TM : チームプラン
    • NTA_BZ : ビジネスプラン
    • NTA_EP : エンタープライズプラン

  • LINE WORKS PaperOnサービス

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

  • LINE WORKS AiStudioサービス

    • JP_AIS_STD : スタンダードプラン
    • JP_AIS_STD_T : スタンダードプラントライアル

required
Allowed values : FR, STD_T, ADV_T, STD, ADV, ROG_FR, ROG_STD_T, ROG_ADV_T, ROG_STD, ROG_ADV, NTA_FR, NTA_SL_T, NTA_TM_T, NTA_BZ_T, NTA_EP_T, NTA_SL, NTA_TM, NTA_BZ, NTA_EP, JP_PPO_LT_T, JP_PPO_STD_T, JP_PPO_ADV_T, JP_PPO_LT, JP_PPO_STD, JP_PPO_ADV, JP_AIS_STD_T, JP_AIS_STD 
plan string 

プラン (契約タイプ)

  • FREE : フリー
  • FREE_LICENSE : フリー ライセンス
  • TRIAL : トライアル
  • TRIAL_LICENSE : トライアル ライセンス
  • MONTHLY : 月額契約 後払い
  • MONTHLY_LICENSE : 月額契約 後払い ライセンス
  • ANNUAL : 年額契約 月払い
  • ANNUAL_LICENSE : 年額契約 月払い ライセンス
  • ANNUAL_PREPAY : 年額契約 一括払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

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

  • LINE WORKSサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKSラジャーサービス
    • FREE_LICENSE : フリー ライセンス
    • TRIAL_LICENSE : トライアル ライセンス
    • MONTHLY_LICENSE : 月額契約 後払い ライセンス
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKS AiNoteサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS PaperOnサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS AiStudioサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い

required
Allowed values : FREE, TRIAL, MONTHLY, ANNUAL, ANNUAL_PREPAY, FREE_LICENSE, TRIAL_LICENSE, MONTHLY_LICENSE, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
planStartDate string 

プラン開始日


required
format : date
readOnly : true 
planEndDate string 

プラン終了日

  • 有料プラン の場合はプラン終了日
  • トライアルプラン の場合はトライアル期間終了日
  • フリープラン の場合は null

format : date
readOnly : true
nullable : true 
licenseAssignType string 

ライセンスの割り当て方法

  • NONE: ライセンス割り当て方法なし
    • LINE WORKSラジャー以外のすべての基本商品では NONE
  • AUTO: 自動割り当て
  • MANUAL: メンバーを選択

商品グループ毎の設定可能なライセンスの割り当て方法
LINE WORKSラジャー

  • AUTO: 自動割り当て
  • MANUAL: メンバーを選択

Allowed values : NONE, AUTO, MANUAL 
licenseCount integer 

ライセンス数


nullable : true 
status string 

商品契約状態

  • ACTIVE : 正常
  • SUSPENDED_TRIALEND : 停止 (トライアル終了による停止)

required
Allowed values : ACTIVE, SUSPENDED_TRIALEND 
renewal object (renewal) 

有料商品の更新を設定するモデル。 type プロパティで、現在と同じ条件で更新するか、契約内容を変更するかを選択可能。 更新時にライセンスを減らすことも可能。

  • フリープラン、トライアル商品 では null
 

renewal

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

example

1{2  "domainId": 10000001,3  "subscriptionId": 12345,4  "productId": "STD",5  "plan": "MONTHLY",6  "planStartDate": "2021-11-01",7  "planEndDate": "2021-11-30",8  "memberCount": 100,9  "maxMemberCount": 100,10  "optionPlus": true,11  "status": "ACTIVE",12  "renewal": {13    "subscriptionId": 12345,14    "type": "STAY",15    "productId": "STD",16    "plan": "MONTHLY",17    "maxMemberCount": 10018  }19}