Method: subscriptions.delete

anuluje, zawiesza lub przenosi subskrypcję, aby umożliwić jej przekierowanie.

Żądanie HTTP

DELETE https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
customerId

string

Może to być nazwa domeny podstawowej klienta lub jego unikalny identyfikator. Jeśli nazwa domeny klienta ulegnie zmianie, nie będzie można używać starej nazwy domeny, aby uzyskać dostęp do klienta, ale zawsze można użyć unikalnego identyfikatora klienta (wyświetlonego przez interfejs API). W stosownych przypadkach zalecamy przechowywanie unikalnego identyfikatora w swoich systemach.
subscriptionId

string

Jest to właściwość wymagana. subscriptionId to identyfikator subskrypcji, który jest unikalny dla każdego klienta. Identyfikator subscriptionId zmienia się po zaktualizowaniu subskrypcji, dlatego nie zalecamy używania tego identyfikatora jako klucza dla danych trwałych. subscriptionId można znaleźć przy użyciu metody Pobierz wszystkie subskrypcje sprzedawcy.

Parametry zapytania

Parametry
deletionType

enum (DeletionType)

Ciąg zapytania deletionType umożliwia anulowanie subskrypcji, przejście na niższą wersję lub zawieszenie.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat dotyczący dowolnej treści HTTP. Powinien być używany wyłącznie w przypadku formatów ładunku, których nie da się zapisać jako JSON, takich jak pliki binarne RAW lub strony HTML.

Komunikat może być używany w żądaniu oraz w odpowiedzi zarówno w strumieniowych, jak i niestrumieniowych metodach API.

Może służyć jako pole żądania najwyższego poziomu, co jest wygodne, gdy chcesz wyodrębnić parametry z szablonu URL lub HTTP i użyć ich w polach żądania oraz gdy potrzebujesz dostępu do treści HTTP w formacie RAW.

Przykład

message GetResourceRequest {
  // A unique request id.
  string requestId = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Przykład z metodami strumieniowymi:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Użycie tego typu treści zmienia tylko sposób obsługi treści żądania i odpowiedzi – pozostałe funkcje działają bez zmian.

Jeśli operacja się uda, odpowiedzią będzie ogólna odpowiedź HTTP, której format jest zdefiniowany przez metodę.

Zapis JSON 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Pola
contentType

string

Wartość nagłówka HTTP Content-Type określająca typ treści treści.
data

string (bytes format)

Treść żądania/odpowiedzi HTTP w postaci nieprzetworzonego pliku binarnego.

Ciąg zakodowany w formacie base64.
extensions[]

object

Metadane odpowiedzi aplikacji. W przypadku strumieniowych interfejsów API muszą być przesłane w pierwszej odpowiedzi.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/apps.order

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

DeletionType

Wartości w polu enum
deletion_type_undefined
cancel Natychmiast anuluje subskrypcję. Nie dotyczy to abonamentu G Suite.
transfer_to_direct

Przenosi subskrypcję bezpośrednio do Google. Klient zostanie natychmiast przeniesiony na bezpośrednią umowę rozliczeniową z Google i będzie mógł korzystać z niego przez krótki czas bez przerw w świadczeniu usługi. Klient może skonfigurować rozliczenia bezpośrednio w Google za pomocą karty kredytowej lub przenieść się do innego sprzedawcy.