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

  • Článek

Platí pro: Partnerské centrum

Tento článek popisuje, jak můžete pomocí rozhraní API Partnerského centra zrušit prostředek komerčního marketplace nebo nového 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 dostupné všem poskytovatelům CSP (Cloud Solution Provider). 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ů od zakoupení nebo prodloužení, pokud zákon nevyžaduje jinak. Po uplynutí tohoto období už předplatná není možné zrušit a rozhraní API vyvolá chybu.

Požadavky

  • Přihlašovací údaje, jak je popsáno v tématu 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 ID zákazníka neznáte, 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 Microsoft 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:

  1. Vyberte zákazníka.

  2. Vyberte předplatné, které chcete zrušit.

  3. Zvolte možnost Zrušit předplatné a pak vyberte Odeslat.

C#

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

  1. Získejte předplatné podle ID.

  2. Změňte vlastnost Status předplatného. Informace o stavových kódech najdete v tématu Výčet SubscriptionStatus.

  3. Po provedení změny použijte kolekci a zavolejte IAggregatePartner.Customers metodu ById().

  4. Zavolejte vlastnost Subscriptions následovanou metodou ById().

  5. Zavolejte 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: Testovací aplikace konzoly Projekt: PartnerSDK.FeatureSample – třída: UpdateSubscription.cs

Požadavek REST

Syntaxe požadavku

Metoda Identifikátor URI žádosti
PATCH {baseURL}/v1/customers/{id_tenanta}/subscriptions/{id_předplatného} HTTP/1.1

Parametr identifikátoru URI

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

Název Typ Vyž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.

Hlavičky požadavku

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 předplatné zrušit, ujistěte se, že se vlastnost Stav aktualizovala na hodnotu deleted.

Pole Typ Vyžadováno Popis
Stav řetězec Y Stav předplatných. Možnosti můžou být - active, suspended, deleted

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: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
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,
    "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ý, tato metoda vrátí vlastnosti odstraněného prostředku předplatného v textu odpovědi.

Úspěšné odpovědi a kódy chyb

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo neúspěch, 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: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
X-Locale: en-US

{
    "id": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
    "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/6e7aa601-629e-461b-8933-0898c3cc3c7c",
            "method": "GET",
            "headers": []
        }
    },
    "publisherName": "publisher Name",
    "orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
    "attributes": {
        "etag": "",
        "objectType": "Subscription"
    }
}