REST Resource: purchases.subscriptions

Resource: SubscriptionPurchase

Resource SubscriptionPurchase menunjukkan status pembelian langganan pengguna.

Representasi 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
}
Kolom
kind

string

Jenis ini menampilkan objek subscriptionPurchase di layanan androidpublisher.
startTimeMillis

string (int64 format)

Waktu saat langganan diberikan, dalam milidetik sejak Epoch.
expiryTimeMillis

string (int64 format)

Waktu saat langganan akan berakhir, dalam milidetik sejak Epoch.
autoResumeTimeMillis

string (int64 format)

Waktu saat langganan akan dilanjutkan secara otomatis, dalam milidetik sejak Epoch. Hanya ada jika pengguna telah meminta untuk menjeda langganan.
autoRenewing

boolean

Apakah langganan akan diperpanjang secara otomatis saat mencapai expiry time saat ini.
priceCurrencyCode

string

Kode mata uang ISO 4217 untuk harga langganan. Misalnya, jika harga ditentukan dalam pound sterling Inggris, priceCurrencyCode adalah "GBP".
priceAmountMicros

string (int64 format)

Harga langganan. Untuk negara yang tidak memberlakukan pajak, harga tidak termasuk pajak. Untuk negara yang menyertakan pajak, harga termasuk pajak. Harga dinyatakan dalam unit mikro, yang mana 1.000.000 unit mikro mewakili satu unit mata uang. Misalnya, jika harga langganan adalah €1,99, priceAmountMicros adalah 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Informasi harga perkenalan langganan. Ini hanya ada jika langganan dibeli dengan harga perkenalan.

Kolom ini tidak menunjukkan langganan yang saat ini berada dalam periode harga perkenalan.
countryCode

string

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

string

String yang ditentukan developer yang berisi informasi tambahan tentang pesanan.
paymentState

integer

Status pembayaran langganan. Nilai yang mungkin adalah: 0. Pembayaran tertunda 1. Pembayaran diterima 2. Uji coba gratis 3. Upgrade/downgrade yang ditangguhkan tertunda

Tidak ada untuk langganan yang dibatalkan dan sudah berakhir.
cancelReason

integer

Alasan langganan dibatalkan atau tidak diperpanjang secara otomatis. Nilai yang mungkin adalah: 0. Pengguna membatalkan langganan 1. Langganan dibatalkan oleh sistem, misalnya karena masalah penagihan 2. Langganan diganti dengan langganan baru 3. Langganan dibatalkan oleh developer
userCancellationTimeMillis

string (int64 format)

Waktu saat langganan dibatalkan oleh pengguna, dalam milidetik sejak epoch. Hanya ada jika cancelReason adalah 0.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

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

string

ID pesanan dari pesanan berulang terbaru yang terkait dengan pembelian langganan. Jika langganan dibatalkan karena pembayaran ditolak, ini akan menjadi ID pesanan dari pesanan yang pembayarannya ditolak.
linkedPurchaseToken

string

Token pembelian dari pembelian awal jika langganan ini adalah salah satu dari yang berikut: 0. Pendaftaran ulang langganan yang dibatalkan tetapi belum berakhir 1. Mengupgrade/mendowngrade dari langganan sebelumnya

Misalnya, pengguna pertama kali mendaftar dan Anda menerima token pembelian X, lalu pengguna membatalkan dan menjalani alur pendaftaran ulang (sebelum langganan mereka berakhir) dan Anda menerima token pembelian Y, dan akhirnya pengguna mengupgrade langganannya dan Anda menerima token pembelian Z. Jika Anda memanggil API ini dengan token pembelian Z, kolom ini akan disetel ke Y. Jika Anda memanggil API ini dengan token pembelian Y, kolom ini akan disetel ke X. Jika Anda memanggil API ini dengan token pembelian X, kolom ini tidak akan disetel.
purchaseType

integer

Jenis pembelian langganan. Kolom ini hanya disetel jika pembelian ini tidak dilakukan menggunakan alur penagihan dalam aplikasi standar. Nilai yang mungkin adalah: 0. Pengujian (yaitu dibeli dari akun pengujian lisensi) 1. Promo (yaitu dibeli menggunakan kode promo)
priceChange

object (SubscriptionPriceChange)

Informasi perubahan harga terbaru tersedia. Ini hanya ada jika terdapat perubahan harga langganan yang akan datang yang belum diterapkan.

Setelah langganan diperpanjang dengan harga baru atau langganan dibatalkan, tidak ada informasi perubahan harga yang akan ditampilkan.
profileName

string

Nama profil pengguna saat langganan dibeli. Hanya ada jika pembelian dilakukan dengan 'Berlangganan dengan Google'.
emailAddress

