Avbryta en kommersiell marknadsplats eller en ny handelsprenumeration med hjälp av Api:er för Partnercenter

Artikel
07/02/2024

Gäller för: Partnercenter

Den här artikeln beskriver hur du kan använda Partnercenter-API:et för att avbryta en kommersiell marknadsplats eller en ny handelsprenumerationsresurs som matchar kundens och prenumerations-ID:t.

Kommentar

De nya handelsupplevelserna för licensbaserade tjänster innehåller många nya funktioner och är tillgängliga för alla Dobavljač rešenja u oblaku (CSP:er). Mer information finns i översikten över nya handelsupplevelser.

Nya handelsprenumerationer kan avbrytas inom 7 dagar, förutom om annat krävs enligt lag, för köp eller förnyelse. När det här fönstret har passerat kan prenumerationer inte längre avbrytas och API:et genererar ett fel.

Förutsättningar

Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.
Ett kund-ID (customer-tenant-id). Om du inte känner till kundens ID kan du söka efter det i Partnercenter på arbetsytan Kunder . Välj kunden i kundlistan och välj sedan Konto. På kundens kontosida letar du efter Microsoft-ID :t i avsnittet Kundkontoinformation . Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id).
Ett prenumerations-ID.

Partnercenter-metod

Så här avbryter du en prenumeration på den kommersiella marknadsplatsen i Partnercenter:

Välj en kund.
Välj den prenumeration som du vill avbryta.
Välj alternativet Avbryt prenumeration och välj sedan Skicka.

C#

Så här avbryter du en kunds prenumeration:

Hämta prenumerationen efter ID.
Ändra prenumerationens statusegenskap . Information om statuskoder finns i SubscriptionStatus-uppräkning.
När ändringen har gjorts använder du samlingen IAggregatePartner.Customers och anropar metoden ById().
Anropa egenskapen Prenumerationer följt av metoden ById().
Anropa metoden Patch().

// IAggregatePartner partnerOperations;
// var selectedCustomerId as string;
// Subscription selectedSubscription;

selectedSubscription.Status = SubscriptionStatus.Deleted;
var updatedSubscription = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscription.Id).Patch(selectedSubscription);

Exempelkonsoltestapp

Exempel: Konsoltestapp. Projekt: PartnerSDK.FeatureSample-klass: UpdateSubscription.cs

REST-begäran

Syntax för begäran

Metod	URI för förfrågan
LAPP	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id} HTTP/1.1

URI-parameter

Den här tabellen visar den frågeparameter som krävs för att pausa prenumerationen.

Namn	Typ	Obligatoriskt	Beskrivning
customer-tenant-id	GUID	Y	Ett GUID som motsvarar kunden.
prenumerations-ID	GUID	Y	Ett GUID som motsvarar prenumerationen.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

En fullständig prenumerationsresurs krävs i begärandetexten. Om du vill avbryta prenumerationen kontrollerar du att statusegenskapen har uppdaterats till värdet deletedför .

Fält	Typ	Obligatoriskt	Beskrivning
status	sträng	Y	Status för prenumerationerna. Alternativen kan vara - `active`, `suspended`, `deleted`

Exempel på begäran

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": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "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": "deleted",
    "autoRenewEnabled": false,
    "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"},
}

REST-svar

Om begäran lyckas returnerar den här metoden egenskaperna för den borttagna prenumerationsresursen i svarstexten.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och ytterligare parametrar. Den fullständiga listan finns i Felkoder.

Svarsexempel

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": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "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": "deleted",
    "autoRenewEnabled": false,
    "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",
    "links": {
        "product": {
            "uri": "/products/DZH318Z0BXWC?country=US",
            "method": "GET",
            "headers": []
        },
        "sku": {
            "uri": "/products/DZH318Z0BXWC/skus/0001?country=US",
            "method": "GET",
            "headers": []
        },
        "availability": {
            "uri": "/products/DZH318Z0BXWC/skus/0001/availabilities/DZH318Z0BMJX?country=US",
            "method": "GET",
            "headers": []
        },
        "self": {
            "uri": "/customers/5921f00a-32c0-4457-aaa1-e8018c650895/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            "method": "GET",
            "headers": []
        }
    },
    "publisherName": "publisher Name",
    "orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
    "attributes": {
        "etag": "",
        "objectType": "Subscription"
    }
}

Dela via