Menjadwalkan perubahan untuk langganan perdagangan baru menggunakan API Pusat Mitra

Berlaku untuk: Pusat Mitra

Artikel ini menjelaskan bagaimana Anda dapat menggunakan API Partner Center untuk menjadwalkan perubahan untuk langganan perdagangan baru yang hanya terjadi pada perpanjangan langganan. API ini mendukung langganan perangkat lunak dan berbasis lisensi perdagangan baru.

Membuat perubahan terjadwal memungkinkan Anda mengubah langganan, secara otomatis, saat perpanjangan berikutnya terjadi. Dengan menjadwalkan perubahan, Anda dapat memilih untuk menambah atau mengurangi jumlah lisensi, mengubah jangka waktu dan frekuensi penagihan, dan bahkan memilih untuk meningkatkan SKU. Perubahan penjadwalan memungkinkan Anda melakukan modifikasi pada langganan Anda pada perpanjangan, bukan segera selama jangka waktu saat ini.

Prasyarat

• Kredensial seperti yang dijelaskan dalam autentikasi Pusat Mitra. Skenario ini mendukung autentikasi dengan kredensial Aplikasi mandiri dan Aplikasi+Pengguna.

• ID pelanggan (customer-tenant-id). Jika Anda tidak mengetahui ID pelanggan, Anda dapat mencarinya di Pusat Mitra dengan memilih ruang kerja Pelanggan, lalu pelanggan dari daftar pelanggan, lalu Akun. Pada halaman Akun pelanggan, cari ID Microsoft di bagian Info Akun Pelanggan. ID Microsoft sama dengan ID pelanggan (customer-tenant-id).

• ID langganan.

• Perpanjangan otomatis diaktifkan pada langganan.

Metode Pusat Mitra

Untuk menjadwalkan perubahan langganan di Pusat Mitra:

1. Pilih pelanggan.

2. Pilih langganan yang ingin Anda jadwalkan perubahannya.

3. Aktifkan Perpanjangan otomatis.

4. Pilih Kelola perpanjangan.

5. Lakukan modifikasi pada langganan untuk dilakukan pada perpanjangan.

6. Pilih Oke untuk menutup panel samping.

7. pilih Kirim untuk menyimpan perubahan.

C#

Untuk menjadwalkan perubahan langganan pelanggan:

1. Dapatkan langganan berdasarkan ID.
2. Dapatkan kelayakan transisi untuk jenis kelayakan transisi terjadwal.
3. Buat objek ScheduledNextTermInstructions dan tetapkan sebagai properti langganan.
4. Panggil metode Patch() untuk memperbarui langganan dengan perubahan terjadwal.

var selectedSubscription = subscriptionOperations.Get();
selectedSubscription.ScheduledNextTermInstructions = new ScheduledNextTermInstructions
{
    Product = new ProductTerm
    {
        ProductId = changeToProductId,
        SkuId = changeToSkuId,
        AvailabilityId = changeToAvailabilityId,
        BillingCycle = changeToBillingCycle,
        TermDuration = changeToTermDuration,
    },
    Quantity = changeToQuantity,
    customTermEndDate = DateTime,
};
var updatedSubscription = subscriptionOperations.Patch(selectedSubscription);

Untuk menjadwalkan perubahan langganan pelanggan, di mana perubahan terjadwal yang diinginkan adalah ke produk yang berbeda:

1. Dapatkan langganan berdasarkan ID.
2. Dapatkan kelayakan transisi untuk jenis kelayakan transisi terjadwal.
3. Panggil metode Patch() untuk memperbarui langganan dengan perubahan terjadwal.

Permintaan REST

Sintaks dari permintaan

Parameter URI

Tabel ini mencantumkan parameter kueri yang diperlukan untuk memanggil API.

Header permintaan

Untuk informasi selengkapnya, lihat header REST Pusat Mitra.

Isi permintaan

Sumber daya Langganan lengkap diperlukan di dalam isi permintaan, dengan properti scheduledNextTermInstructions ditentukan. Untuk menjadwalkan perubahan langganan Anda, pastikan bahwa properti AutoRenewEnabled diatur ke true.

