Mendapatkan langganan untuk pengguna

  • Artikel

Gunakan metode ini di API pembelian Microsoft Store untuk mendapatkan add-on langganan yang berhak digunakan pengguna tertentu.

Catatan

Metode ini hanya dapat digunakan oleh akun pengembang yang telah disediakan oleh Microsoft untuk dapat membuat add-on langganan untuk aplikasi Platform Windows Universal (UWP). Add-on langganan saat ini tidak tersedia untuk sebagian besar akun pengembang.

Pustaka Microsoft.StoreServices menyediakan fungsionalitas metode ini melalui STOREServicesClient.RecurrenceQueryAsync API.

Prasyarat

Untuk menggunakan metode ini, Anda memerlukan:

  • Token akses Azure AD yang memiliki nilai https://onestore.microsoft.comURI audiens .
  • Kunci ID Microsoft Store yang mewakili identitas pengguna yang langganannya ingin Anda dapatkan.

Untuk informasi selengkapnya, lihat Mengelola pemberian izin produk dari layanan.

Minta

Minta sintaks

Metode URI Permintaan
KIRIM https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/query

Meminta header

Header Jenis Deskripsi
Authorization string Wajib diisi. Token akses Azure AD dalam bentuktoken>Pembawa<.
Host string Harus diatur ke nilai purchase.mp.microsoft.com.
Panjang-Konten nomor Panjang isi permintaan.
Jenis-Konten string Menentukan jenis permintaan dan respons. Saat ini, satu-satunya nilai yang didukung adalah aplikasi/json.

Isi permintaan

Parameter Jenis Deskripsi Diperlukan
b2bKey string Kunci ID Microsoft Store yang mewakili identitas pengguna yang langganannya ingin Anda dapatkan. Ya
continuationToken string Jika pengguna memiliki pemberian izin ke beberapa langganan, isi respons mengembalikan token kelanjutan saat batas halaman tercapai. Berikan token kelanjutan tersebut di sini dalam panggilan berikutnya untuk mengambil produk yang tersisa. Tidak
pageSize string Jumlah maksimum langganan yang akan dikembalikan dalam satu respons. Defaultnya adalah 25. Tidak

Contoh permintaan

Contoh berikut menunjukkan cara menggunakan metode ini untuk mendapatkan add-on langganan yang memiliki hak untuk digunakan pengguna tertentu. Ganti nilai b2bKey dengan kunci ID Microsoft Store yang mewakili identitas pengguna yang langganannya ingin Anda dapatkan.

POST https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/query HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
Host: purchase.mp.microsoft.com

{
  "b2bKey":  "eyJ0eXAiOiJ..."
}

Respons

Metode ini mengembalikan isi respons JSON yang berisi kumpulan objek data yang menjelaskan add-on langganan yang berhak digunakan pengguna. Contoh berikut menunjukkan isi respons untuk pengguna yang memiliki hak untuk satu langganan.

{
  "items": [
    {
      "autoRenew":true,
      "beneficiary":"pub:gFVuEBiZHPXonkYvtdOi+tLE2h4g2Ss0ZId0RQOwzDg=",
      "expirationTime":"2017-06-11T03:07:49.2552941+00:00",
      "id":"mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac",
      "lastModified":"2017-01-08T21:07:51.1459644+00:00",
      "market":"US",
      "productId":"9NBLGGH52Q8X",
      "skuId":"0024",
      "startTime":"2017-01-10T21:07:49.2552941+00:00",
      "recurrenceState":"Active"
    }
  ]
}

Isi Respons

Isi respons berisi data berikut.

Nilai Jenis Deskripsi
item array Array objek yang berisi data tentang setiap add-on langganan yang berhak digunakan pengguna yang ditentukan. Untuk informasi selengkapnya tentang data di setiap objek, lihat tabel berikut ini.

Setiap objek dalam array item berisi nilai berikut.

