REST Resource: purchases.subscriptions

리소스: SubscriptionPurchase

SubscriptionPurchase 리소스는 사용자의 정기 결제 구매 상태를 나타냅니다.

JSON 표현 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
필드
kind

string

이 종류는 androidpublisher 서비스의 subscriptionPurchase 객체를 나타냅니다.
startTimeMillis

string (int64 format)

정기 결제가 승인된 시간입니다(단위: 에포크 이후 경과된 밀리초).
expiryTimeMillis

string (int64 format)

정기 결제가 만료될 시간입니다(단위: 에포크 이후 경과된 밀리초).
autoResumeTimeMillis

string (int64 format)

정기 결제가 자동으로 갱신될 시간입니다(단위: 에포크 이후 경과된 밀리초). 사용자가 정기 결제 일시중지를 요청한 경우에만 값이 있습니다.
autoRenewing

boolean

정기 결제가 기존 만료 시간에 도달했을 때 자동으로 갱신될지 여부입니다.
priceCurrencyCode

string

정기 결제 가격의 ISO 4217 통화 코드입니다. 예를 들어 가격이 영국 파운드로 지정된 경우 priceCurrencyCode는 'GBP'입니다.
priceAmountMicros

string (int64 format)

정기 결제의 가격입니다. 세금 미포함 가격을 적용하는 국가에서는 이 가격이 세금을 포함하지 않습니다. 세금 포함 가격을 적용하는 국가에서는 이 가격이 세금을 포함합니다. 마이크로 단위로 표현된 가격입니다. 여기서 1,000,000 마이크로 단위는 해당 통화의 1개 단위를 나타냅니다. 예를 들어 정기 결제 가격이 €1.99인 경우 priceAmountMicros는 1990000입니다.
introductoryPriceInfo

object (IntroductoryPriceInfo)

정기 결제의 신규 할인 가격 정보입니다. 정기 결제가 신규 할인 가격으로 구매된 경우에만 값이 있습니다.

이 필드는 정기 결제가 현재 신규 할인 가격 기간 내에 있는지 여부를 나타내지 않습니다.
countryCode

string

정기 결제가 승인된 시점에 사용자의 ISO 3166-1 alpha-2 청구서 수신 국가/지역 코드입니다.
developerPayload

string

주문의 추가 정보가 포함된 개발자 지정 문자열입니다.
paymentState

integer

정기 결제의 결제 상태입니다. 가능한 값은 0입니다. 0(결제 대기 중), 1(결제 수신), 2(무료 체험), 3(업그레이드/다운그레이드 지연 중)입니다.

정기 결제가 취소 및 만료된 경우에는 값이 없습니다.
cancelReason

integer

정기 결제가 취소되었거나 자동 갱신되지 않는 이유입니다. 가능한 값은 0입니다. 0(사용자가 정기 결제 취소), 1(시스템이 정기 결제 취소 - 예: 결제 문제로 인해), 2(새 정기 결제로 교체됨), 3(개발자가 정기 결제 취소)입니다.
userCancellationTimeMillis

string (int64 format)

정기 결제가 사용자에 의해 취소된 시간입니다(단위: 에포크 이후 경과된 밀리초). cancelReason이 0인 경우에만 값이 있습니다.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

사용자가 정기 결제 취소 흐름 (취소 사유 설문조사)을 완료할 때 제공하는 정보입니다.
orderId

string

정기 결제 구매와 관련된 가장 최근 반복 주문의 주문 ID입니다. 결제가 거부되어 정기 결제가 취소된 경우, 결제가 거부된 주문의 주문 ID입니다.
linkedPurchaseToken

string

이 정기 결제가 다음 중 하나인 경우 원래 구매의 구매 토큰입니다. 0. 0(취소되었으나 만료되지 않은 구독의 재가입), 이전 정기 결제의 업그레이드/다운그레이드

예를 들어 사용자가 정기 결제에 가입한 결과로 개발자가 구매 토큰 X를 받았고 이후 (정기 결제가 만료되기 전에) 사용자가 취소한 다음 재가입 절차를 진행한 결과로 개발자가 토큰 Y를 받았고, 이후 사용자가 정기 결제를 업그레이드한 결과로 개발자가 구매 토큰 Z를 받았다면 구매 토큰 Z를 사용하여 이 API를 호출하면 이 필드는 Y로 설정됩니다. 구매 토큰 Y를 사용하여 이 API를 호출하면 이 필드는 X로 설정되고, 구매 토큰 X를 사용하여 이 API를 호출하면 이 필드는 설정되지 않습니다.
purchaseType

integer

정기 결제의 구매 유형입니다. 이 필드는 이 구매가 표준 인앱 결제 절차를 사용하여 이루어지지 않은 경우에만 설정됩니다. 가능한 값은 0입니다. 테스트 (예: 라이선스 테스트 계정으로 구매됨) 1. 프로모션 (프로모션 코드를 사용하여 구매)
priceChange

object (SubscriptionPriceChange)

사용 가능한 가장 최신 가격 변경 정보입니다. 아직 적용되지 않았으나 앞으로 적용될 정기 결제 가격 변경이 있는 경우에만 값이 있습니다.

정기 결제가 새 가격으로 갱신되거나 취소되면 가격 변경 정보가 반환되지 않습니다.
profileName

string

정기 결제를 구매했을 때 사용자의 프로필 이름입니다. 'Google을 통한 구독'을 사용하여 이루어진 구매인 경우에만 값이 있습니다.
emailAddress

string

