REST Resource: subscriptions

리소스: 구독

구독의 JSON 템플릿입니다.

JSON 표현 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
필드
customerId

string

이 속성은 항상 Google에서 생성한 고유 식별자로 응답에 반환됩니다. 요청에서 이 속성은 기본 도메인 또는 Google에서 생성한 고유 식별자일 수 있습니다.
subscriptionId

string

subscriptionId는 정기 결제 식별자이며 고객마다 고유합니다. 필수 속성입니다. 정기 결제가 업데이트될 때 subscriptionId가 변경되므로 이 ID를 영구 데이터의 키로 사용하지 않는 것이 좋습니다. 모든 리셀러 구독 검색에 설명된 대로 subscriptionId를 사용합니다.
skuId

string

필수 속성입니다. skuId는 정기 결제에서 고객에게 할당된 제품 SKU의 고유한 시스템 식별자입니다. 이 버전의 API에서 사용할 수 있는 제품 및 SKU는 제품 및 SKU ID를 참고하세요.
creationTime

string (int64 format)

creationTime 속성은 구독이 생성된 날짜입니다. 에포크 형식을 사용하여 밀리초로 표시됩니다. 에포크 변환기 예시를 참고하세요.
kind

string

리소스를 구독으로 식별합니다. 값: reseller#subscription
seats

object (Seats)

필수 속성입니다. 요금제의 사용자 라이선스 수 및 한도입니다.
renewalSettings

object (RenewalSettings)

연간 약정 요금제의 갱신 설정입니다. 자세한 내용은 관리자 고객센터의 갱신 옵션을 참고하세요.
purchaseOrderId

string

이 속성은 선택사항입니다. 이 구매주문서 (PO) 정보는 리셀러가 회사의 사용 추적에 사용할 수 있습니다. purchaseOrderId 값이 지정되면 API 응답에 표시되고 인보이스에 표시됩니다. 이 속성은 최대 80자(영문 기준)의 일반 텍스트 문자를 허용합니다.
status

string

이 속성은 선택사항입니다.
resourceUiUrl

string

관리 콘솔의 고객 구독 페이지로 연결되는 URL입니다. 읽기 전용 URL은 API 서비스에서 생성합니다. 클라이언트 애플리케이션에서 고객이 관리 콘솔의 '구독' 페이지를 사용하여 작업을 완료해야 하는 경우에 사용됩니다.
billingMethod

string

정기 결제의 현재 결제 수단을 반환하는 읽기 전용 필드입니다.
suspensionReasons[]

string

구독의 현재 모든 정지 사유를 열거하는 값을 포함하는 읽기 전용 필드입니다. 정기 결제에 여러 개의 중복된 정지 사유가 동시에 적용될 수 있습니다. 대기 중인 정지가 모두 삭제될 때까지 정기 결제의 STATUS는 SUSPENDED입니다.

가능한 옵션은 다음과 같습니다.

  • PENDING_TOS_ACCEPTANCE - 고객이 로그인하여 G Suite 재판매 서비스 약관에 동의하지 않았습니다.
  • RENEWAL_WITH_TYPE_CANCEL - 고객의 약정이 종료되고 기간이 종료되면 서비스가 취소되었습니다.
  • RESELLER_INITIATED - 리셀러가 호출한 수동 정지입니다.
  • TRIAL_ENDED - 고객이 요금제를 선택하지 않은 상태에서 무료 체험이 만료되었습니다.
  • OTHER - Google 내부 사유 (예: 악용 등)로 인해 고객이 정지되었습니다.

customerDomain

string

고객의 기본 도메인 이름
dealCode

string

정기 결제 요금제의 할인 가격에 적용되는 Google에서 발급한 코드 (최대 100자)입니다. 할인 요금을 받으려면 insert 요청에 특가 코드를 포함해야 합니다. 이 속성은 선택사항이며 비워두면 일반 가격이 적용됩니다.
skuName

string

정기 결제에서 고객에게 할당된 제품 SKU의 읽기 전용 외부 표시 이름입니다. SKU 이름은 Google의 재량에 따라 변경될 수 있습니다. 이 버전의 API에서 사용할 수 있는 제품 및 SKU는 제품 및 SKU ID를 참고하세요.
plan

object

plan 속성은 필수입니다. 이 버전의 API에서 G Suite 요금제는 탄력 요금제, 연간 약정 요금제, 30일 무료 체험 요금제입니다. API의 요금제에 관한 자세한 내용은 API 개념을 참고하세요.
plan.planName

string

planName 속성은 필수입니다. 구독 요금제의 이름입니다. Google 요금제에 대한 자세한 내용은 API 개념을 참고하세요.

가능한 값은 다음과 같습니다.

  • ANNUAL_MONTHLY_PAY: 월별 결제 방식의 연간 약정 요금제입니다.
  • ANNUAL_YEARLY_PAY: 연간 결제 약정 요금제
  • FLEXIBLE: 탄력 요금제
  • TRIAL: 30일 무료 체험판 요금제입니다. 요금제가 할당되지 않은 경우 무료 체험 중인 구독은 30일 무료 체험이 종료된 후 정지됩니다. changePlan를 호출하면 무료 체험에 요금제가 할당되지만 요금제가 활성화되지는 않습니다. 무료 체험 기간 30일이 지나거나 startPaidService를 호출한 직후 무료 체험에 할당된 요금제가 자동으로 시작됩니다.
  • FREE: 무료 요금제는 Cloud ID SKU 전용이며 요금이 청구되지 않습니다.