string

Alamat email pengguna saat langganan dibeli. Hanya ada jika pembelian dilakukan dengan 'Berlangganan dengan Google'.
givenName

string

Nama pengguna saat langganan dibeli. Hanya ada jika pembelian dilakukan dengan 'Berlangganan dengan Google'.
familyName

string

Nama keluarga pengguna saat langganan dibeli. Hanya ada jika pembelian dilakukan dengan 'Berlangganan dengan Google'.
profileId

string

ID profil Google pengguna saat langganan dibeli. Hanya ada jika pembelian dilakukan dengan 'Berlangganan dengan Google'.
acknowledgementState

integer

Status konfirmasi produk langganan. Nilai yang mungkin adalah: 0. Belum dikonfirmasi 1. Dikonfirmasi
externalAccountId

string

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

integer

Jenis promosi yang diterapkan untuk pembelian ini. Kolom ini hanya disetel jika promosi berlaku saat langganan dibeli. Nilai yang mungkin adalah: 0. Kode sekali pakai 1. Kode cantik
promotionCode

string

Kode promosi yang diterapkan untuk pembelian ini. Kolom ini hanya disetel jika promosi kode cantik diterapkan saat langganan dibeli.
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.

IntroductoryPriceInfo

Berisi informasi harga perkenalan untuk langganan.

Representasi JSON 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
Kolom
introductoryPriceCurrencyCode

string

Kode mata uang ISO 4217 untuk harga langganan perkenalan. Misalnya, jika harga ditentukan dalam pound sterling Inggris, priceCurrencyCode adalah "GBP".
introductoryPriceAmountMicros

string (int64 format)

Harga perkenalan langganan, tidak termasuk pajak. Mata uangnya sama dengan priceCurrencyCode. Harga dinyatakan dalam unit mikro, yang mana 1.000.000 unit mikro mewakili satu unit mata uang. Misalnya, jika harga langganan adalah €1,99, priceAmountMicros adalah 1990000.
introductoryPricePeriod

string

Periode harga perkenalan, ditentukan dalam format ISO 8601. Nilai yang umum adalah (tetapi tidak terbatas pada) "P1W" (satu minggu), "P1M" (satu bulan), "P3M" (tiga bulan), "P6M" (enam bulan), dan "P1Y" (satu tahun).
introductoryPriceCycles

integer

Jumlah periode penagihan untuk menawarkan harga perkenalan.

SubscriptionCancelSurveyResult

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

Representasi JSON 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
Kolom
cancelSurveyReason

integer

Alasan pembatalan yang dipilih pengguna dalam survei. Nilai yang mungkin adalah: 0. Lainnya 1. Saya jarang menggunakan layanan ini 2. Masalah teknis 3. Alasan terkait biaya 4. Ada aplikasi yang lebih baik
userInputCancelReason

string

Input alasan pembatalan yang disesuaikan dari pengguna. Hanya ada jika cancelReason adalah 0.

SubscriptionPriceChange

Berisi informasi perubahan harga langganan yang dapat digunakan untuk mengontrol perjalanan pengguna untuk perubahan harga dalam aplikasi. Hal ini bisa berupa meminta konfirmasi dari pengguna atau menyesuaikan pengalaman agar konversi berhasil.

Representasi JSON 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
Kolom
newPrice

object (Price)

Harga baru perpanjangan langganan jika perubahan harga diterima oleh pengguna.
state

integer

Status perubahan harga saat ini. Nilai yang mungkin adalah: 0. Belum dimulai: Status perubahan harga masih menunggu persetujuan pengguna. Dalam status ini, Anda dapat meminta konfirmasi dari pengguna menggunakan API Dalam Aplikasi. 1. Diterima: Status perubahan harga yang diterima dan akan digunakan untuk memperpanjang langganan kecuali jika dibatalkan. Perubahan harga berlaku pada masa mendatang saat langganan diperpanjang. Perhatikan bahwa perubahan mungkin tidak terjadi saat perpanjangan langganan berikutnya.

Metode

acknowledge

 Mengonfirmasi pembelian langganan.

cancel

 Membatalkan pembelian langganan pengguna.

defer

 Menunda pembelian langganan pengguna hingga waktu habis masa berlaku tertentu pada masa mendatang.

get

 Memeriksa apakah pembelian langganan pengguna valid dan menampilkan waktu masa berlaku berakhir.

refund

 Mengembalikan dana pembelian langganan pengguna, tetapi langganan tetap valid hingga masa berakhirnya dan akan terus berulang.

revoke

 Mengembalikan dana dan segera membatalkan pembelian langganan pengguna.