Nilai Jenis Deskripsi
autoRenew Boolean Menunjukkan apakah langganan dikonfigurasi untuk diperpanjang secara otomatis pada akhir periode langganan saat ini.
penerima string ID penerima atas pemberian izin yang terkait dengan langganan ini.
expirationTime string Tanggal dan waktu langganan akan kedaluwarsa, dalam format ISO 8601. Bidang ini hanya tersedia ketika langganan berada dalam status tertentu. Waktu kedaluwarsa biasanya menunjukkan kapan status saat ini kedaluwarsa. Misalnya, untuk langganan aktif, tanggal kedaluwarsa menunjukkan kapan perpanjangan otomatis berikutnya akan terjadi.
expirationTimeWithGrace string Tanggal dan waktu langganan akan kedaluwarsa termasuk masa tenggang, dalam format ISO 8601. Nilai ini menunjukkan kapan pengguna akan kehilangan akses ke langganan setelah langganan gagal diperpanjang secara otomatis.
id string ID langganan. Gunakan nilai ini untuk menunjukkan langganan mana yang ingin Anda ubah saat Memanggil perubahan status penagihan langganan untuk metode pengguna .
isTrial Boolean Menunjukkan apakah langganan adalah uji coba.
lastModified string Tanggal dan waktu langganan terakhir diubah, dalam format ISO 8601.
market string Kode negara (dalam format dua huruf ISO 3166-1 alpha-2) di mana pengguna memperoleh langganan.
productId string ID Toko untuk produk yang mewakili add-on langganan di katalog Microsoft Store. Contoh ID Penyimpanan untuk produk adalah 9NBLGGH42CFD.
skuId string ID Toko untuk SKU yang mewakili add-on langganan katalog Microsoft Store. Contoh ID Store untuk SKU adalah 0010.
startTime string Tanggal dan waktu mulai untuk langganan, dalam format ISO 8601.
recurrenceState string Salah satu dari nilai berikut:
  • Tidak Ada: Ini menunjukkan langganan abadi.
  • Aktif: Langganan aktif dan pengguna berhak menggunakan layanan.
  • Tidak aktif: Langganan melewati tanggal kedaluwarsa, dan pengguna menonaktifkan opsi perpanjangan otomatis untuk langganan.
  • Dibatalkan: Langganan telah dihentikan secara sengaja sebelum tanggal kedaluwarsa, dengan atau tanpa pengembalian dana.
  • InDunning: Langganan dalam dunning (artinya, langganan mendekati kedaluwarsa, dan Microsoft mencoba memperoleh dana untuk memperbarui langganan secara otomatis).
  • Gagal: Periode dunning berakhir dan langganan gagal diperpanjang setelah beberapa upaya.

Catatan:

  • Aktif/Dibatalkan/Gagal adalah status terminal. Saat langganan memasuki salah satu status ini, pengguna harus membeli kembali langganan untuk mengaktifkannya lagi. Pengguna tidak berhak menggunakan layanan di status ini.
  • Saat langganan Dibatalkan, expirationTime akan diperbarui dengan tanggal dan waktu pembatalan.
  • ID langganan akan tetap sama selama masa pakainya. Ini tidak akan berubah jika opsi perpanjangan otomatis diaktifkan atau dinonaktifkan. Jika pengguna membeli kembali langganan setelah mencapai status terminal, ID langganan baru akan dibuat.
  • ID langganan harus digunakan untuk menjalankan operasi apa pun pada langganan individual.
  • Saat pengguna membeli kembali langganan setelah membatalkan atau menghentikannya, jika Anda meminta hasil untuk pengguna, Anda akan mendapatkan dua entri: satu dengan ID langganan lama dalam status terminal, dan satu dengan ID langganan baru dalam status aktif.
  • Ini selalu merupakan praktik yang baik untuk memeriksa recurrenceState dan expirationTime, karena pembaruan ke recurrenceState berpotensi tertunda beberapa menit (atau kadang-kadang berjam-jam).
cancellationDate string Tanggal dan waktu langganan pengguna dibatalkan, dalam format ISO 8601.