REST Resource: purchases.subscriptionsv2

Resource: SubscriptionPurchaseV2

Menunjukkan status pembelian langganan pengguna.

Representasi JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
Kolom
kind

string

Jenis ini menampilkan objek SubscriptionPurchaseV2 di layanan androidpublisher.

regionCode

string

Kode negara/wilayah penagihan ISO 3166-1 alpha-2 pengguna pada saat langganan diberikan.

lineItems[]

object (SubscriptionPurchaseLineItem)

Info tingkat item untuk pembelian langganan. Item dalam pembelian yang sama harus semuanya dengan AutoRenewingPlan atau semuanya dengan PrepaidPlan.

startTime

string (Timestamp format)

Waktu saat langganan diberikan. Tidak ditetapkan untuk langganan yang tertunda (langganan sudah dibuat, tetapi menunggu pembayaran saat pendaftaran).

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

subscriptionState

enum (SubscriptionState)

Status langganan saat ini.

linkedPurchaseToken

string

Token pembelian langganan lama jika langganan ini adalah salah satu dari yang berikut: * Pendaftaran ulang langganan yang dibatalkan, tetapi belum berakhir * Upgrade/downgrade dari langganan sebelumnya. * Konversi dari langganan prabayar ke perpanjangan otomatis. * Konversi dari langganan perpanjangan otomatis ke prabayar. * Tambah saldo langganan prabayar.

pausedStateContext

object (PausedStateContext)

Konteks tambahan seputar langganan yang dijeda. Hanya ada jika langganan saat ini memiliki status subscriptionState SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

Konteks tambahan seputar langganan yang dibatalkan. Hanya ada jika langganan saat ini memiliki status subscriptionState SUBSCRIPTION_STATE_CANCELED atau SUBSCRIPTION_STATE_EXPIRED.

testPurchase

object (TestPurchase)

Hanya ada jika pembelian langganan ini adalah uji coba.

acknowledgementState

enum (AcknowledgementState)

Status konfirmasi langganan.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

ID akun pengguna dalam layanan pihak ketiga.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Profil pengguna yang terkait dengan pembelian yang dilakukan dengan 'Berlangganan dengan Google'.

etag

string

Tag entitas yang mewakili status langganan saat ini. Developer akan memberikan ETag ini untuk tindakan langganan. ETag ini selalu ada untuk langganan perpanjangan otomatis dan prabayar.

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

Konteks tambahan untuk pembelian di luar aplikasi. Informasi ini hanya tersedia untuk pembelian ulang langganan (pembelian langganan yang dilakukan setelah langganan sebelumnya untuk produk yang sama telah habis masa berlakunya) melalui pusat langganan Google Play. Kolom ini akan dihapus setelah Anda mengonfirmasi langganan.

onHoldStateContext

object (OnHoldStateContext)

Opsional. Konteks tambahan seputar langganan dalam status ON_HOLD. Hanya ada jika langganan saat ini memiliki status subscriptionState SUBSCRIPTION_STATE_ON_HOLD.

inGracePeriodStateContext

object (InGracePeriodStateContext)

Opsional. Konteks tambahan seputar langganan dalam status IN_GRACE_PERIOD. Hanya ada jika langganan saat ini memiliki status subscriptionState SUBSCRIPTION_STATE_IN_GRACE_PERIOD.

SubscriptionState

Kemungkinan status langganan, misalnya apakah langganan aktif atau dibatalkan. Item dalam pembelian langganan mungkin berupa paket perpanjangan otomatis atau paket prabayar seluruhnya.

