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자)을 Google에서 발행한 코드입니다. 할인 혜택을 받으려면 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 에포크 형식을 사용하는 밀리초 단위입니다. 에포크 변환기 예를 참고하세요.

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_PAYANNUAL_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

활성 상태인 구독을 정지합니다.