Untuk ID ketersediaan pada akhir penjualan dengan konversi (EndofSaleWithConversions) menawarkan:

1. GetTransitionEligibility akan mengembalikan CatalogItemID.

   sebuah. Pastikan untuk mengatur jenis kelayakan Terjadwal jika tidak, defaultnya segera.

2. Gunakan CatalogItemID untuk kemudian mengekstrak availabilityID.

Contoh permintaan

PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/subscriptions/<subscription-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
If-Match: <etag>
Content-Type: application/json
Content-Length: 1029
Expect: 100-continue
Connection: Keep-Alive

{
    "id": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "customTermEndDate": "2019-01-09T00:21:45.9263727",
    "unitType": "License(s)",
    "hasPurchasableAddons": false,
    "creationDate": "2019-01-04T01:00:12.6647304Z",
    "effectiveStartDate": "2019-01-09T00:21:45.9263727+00:00",
    "commitmentEndDate": "2019-02-08T00:21:45.9263727+00:00",
    "status": "active",
    "autoRenewEnabled": true,
    "scheduledNextTermInstructions": { 
      "product": { 
         "productId":  "DG7GMGF0DVSV", 
         "skuId":  "000P", 
         "availabilityId":  "DG7GMGF0F3Q9", 
         "billingCycle":  "Annual", 
         "termDuration":  "P3Y",
         "promotionId": "39NFJQT1PFPJ:000H:39NFJQT1Q5DK"
        }, 
      "quantity":  1 
      "customTermEndDate" : "2019-01-09T00:21:45.9263727",
     },  // original value = null 
    "isTrial": false,
    "billingType": "license",
    "billingCycle": "monthly",
    "termDuration": "P1M",
    "refundOptions": [{
        "type": "Full",
        "expiresAt": "2019-01-10T00:21:45.9263727+00:00"
    }],
    "isMicrosoftProduct": false,
    "partnerId": "",
    "contractType": "subscription",
    "publisherName": "publisher Name",
    "orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
    "attributes": {"objectType": "Subscription"},
}

Respons REST

Jika permintaan berhasil, metode ini akan mengembalikan properti-properti sumber daya Langganan yang telah diperbarui dalam isi respons.

Kode kesalahan dan keberhasilan respons

Setiap respons dilengkapi dengan kode status HTTP yang menunjukkan keberhasilan atau kegagalan, dan informasi penelusuran kesalahan lainnya. Gunakan alat pelacakan jaringan untuk membaca kode ini, jenis kesalahan, dan parameter lainnya. Untuk daftar lengkapnya, lihat kode kesalahan .

Contoh respons

HTTP/1.1 200 OK
Content-Length: 1322
Content-Type: application/json; charset=utf-8
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

{
    "id": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "customTermEndDate": "2019-01-09T00:21:45.9263727",
    "unitType": "License(s)",
    "hasPurchasableAddons": false,
    "creationDate": "2019-01-04T01:00:12.6647304Z",
    "effectiveStartDate": "2019-01-09T00:21:45.9263727+00:00",
    "commitmentEndDate": "2019-02-08T00:21:45.9263727+00:00",
    "status": "active",
    "autoRenewEnabled": true,
    "scheduledNextTermInstructions": { 
      "product": { 
         "productId":  "DG7GMGF0DVSV", 
         "skuId":  "000P", 
         "availabilityId":  "DG7GMGF0F3Q9", 
         "billingCycle":  "Annual", 
         "termDuration":  "P3Y",
         "promotionId": "39NFJQT1PFPJ:000H:39NFJQT1Q5DK"
        }, 
      "quantity":  1 
      "customTermEndDate": "2019-01-09T00:21:45.9263727",
     },  // original value = null 
    "isTrial": false,
    "billingType": "license",
    "billingCycle": "monthly",
    "termDuration": "P1M",
    "refundOptions": [{
        "type": "Full",
        "expiresAt": "2019-01-10T00:21:45.9263727+00:00"
    }],
    "isMicrosoftProduct": false,
    "partnerId": "",
    "contractType": "subscription",
    "publisherName": "publisher Name",
    "orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
    "attributes": {"objectType": "Subscription"},
}