Zrušení komerčního marketplace nebo nového komerčního předplatného pomocí rozhraní API Partnerského centra

Článek
07/02/2024

Platí pro: Partnerské centrum

Tento článek popisuje, jak můžete pomocí rozhraní API Partnerského centra zrušit komerční marketplace nebo nový prostředek komerčního předplatného , který odpovídá ID zákazníka a předplatného.

Poznámka:

Nové komerční prostředí pro služby založené na licencích zahrnují mnoho nových funkcí a jsou k dispozici pro všechny poskytovatele cloudových řešení (CSP). Další informace najdete v přehledu nových obchodních prostředí.

Nová komerční předplatná je možné zrušit do 7 dnů, s výjimkou případů, kdy to zákon vyžaduje, nákup nebo prodloužení platnosti. Po uplynutí tohoto okna se už předplatná nedají zrušit a rozhraní API vyvolá chybu.

Požadavky

Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i aplikace a uživatele.
ID zákazníka (customer-tenant-id). Pokud neznáte ID zákazníka, můžete ho vyhledat v Partnerském centru v pracovním prostoru Zákazníci . V seznamu zákazníků vyberte zákazníka a pak vyberte Účet. Na stránce Účet zákazníka vyhledejte ID Microsoftu v části Informace o účtu zákazníka. ID Microsoftu je stejné jako ID zákazníka (customer-tenant-id).
ID předplatného.

Metoda Partnerského centra

Zrušení předplatného komerčního marketplace v Partnerském centru:

Vyberte zákazníka.
Vyberte předplatné, které chcete zrušit.
Zvolte možnost Zrušit předplatné a pak vyberte Odeslat.

C#

Zrušení předplatného zákazníka:

Získejte předplatné podle ID.
Změňte vlastnost Status předplatného. Informace o stavových kódech naleznete v tématu SubscriptionStatus výčtu.
Po provedení změny použijte kolekci IAggregatePartner.Customers a volejte Metodu ById().
Zavolejte vlastnost Subscriptions následovanou metodou ById().
Volejte metodu 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);

Ukázková testovací aplikace konzoly

Ukázka: Konzolová testovací aplikace Projekt: PartnerSDK.FeatureSample – třída: UpdateSubscription.cs

Požadavek REST

Syntaxe požadavku

metoda	Identifikátor URI žádosti
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id} HTTP/1.1

Parametr identifikátoru URI

Tato tabulka uvádí požadovaný parametr dotazu k pozastavení předplatného.

Name	Type	Požadováno	Popis
customer-tenant-id	identifikátor guid	Y	Identifikátor GUID odpovídající zákazníkovi.
id předplatného	identifikátor guid	Y	Identifikátor GUID odpovídající předplatnému.

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

V textu požadavku se vyžaduje úplný prostředek předplatného . Pokud chcete zrušit předplatné, ujistěte se, že vlastnost Status byla aktualizována na hodnotu deleted.

Pole	Typ	Požadováno	Popis
status	string	Y	Stav předplatných Možnosti mohou být - `active`, `suspendeddeleted`

Příklad požadavku

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"},
}

Odpověď REST

Pokud je požadavek úspěšný, vrátí tato metoda odstraněné vlastnosti prostředku předplatného v textu odpovědi.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb.

Příklad odpovědi

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"
    }
}

Sdílet prostřednictvím