plan.isCommitmentPlan

boolean

isCommitmentPlan 속성의 불리언 값은 요금제를 연간 약정 요금제로 식별합니다.

  • true: 구독 요금제가 연간 약정 요금제입니다.
  • false: 연간 약정 요금제가 아닙니다.
plan.commitmentInterval

object

이 버전의 API에서 연간 약정 요금제의 간격은 1년입니다.

plan.commitmentInterval.startTime

string (int64 format)

UNIX 에포크 형식을 사용한 연간 약정 요금제의 간격 startTime(밀리초)입니다. 에포크 변환기 예시를 참고하세요.
plan.commitmentInterval.endTime

string (int64 format)

UNIX 에포크 형식을 사용하여 연간 약정 요금제의 간격 endTime(밀리초)입니다. 에포크 변환기 예시를 참고하세요.
trialSettings

object

G Suite 연간 약정 요금제 및 탄력 요금제는 30일 무료 체험판으로 제공됩니다. 자세한 내용은 API 개념을 참고하세요.
trialSettings.isInTrial

boolean

구독 요금제가 30일 무료 체험 중인지 여부를 확인합니다.

  • true - 요금제가 체험 중입니다.
  • false: 요금제가 체험판이 아닙니다.
trialSettings.trialEndTime

string (int64 format)

무료 체험이 종료되는 날짜입니다. 값의 단위는 UNIX epoch 형식의 밀리초입니다. 에포크 변환기 예시를 참고하세요.
transferInfo

object

정기 결제의 읽기 전용 이전 관련 정보입니다. 자세한 내용은 고객의 이전 가능한 정기 결제 검색하기를 참고하세요.
transferInfo.transferabilityExpirationTime

string (int64 format)

이전 토큰 또는 이전 인텐트가 만료되는 시간입니다. 시간은 UNIX 에포크 형식을 사용하여 밀리초로 표시됩니다.
transferInfo.minimumTransferableSeats

integer

정기 결제를 삽입할 때 이 제품의 이전 주문에 명시된 최소 좌석 수입니다. 예를 들어 고객의 사용자가 20명인 경우 리셀러는 15자리의 이전 주문을 처리할 수 없습니다. 최소 좌석 수는 20개입니다.
transferInfo.currentLegacySkuId

string

현재 재판매된 정기 결제의 skuId입니다. 이 필드는 고객에게 기존 SKU가 포함된 정기 결제가 있고 정기 결제 리소스에 이전에 권장되는 SKU의 skuId가 채워진 경우에만 채워집니다.

좌석

정기 결제 좌석의 JSON 템플릿입니다.

JSON 표현 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
필드
numberOfSeats

integer

이 속성은 필수 속성이며 ANNUAL_MONTHLY_PAY 및 ANNUAL_YEARLY_PAY 요금제가 포함된 구독에만 사용할 수 있습니다. 이 속성은 구독에서 사용자에게 할당할 수 있는 최대 라이선스 수를 설정합니다. 리셀러는 라이선스를 더 추가할 수 있지만 일단 설정하면 갱신 전에는 numberOfSeats를 줄일 수 없습니다. 리셀러에게는 할당된 사용자 라이선스 수와 관계없이 numberOfSeats 값을 기준으로 인보이스가 발행됩니다.

maximumNumberOfSeats

integer

이 속성은 필수 속성이며 FLEXIBLE 또는 TRIAL 요금제를 사용하는 구독에만 적용됩니다. 이 속성은 구독에 허용되는 라이선스 사용자의 최대 수를 설정합니다. 이 수량은 리셀러 계약에 정의된 최대 한도까지 늘릴 수 있습니다. 최소 수량은 고객 계정의 현재 사용자 수입니다.

licensedNumberOfSeats

integer

skuId에 정의된 제품의 라이선스가 할당된 현재 사용자 수를 포함하는 읽기 전용 필드입니다. 이 필드의 값은 Enterprise License Manager API 메서드 listForProductAndSku에서 반환된 사용자 숫자와 같습니다.
kind

string

리소스를 구독 자리 설정으로 식별합니다. 값: subscriptions#seats

RenewalSettings

구독 갱신 설정의 JSON 템플릿입니다.

JSON 표현 
{
  "renewalType": string,
  "kind": string
}
필드
renewalType

string

연간 약정 요금제의 갱신 설정입니다. 자세한 내용은 관리자 고객센터의 갱신 옵션을 참고하세요. 구독을 갱신할 때 renewalType는 필수 속성입니다.
kind

string

리소스를 구독 갱신 설정으로 식별합니다. 값: subscriptions#renewalSettings

메서드

activate

 이전에 리셀러가 정지한 구독을 활성화합니다.

changePlan

 정기 결제 요금제를 업데이트합니다.

changeRenewalSettings

 사용자 라이선스의 갱신 설정을 업데이트합니다.

changeSeats

 구독의 사용자 라이선스 설정을 업데이트합니다.

delete

 정기 결제를 취소, 정지 또는 트랜스퍼합니다.

get

 특정 구독을 가져옵니다.

insert

 구독을 만들거나 이전합니다.

list

 리셀러가 관리하는 구독 목록입니다.

startPaidService

 30일 무료 체험 구독을 유료 서비스 구독으로 즉시 전환합니다.

suspend

 활성 상태의 정기 결제를 정지합니다.