정기 결제를 구매했을 때 사용자의 이메일 주소입니다. 'Google을 통한 구독'을 사용하여 이루어진 구매인 경우에만 값이 있습니다.
givenName

string

정기 결제를 구매했을 때 사용자의 이름입니다. 'Google을 통한 구독'을 사용하여 이루어진 구매인 경우에만 값이 있습니다.
familyName

string

정기 결제를 구매했을 때 사용자의 성입니다. 'Google을 통한 구독'을 사용하여 이루어진 구매인 경우에만 값이 있습니다.
profileId

string

정기 결제를 구매했을 때 사용자의 Google 프로필 ID입니다. 'Google을 통한 구독'을 사용하여 이루어진 구매인 경우에만 값이 있습니다.
acknowledgementState

integer

정기 결제 제품의 확인 상태입니다. 가능한 값은 0입니다. 0(아직 확인되지 않음). 확인됨
externalAccountId

string

서드 파티 서비스의 사용자 계정 식별자입니다. 정기 결제 구매 흐름의 일부로 계정 연결이 발생한 경우에만 표시됩니다.
promotionType

integer

이 구매에 적용된 프로모션 유형입니다. 이 필드는 정기 결제 구매 시점에 프로모션이 적용된 경우에만 설정됩니다. 가능한 값은 0입니다. 0(일회성 코드), 배니티 코드
promotionCode

string

이 구매에 적용된 프로모션 코드입니다. 이 필드는 정기 결제 구매 시점에 글자식 코드 프로모션이 적용된 경우에만 설정됩니다.
obfuscatedExternalAccountId

string

앱에서 사용자 계정과 고유하게 연결된 ID의 난독화된 버전입니다. 다음과 같은 구매의 경우 표시됩니다. * 정기 결제 구매 흐름의 일부로 계정 연결이 발생한 경우 * 구매 시 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid를 사용하여 지정되었습니다.
obfuscatedExternalProfileId

string

앱에서 사용자 프로필과 고유하게 연결된 ID의 난독화된 버전입니다. 구매 시 https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid를 사용하여 지정된 경우에만 표시됩니다.

IntroductoryPriceInfo

정기 결제의 신규 할인 가격 정보를 포함합니다.

JSON 표현 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
필드
introductoryPriceCurrencyCode

string

정기 결제 신규 할인 가격의 ISO 4217 통화 코드입니다. 예를 들어 가격이 영국 파운드로 지정된 경우 priceCurrencyCode는 'GBP'입니다.
introductoryPriceAmountMicros

string (int64 format)

정기 결제의 세금 제외 신규 할인 가격입니다. 통화는 priceCurrencyCode와 동일합니다. 마이크로 단위로 표현된 가격입니다. 여기서 1,000,000 마이크로 단위는 해당 통화의 1개 단위를 나타냅니다. 예를 들어 정기 결제 가격이 €1.99인 경우 priceAmountMicros는 1990000입니다.
introductoryPricePeriod

string

신규 할인 가격 기간입니다. ISO 8601 형식으로 지정됩니다. 일반적인 값은 'P1W'(1주일), 'P1M'(1개월), 'P3M'(3개월), 'P6M'(6개월), 'P1Y'(1년)이나 이에 국한되지 않습니다.
introductoryPriceCycles

integer

신규 할인 가격을 제공할 결제 기간 개수입니다.

SubscriptionCancelSurveyResult

사용자가 정기 결제 취소 흐름 (취소 사유 설문조사)을 완료할 때 제공하는 정보입니다.

JSON 표현 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
필드
cancelSurveyReason

integer

사용자가 설문조사에서 선택한 취소 사유입니다. 가능한 값은 0입니다. 기타 1. 1(이 서비스를 많이 사용하지 않음), 기술적 문제 3. 3(비용 관련 사유), 더 나은 앱을 찾음
userInputCancelReason

string

사용자가 직접 입력한 취소 사유입니다. cancelReason이 0인 경우에만 값이 있습니다.

SubscriptionPriceChange

정기 결제 가격 변경 정보를 포함합니다. 이 정보는 앱에서 가격 변경에 관한 사용자 여정을 제어(예: 사용자에게 확인 요청, 성공적인 전환을 위해 경험 맞춤화 등)하는 데 사용할 수 있습니다.

JSON 표현 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
필드
newPrice

object (Price)

사용자가 가격 변경을 수락할 경우 정기 결제 갱신에 적용될 새 가격입니다.
state

integer

가격 변경의 현재 상태입니다. 가능한 값은 0입니다. 0(보류 중 - 사용자가 동의하기를 기다리고 있는 가격 변경 보류 상태. 이 상태에서는 선택적으로 인앱 API를 사용하여 사용자의 확인을 요청할 수 있습니다. 1. 정기 결제가 취소되지 않은 한 갱신에 적용될 수락된 가격 변경 상태)입니다. 가격 변경은 정기 결제가 갱신되는 미래의 날짜에 발효됩니다. 정기 결제가 이 날짜 후에 갱신되는 경우에는 변경이 발생하지 않을 수 있습니다.

메서드

acknowledge

 정기 결제 구매를 확인합니다.

cancel

 사용자의 정기 결제 구매를 취소합니다.

defer

 지정된 미래의 만료 시점까지 사용자의 정기 결제 구매를 연기합니다.

get

 사용자의 정기 결제 구매가 유효한지 확인하고 만료 시간을 반환합니다.

refund

 사용자의 정기 결제 구매를 환불하되, 정기 결제는 만료 시간까지 유효한 상태로 유지되고 계속해서 반복됩니다.

revoke

 사용자의 정기 결제 구매를 환불하고 즉시 취소합니다.