Enum
SUBSCRIPTION_STATE_UNSPECIFIED Status langganan tidak ditentukan.
SUBSCRIPTION_STATE_PENDING Langganan sudah dibuat, tetapi menunggu pembayaran selama pendaftaran. Dalam status ini, semua item sedang menunggu pembayaran.
SUBSCRIPTION_STATE_ACTIVE Langganan aktif. - (1) Jika langganan adalah paket perpanjangan otomatis, dengan minimal satu item autoRenewEnabled dan belum berakhir. - (2) Jika langganan adalah paket prabayar, dengan minimal satu item belum berakhir.
SUBSCRIPTION_STATE_PAUSED Langganan dijeda. Status ini hanya tersedia jika langganan adalah paket perpanjangan otomatis. Dalam status ini, semua item dalam status dijeda.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD Langganan dalam masa tenggang. Status ini hanya tersedia jika langganan adalah paket perpanjangan otomatis. Dalam status ini, semua item berada dalam masa tenggang.
SUBSCRIPTION_STATE_ON_HOLD Langganan ditahan (ditangguhkan). Status ini hanya tersedia jika langganan adalah paket perpanjangan otomatis. Dalam status ini, semua item ditangguhkan.
SUBSCRIPTION_STATE_CANCELED Langganan dibatalkan, tetapi belum habis masa berlakunya. Status ini hanya tersedia jika langganan adalah paket perpanjangan otomatis. Semua item memiliki autoRenewEnabled yang disetel ke salah.
SUBSCRIPTION_STATE_EXPIRED Masa berlaku langganan habis. Semua item memiliki masa berlaku expiryTime di masa lalu.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED Transaksi tertunda untuk langganan dibatalkan. Jika pembelian tertunda ini adalah untuk langganan yang sudah ada, gunakan linkedPurchaseToken untuk mendapatkan status langganan itu saat ini.

PausedStateContext

Informasi khusus untuk langganan dalam status dijeda.

Representasi JSON
{
  "autoResumeTime": string
}
Kolom
autoResumeTime

string (Timestamp format)

Waktu saat langganan akan otomatis dilanjutkan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

CanceledStateContext

Informasi khusus langganan dalam status SUBSCRIPTION_STATE_CANCELED atau SUBSCRIPTION_STATE_EXPIRED.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
Kolom
Alasan langganan dibatalkan. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
userInitiatedCancellation

object (UserInitiatedCancellation)

Langganan dibatalkan oleh pengguna.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

Langganan dibatalkan oleh sistem, misalnya karena masalah penagihan.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

Langganan dibatalkan oleh developer.

replacementCancellation

object (ReplacementCancellation)

Langganan digantikan dengan langganan baru.

Akhir kolom yang saling eksklusif.

UserInitiatedCancellation

Informasi khusus untuk pembatalan yang dilakukan oleh pengguna.

Representasi JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Kolom
cancelSurveyResult

object (CancelSurveyResult)

Informasi yang diberikan oleh pengguna saat menyelesaikan alur pembatalan langganan (survei alasan pembatalan).

cancelTime

string (Timestamp format)

Waktu saat langganan dibatalkan oleh pengguna. Pengguna mungkin masih memiliki akses ke langganan setelah waktu ini. Gunakan lineItems.expiry_time untuk mengetahui apakah pengguna masih memiliki akses.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

CancelSurveyResult

Hasil survei pembatalan saat langganan dibatalkan oleh pengguna.

Representasi JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Kolom
reason

enum (CancelSurveyReason)

Alasan yang dipilih pengguna dalam survei pembatalan.

reasonUserInput

string

Hanya disetel untuk CANCEL_SURVEY_REASON_OTHERS. Ini adalah respons bentuk bebas pengguna terhadap survei.

CancelSurveyReason

Alasan yang dipilih pengguna dalam survei pembatalan.

Enum
CANCEL_SURVEY_REASON_UNSPECIFIED Alasan pembatalan survei yang tidak ditentukan.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE Tidak cukup banyak menggunakan langganan.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Masalah teknis saat menggunakan aplikasi.
CANCEL_SURVEY_REASON_FOUND_BETTER_APP Pengguna menemukan aplikasi yang lebih baik.
CANCEL_SURVEY_REASON_OTHERS Alasan lain.

SystemInitiatedCancellation

Jenis ini tidak memiliki kolom.

Informasi khusus untuk pembatalan yang dilakukan oleh sistem Google.

DeveloperInitiatedCancellation

Jenis ini tidak memiliki kolom.

Informasi khusus untuk pembatalan yang dilakukan oleh developer.

ReplacementCancellation

Jenis ini tidak memiliki kolom.

Informasi khusus untuk pembatalan yang disebabkan oleh penggantian langganan.

TestPurchase

Jenis ini tidak memiliki kolom.

Apakah pembelian langganan ini merupakan uji coba.

AcknowledgementState

Kemungkinan status konfirmasi suatu langganan.

