고객사 계약 조회

GET/partners/customers/{domainId}/subscription

고객사의 계약 정보를 조회한다.

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

partner
partner.read

HTTP Request

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

Path Parameters

Parameter	Type	Description
domainId	integer	고객사 도메인 ID required

Header Parameters

Header	type	Description
Authorization	string	Bearer {token} required

Response

HTTP 200

Subscription Response

Property	Type	Description
domainId	integer	도메인 ID readOnly : true
productId	string	FR: Free LT_T: Lite Trial BS_T: Basic Trial PRM_T: Premium Trial LT: Lite BS: Basic PRM: Premium Allowed values : FR, LT_T, BS_T, PRM_T, LT, BS, PRM
plan	string	FREE: 무료 요금제 TRIAL: Trial 요금제 MONTHLY: 월간 계약 구성원 요금제 ANNUAL: 연간 계약 구성원 요금제 Allowed values : FREE, TRIAL, MONTHLY, ANNUAL
planStartDate	string	요금제 시작일(yyyy-MM-dd) readOnly : true
planEndDate	string	요금제 종료일(yyyy-MM-dd) - 유료 상품인 경우 요금제 종료일 - Trial 상품인 경우 Trial 기간 종료일 - Free 상품인 경우 null readOnly : true
licenseCount	integer	라이선스 수 - 한국환경에서 사용하지 않음.
memberCount	integer	현재 구성원 수 readOnly : true
maxMemberCount	integer	최대 구성원 수
optionPlus	boolean	옵션 플러스 사용 여부 - 한국환경에서 사용하지 않음.
status	string	ACTIVE: 정상 UPGRADING: 업그레이드 중 SUSPENDED_TRIALEND: 정지(Trial 종료로 인한 정지) SUSPENDEE_ADMIN: 정지(관리자에 의한 정지) Allowed values : ACTIVE, UPGRADING, SUSPENDED_TRIALEND, SUSPENDED_ADMIN
renewal	object (renewal)	고객사의 현재 계약 종료 후 다음 계약의 설정을 표현하는 리소스. type 속성을 이용해 현재 계약과 동일한 계약으로 갱신하거나 변경된 계약으로 갱신할 수 있다. 갱신 시 상품을 업그레이드하거나 요금제를 변경할 수 있다. 현재 계약에서는 라이선스 수를 늘릴 수만 있으나 갱신 시에는 줄일 수도 있다.
reservation	object (reservation)	고객사의 예약 설정을 관리하는 리소스. 예약 설정에는 유료 전환, 탈퇴 등이 있으며 계획된 날짜에 설정된 액션이 수행된다. 유료 전환과 탈퇴는 익일부터 계약 종료일 익일까지 적용일을 지정할 수 있으며, 최대 구성원 수 설정은 익일부터 계약 종료일까지 적용일을 지정할 수 있다.

renewal

Property	Type	Description
type	string	STAY: 현재 계약과 동일하게 갱신 CHANGE: 갱신 시 계약 변경(상품, 요금제, 최대 구성원 수) Allowed values : STAY, CHANGE
productId	string	FR: Free LT_T: Lite Trial BS_T: Basic Trial PRM_T: Premium Trial LT: Lite BS: Basic PRM: Premium Allowed values : FR, LT_T, BS_T, PRM_T, LT, BS, PRM
domain	string	갱신 시 설정할 도메인
plan	string	FREE: 무료 요금제 TRIAL: Trial 요금제 MONTHLY: 월간 계약 구성원 요금제 ANNUAL: 연간 계약 구성원 요금제 Allowed values : FREE, TRIAL, MONTHLY, ANNUAL
licenseCount	integer	갱신 시 설정할 라이선스 수 - 한국환경에서 사용하지 않음.
maxMemberCount	integer	갱신 시 설정할 최대 구성원 수

reservation

Property	Type	Description
type	string	DELETE: 탈퇴 START_PAID_SERVICE: 유료 전환 SET_MAX_USER: 최대 구성원 수 설정 Allowed values : DELETE, START_PAID_SERVICE, SET_MAX_USER
applyDate	string	예약 적용일(yyyy-MM-dd)
plan	string	FREE: 무료 요금제 TRIAL: Trial 요금제 MONTHLY: 월간 계약 구성원 요금제 ANNUAL: 연간 계약 구성원 요금제 Allowed values : FREE, TRIAL, MONTHLY, ANNUAL
licenseCount	integer	예약 적용 시 설정할 라이선스 수 - 한국환경에서 사용하지 않음.
maxMemberCount	integer	예약 적용 시 설정할 최대 구성원 수
productId	string	FR: Free LT_T: Lite Trial BS_T: Basic Trial PRM_T: Premium Trial LT: Lite BS: Basic PRM: Premium Allowed values : FR, LT_T, BS_T, PRM_T, LT, BS, PRM
domain	string	예약 적용 시 설정할 도메인 example : example.com