Enum
ACKNOWLEDGEMENT_STATE_UNSPECIFIED Status konfirmasi tidak ditentukan.
ACKNOWLEDGEMENT_STATE_PENDING Langganan belum dikonfirmasi.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED Langganan sudah dikonfirmasi.

ExternalAccountIdentifiers

ID akun pengguna dalam layanan pihak ketiga.

Representasi JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Kolom
externalAccountId

string

ID akun pengguna dalam layanan pihak ketiga. Hanya ada jika penautan akun terjadi sebagai bagian dari alur pembelian langganan.

obfuscatedExternalAccountId

string

Versi ID yang di-obfuscate dan terkait secara unik dengan akun pengguna di aplikasi Anda. Ada untuk pembelian berikut: * Jika penautan akun terjadi sebagai bagian dari alur pembelian langganan. * Ditentukan menggunakan https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid saat pembelian dilakukan.

obfuscatedExternalProfileId

string

Versi ID yang di-obfuscate dan terkait secara unik dengan profil pengguna di aplikasi Anda. Hanya ada jika ditentukan menggunakan https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid saat pembelian dilakukan.

SubscribeWithGoogleInfo

Informasi terkait pembelian yang dilakukan dengan 'Berlangganan dengan Google'.

Representasi JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Kolom
profileId

string

ID profil Google pengguna saat langganan dibeli.

profileName

string

Nama profil pengguna saat langganan dibeli.

emailAddress

string

Alamat email pengguna saat langganan dibeli.

givenName

string

Nama pengguna saat langganan dibeli.

familyName

string

Nama keluarga pengguna saat langganan dibeli.

SubscriptionPurchaseLineItem

Info tingkat item untuk pembelian langganan.

Representasi JSON
{
  "productId": string,
  "expiryTime": string,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
Kolom
productId

string

ID produk yang dibeli (misalnya, 'monthly001').

expiryTime

string (Timestamp format)

Waktu saat langganan berakhir atau akan habis masa berlakunya kecuali akses diperpanjang (misalnya, berlangganan lagi).

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

developerTargetedOffers[]

object (DeveloperTargetedOffer)

Opsional. Detail penawaran yang ditargetkan untuk developer yang terdaftar untuk item baris ini.

latestSuccessfulOrderId

string

ID pesanan dari pesanan berhasil terbaru yang terkait dengan item ini. Tidak ada jika item belum dimiliki oleh pengguna (misalnya, item yang ditangguhkan diganti).

Jenis paket langganan. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
autoRenewingPlan

object (AutoRenewingPlan)

Item diperpanjang otomatis.

prepaidPlan

object (PrepaidPlan)

Item merupakan item prabayar.

Akhir kolom yang saling eksklusif.
offerDetails

object (OfferDetails)

Detail penawaran untuk item ini.

Kolom ini ada jika item mengalami perubahan yang ditangguhkan. Item dapat dihapus atau diganti. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
deferredItemReplacement

object (DeferredItemReplacement)

Informasi untuk penggantian item yang ditangguhkan.

deferredItemRemoval

object (DeferredItemRemoval)

Informasi untuk penghapusan item yang ditangguhkan.

Akhir kolom yang saling eksklusif.
signupPromotion

object (SignupPromotion)

Detail promosi tentang item ini. Hanya ditetapkan jika promosi diterapkan selama pendaftaran.

itemReplacement

object (ItemReplacement)

Detail item yang diganti. Kolom ini hanya diisi jika item ini menggantikan item lain dalam langganan sebelumnya dan hanya tersedia selama 60 hari setelah waktu pembelian.

offerPhase

object (OfferPhase)

Detail fase penawaran saat ini untuk item ini.

AutoRenewingPlan

Informasi terkait paket perpanjangan otomatis.

Representasi JSON
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
Kolom
autoRenewEnabled

boolean

Jika langganan saat ini disetel ke perpanjangan otomatis, misalnya, pengguna belum membatalkan langganan

recurringPrice

object (Money)

Harga berulang saat ini untuk paket perpanjangan otomatis. Perhatikan bahwa harga tidak memperhitungkan diskon dan tidak termasuk pajak. Untuk harga sebelum pajak, panggil API orders.get jika detail transaksi diperlukan.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

Informasi perubahan harga terakhir untuk item sejak pendaftaran langganan.

installmentDetails

object (InstallmentPlan)

Komitmen paket cicilan dan informasi terkait status untuk paket perpanjangan otomatis.

planTransitionDetails

object (PlanTransitionDetails)

Informasi transisi paket terkait. Hanya akan ada jika paket ini memiliki rencana transisi yang terkait dengannya dan hanya akan menyertakan detail transisi terbaru yang terkait dengan item tersebut.

SubscriptionItemPriceChangeDetails

Informasi terkait perubahan harga item langganan.

Representasi JSON
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
Kolom
newPrice

object (Money)

Harga berulang baru untuk item langganan.

priceChangeMode

enum (PriceChangeMode)

Mode perubahan harga menentukan bagaimana harga item langganan berubah.

priceChangeState

enum (PriceChangeState)

Status perubahan harga yang berlaku saat ini.

expectedNewPriceChargeTime

string (Timestamp format)

Waktu perpanjangan saat perubahan harga akan berlaku bagi pengguna. Hal ini dapat berubah (ke masa mendatang) karena kasus ketika waktu perpanjangan berubah seperti karena jeda. Kolom ini hanya diisi jika perubahan harga belum berlaku.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

PriceChangeMode

Mode perubahan harga.

Enum
PRICE_CHANGE_MODE_UNSPECIFIED Mode perubahan harga tidak ditentukan. Nilai ini tidak boleh disetel.
PRICE_DECREASE Jika harga langganan turun.
PRICE_INCREASE Jika harga langganan naik dan pengguna harus menerimanya.
OPT_OUT_PRICE_INCREASE Jika harga langganan naik dengan pilihan untuk tidak menerima.

PriceChangeState

Status perubahan harga.

Enum
PRICE_CHANGE_STATE_UNSPECIFIED Status perubahan harga tidak ditentukan. Nilai ini tidak boleh digunakan.
OUTSTANDING Menunggu pengguna menyetujui perubahan harga.
CONFIRMED Perubahan harga dipastikan terjadi pada pengguna.
APPLIED Perubahan harga diterapkan, yaitu pengguna mulai dikenai harga baru.
CANCELED Perubahan harga dibatalkan.

InstallmentPlan

Informasi untuk paket cicilan.

Representasi JSON
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
Kolom
initialCommittedPaymentsCount

integer

Jumlah total pembayaran yang menjadi komitmen pengguna di awal.

subsequentCommittedPaymentsCount

integer

Jumlah total pembayaran yang akan dilakukan pengguna setelah setiap periode komitmen. Kosong berarti paket cicilan akan kembali ke langganan perpanjangan otomatis normal setelah komitmen awal.

remainingCommittedPaymentsCount

integer

Jumlah total komitmen pembayaran yang tersisa yang harus dibayar dalam siklus perpanjangan ini.

pendingCancellation

object (PendingCancellation)

Jika ada, paket cicilan ini menunggu untuk dibatalkan. Pembatalan hanya akan terjadi setelah pengguna menyelesaikan semua komitmen pembayaran.

PendingCancellation

Jenis ini tidak memiliki kolom.

Ini merupakan indikator apakah ada pembatalan tertunda pada paket cicilan virtual. Pembatalan hanya akan terjadi setelah pengguna menyelesaikan semua komitmen pembayaran.

PlanTransitionDetails

Informasi terkait transisi paket.

Representasi JSON
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
Kolom
productId

string

[Wajib] ID produk yang menjadi tujuan transisi paket ini, (misalnya, 'monthly001').

basePlanId

string

[Wajib] ID paket dasar tujuan transisi paket ini.

offerId

string

ID penawaran. Hanya ada untuk penawaran diskon. Opsi ini hanya ditetapkan jika paket target bukan paket dasar.

transitionInfo

object (TransitionInfo)

Info tambahan tentang transisi paket terjadwal. Hanya akan ada jika transisi paket telah dijadwalkan.

TransitionInfo

Informasi terkait transisi paket terjadwal.

Representasi JSON
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
Kolom
transitionState

enum (TransitionState)

Hanya output. [Wajib] Status transisi saat ini.

price

object (Money)

Harga paket dasar default yang menjadi tujuan transisi paket.

expectedTransitionTime

string (Timestamp format)

Perkiraan waktu saat ini untuk transisi paket. Hal ini dapat berubah (ke masa mendatang) karena kasus ketika waktu perpanjangan berubah seperti karena jeda dan penangguhan akun.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

TransitionState

Kemungkinan status transisi.

Enum
TRANSITION_STATE_UNSPECIFIED Status transisi tidak ditentukan.
SCHEDULED Transisi dijadwalkan akan dimulai pada masa mendatang.
IN_PROGRESS Proses transisi telah dimulai dan notifikasi transisi awal telah dikirimkan kepada pengguna.
COMPLETED Transisi telah selesai.
CANCELED Transisi dibatalkan.

PriceStepUpConsentDetails

Informasi terkait kenaikan harga yang memerlukan izin pengguna.

Representasi JSON
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
Kolom
state

enum (ConsentState)

Hanya output. Status izin kenaikan harga.

consentDeadlineTime

string (Timestamp format)

Batas waktu pengguna harus memberikan izin. Jika izin tidak diberikan hingga waktu ini, langganan akan dibatalkan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

newPrice

object (Money)

Harga baru yang memerlukan izin pengguna.

ConsentState

Status izin kenaikan harga.

Enum
CONSENT_STATE_UNSPECIFIED Status izin tidak ditentukan.
PENDING Pengguna belum memberikan izin.
CONFIRMED Pengguna telah memberikan izin, dan harga baru menunggu untuk diterapkan.
COMPLETED Pengguna telah memberikan izin, dan harga baru telah berlaku.

PrepaidPlan

Informasi terkait paket prabayar.

Representasi JSON
{
  "allowExtendAfterTime": string
}
Kolom
allowExtendAfterTime

string (Timestamp format)

Jika ada, ini adalah waktu setelah pembelian tambah saldo diizinkan untuk paket prabayar. Tidak akan ada untuk paket prabayar yang sudah habis masa berlakunya.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

OfferDetails

Informasi detail penawaran terkait item baris pembelian.

Representasi JSON
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
Kolom
offerTags[]

string

Tag penawaran terbaru yang terkait dengan penawaran. Ini termasuk tag yang diambil dari paket dasar.

basePlanId

string

ID paket dasar. Ada untuk semua paket dasar dan penawaran.

offerId

string

ID penawaran. Hanya ada untuk penawaran diskon.

DeferredItemReplacement

Informasi terkait penggantian item yang ditangguhkan.

Representasi JSON
{
  "productId": string
}
Kolom
productId

string

productId ini akan menggantikan productId yang ada.

DeferredItemRemoval

Jenis ini tidak memiliki kolom.

Informasi terkait penggantian item yang ditangguhkan.

SignupPromotion

Promosi yang diterapkan untuk item ini saat dibeli.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
Kolom
Jenis promosi yang diterapkan ke item. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
oneTimeCode

object (OneTimeCode)

Kode sekali pakai telah diterapkan.

vanityCode

object (VanityCode)

Kode vanity telah diterapkan.

Akhir kolom yang saling eksklusif.

OneTimeCode

Jenis ini tidak memiliki kolom.

Kode promosi sekali pakai.

VanityCode

Kode promosi yang telah ditentukan dan dapat digunakan beberapa kali.

Representasi JSON
{
  "promotionCode": string
}
Kolom
promotionCode

string

Kode promosi.

ItemReplacement

Detail tentang item baris langganan yang diganti.

Representasi JSON
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
Kolom
productId

string

ID produk item baris langganan yang diganti.

replacementMode

enum (ReplacementMode)

Mode penggantian yang diterapkan selama pembelian.

basePlanId

string

ID paket dasar item baris langganan yang diganti.

offerId

string

ID penawaran item baris langganan yang diganti, jika ada.

ReplacementMode

Mode penggantian untuk langganan.

Enum
REPLACEMENT_MODE_UNSPECIFIED Mode penggantian tidak ditentukan.
WITH_TIME_PRORATION Paket baru akan dihitung secara prorata dan dikreditkan dari paket lama.
CHARGE_PRORATED_PRICE Pengguna akan dikenai harga prorata untuk paket baru.
WITHOUT_PRORATION Paket baru akan menggantikan paket lama tanpa penghitungan waktu secara prorata.
CHARGE_FULL_PRICE Pengguna akan dikenai biaya penuh untuk paket baru.
DEFERRED Paket lama akan dibatalkan dan paket baru akan berlaku setelah paket lama berakhir.
KEEP_EXISTING Paket tidak akan berubah dengan penggantian ini.

OfferPhase

Detail fase penawaran.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
Kolom
Detail fase penawaran. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
prorationPeriod

object (ProrationPeriodOfferPhase)

Ditetapkan saat fase penawaran adalah periode prorata.

freeTrial

object (FreeTrialOfferPhase)

Ditetapkan saat fase penawaran adalah uji coba gratis.

introductoryPrice

object (IntroductoryPriceOfferPhase)

Ditetapkan saat fase penawaran adalah fase penawaran harga perkenalan.

basePrice

object (BasePriceOfferPhase)

Disetel saat fase penawaran adalah fase harga paket dasar.

Akhir kolom yang saling eksklusif.

ProrationPeriodOfferPhase

Detail tentang fase penawaran periode prorata.

Representasi JSON
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
Kolom
originalOfferPhaseType

enum (OriginalOfferPhaseType)

Jenis fase penawaran awal sebelum periode prorata. Hanya ditetapkan saat periode prorata diperbarui dari fase penawaran yang ada.

OriginalOfferPhaseType

Fase penawaran awal dari pembayaran penawaran, jika pembayaran penawaran adalah pembayaran prorata.

Enum
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED Jenis fase penawaran asli tidak ditentukan.
BASE Langganan berada dalam fase harga dasar (misalnya, harga penuh).
INTRODUCTORY Langganan berada dalam fase harga perkenalan.
FREE_TRIAL Langganan dalam uji coba gratis.

FreeTrialOfferPhase

Jenis ini tidak memiliki kolom.

Detail tentang fase penawaran uji coba gratis.

IntroductoryPriceOfferPhase

Jenis ini tidak memiliki kolom.

Detail tentang fase penawaran harga perkenalan.

BasePriceOfferPhase

Jenis ini tidak memiliki kolom.

Detail tentang fase penawaran harga dasar.

DeveloperTargetedOffer

Informasi tentang penawaran yang ditargetkan developer untuk item baris langganan.

Representasi JSON
{
  "offerId": string,
  "activateTime": string
}
Kolom
offerId

string

Opsional. ID penawaran yang dibuat developer yang ditargetkan untuk langganan.

activateTime

string (Timestamp format)

Opsional. Waktu saat penargetan penawaran diaktifkan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

OutOfAppPurchaseContext

Informasi khusus untuk pembelian di luar aplikasi.

Representasi JSON
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
Kolom
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

ID akun pengguna dari langganan terakhir yang habis masa berlakunya untuk SKU ini.

expiredPurchaseToken

string

Token pembelian langganan terakhir yang habis masa berlakunya. Token pembelian ini hanya boleh digunakan untuk membantu mengidentifikasi pengguna jika link antara purchaseToken dan pengguna disimpan di database Anda. Token ini tidak dapat digunakan untuk memanggil Google Developer API jika sudah lebih dari 60 hari sejak masa berlakunya berakhir.

OnHoldStateContext

Konteks tambahan seputar langganan dalam status ON_HOLD.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Kolom
Alasan langganan berstatus ON_HOLD. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
renewalDeclined

object (RenewalDeclinedContext)

Opsional. Pembayaran untuk perpanjangan ditolak.

Akhir kolom yang saling eksklusif.

RenewalDeclinedContext

Konteks terkait skenario perpanjangan ditolak.

Representasi JSON
{
  "pendingOrderId": string
}
Kolom
pendingOrderId

string

Wajib. ID pesanan yang tertunda atau gagal yang menyebabkan status tersebut.

InGracePeriodStateContext

Konteks tambahan seputar langganan dalam status IN_GRACE_PERIOD.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Kolom
Alasan langganan berada dalam status IN_GRACE_PERIOD. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
renewalDeclined

object (RenewalDeclinedContext)

Opsional. Pembayaran untuk perpanjangan ditolak.

Akhir kolom yang saling eksklusif.

Metode

activateoffertargeting

Mengaktifkan penargetan untuk penawaran tertentu.

cancel

Membatalkan pembelian langganan untuk pengguna.

cancelplantransition

Membatalkan transisi paket untuk langganan.

deactivateoffertargeting

Menonaktifkan penargetan untuk penawaran tertentu.

defer

Menunda perpanjangan langganan.

get

Mendapatkan metadata tentang langganan

revoke

Mencabut pembelian langganan untuk pengguna.

scheduleplantransition

Menjadwalkan transisi paket untuk langganan.

Kode error

Operasi resource ini menampilkan kode error HTTP berikut:

Kode error Alasan Deskripsi Resolusi
400 / 410 subscriptionExpired Langganan telah berakhir dan operasi yang diminta tidak dapat dilakukan. Periksa waktu habis masa berlaku langganan. Operasi ini tidak diizinkan pada langganan yang sudah tidak berlaku.
400 subscriptionInvalidArgument Argumen yang tidak valid diberikan dalam permintaan langganan. Tinjau dokumentasi API dan pastikan semua kolom yang wajib diisi sudah diberikan dan diformat dengan benar.
400 invalidPurchaseState Pembelian tidak dalam status yang valid untuk melakukan operasi yang diminta. Misalnya, Anda mungkin mencoba mengonfirmasi pembelian yang sudah digunakan atau membatalkan langganan yang tidak aktif. Periksa status resource saat ini menggunakan Get API yang sesuai sebelum mencoba operasi. Pastikan resource berada dalam status yang sesuai untuk tindakan tersebut.
400 invalidValue Nilai yang diberikan dalam permintaan tidak valid. Error ini sering ditampilkan untuk token pembelian yang salah format atau tidak valid. Perbaiki nilai kolom yang tidak valid dalam isi atau parameter permintaan berdasarkan referensi API.
400 prepaidSubscriptionNotSupported Operasi yang diminta tidak didukung untuk langganan prabayar. Pastikan operasi berlaku untuk jenis langganan. Error ini khusus untuk metode seperti Cancel.
400 productNotOwnedByUser Token pembelian yang diberikan valid, tetapi pengguna saat ini tidak memiliki produk tersebut. Hal ini dapat terjadi jika pembelian dikembalikan dananya, dicabut, atau habis masa berlakunya sebelum konfirmasi. Periksa status resource saat ini menggunakan Get API yang sesuai sebelum mencoba operasi. Pastikan resource berada dalam status yang sesuai untuk tindakan tersebut.
400 purchaseTokenMismatch Token pembelian yang diberikan tidak cocok dengan pembelian, nama paket, ID langganan, atau ID produk. Pastikan semua detail dalam permintaan sudah benar dan sesuai satu sama lain.
400 required Kolom atau parameter yang wajib diisi tidak ada dalam permintaan. Lihat dokumentasi API untuk memastikan semua kolom dan parameter yang wajib diisi sudah disertakan.
400 unsupportedIabType Operasi ini tidak didukung untuk jenis Penagihan via Google Play yang diberikan. Pastikan metode API kompatibel dengan jenis item yang dikelola.
403 userInsufficientPermission Pengguna tidak memiliki izin yang memadai untuk melakukan operasi yang diminta. Pastikan pengguna yang diautentikasi memiliki izin yang diperlukan di Konsol Google Play. Lihat Menggunakan akun layanan untuk mengetahui detail selengkapnya.
404 notFound Resource yang diminta tidak dapat ditemukan. Verifikasi bahwa ID (misalnya, token pembelian, nama paket, ID produk, ID langganan) sudah benar.
409 concurrentUpdate Ada upaya untuk memperbarui objek yang sedang diperbarui secara bersamaan. Coba lagi permintaan dengan backoff eksponensial. Hindari modifikasi serentak terhadap resource yang sama.
410 purchaseTokenNoLongerValid Token pembelian tidak valid secara permanen karena akun pengguna terkait telah dihapus atau catatan pembelian tidak ada lagi. Hentikan penggunaan token pembelian ini.
410 subscriptionNoLongerAvailable Pembelian langganan tidak lagi tersedia untuk kueri karena masa berlakunya sudah terlalu lama berakhir. Error ini menunjukkan bahwa langganan telah berakhir selama lebih dari 60 hari. Anda tidak perlu lagi mengkueri langganan ini.
5xx Generic error Error umum di server Google Play. Coba lagi permintaan Anda.

Jika masalah berlanjut, hubungi pengelola akun Google Play Anda atau kirimkan permintaan dukungan. Sebaiknya periksa Dasbor Status Play untuk mengetahui pemadaman layanan yang diketahui.