Method: subscriptions.delete

anulować, zawiesić lub przenieść subskrypcję do bezpośredniego.

Żą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 jej używać do uzyskiwania dostępu do klienta, ale zawsze można użyć jego unikalnego identyfikatora (zwracanego przez interfejs API). W stosownych przypadkach zalecamy przechowywanie w swoich systemach unikalnego identyfikatora.

subscriptionId

string

To jest wymagana usługa. subscriptionId to identyfikator subskrypcji, który jest unikalny dla każdego klienta. Ponieważ identyfikator subscriptionId zmienia się po zaktualizowaniu subskrypcji, zalecamy, aby nie używać tego identyfikatora jako klucza do danych trwałych. Wartość subscriptionId można znaleźć, korzystając z metody pobierania wszystkich subskrypcji sprzedawcy.

Parametry zapytania

Parametry
deletionType

enum (DeletionType)

Parametr ciągu zapytania deletionType umożliwia anulowanie, obniżenie lub zawieszenie subskrypcji.

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.

W przypadku powodzenia odpowiedź jest ogólną odpowiedzią 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.

data

string (bytes format)

Treść żądania/odpowiedzi HTTP jako dane binarne.

Ciąg znaków 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 dotyczącym autoryzacji.

DeletionType

Wartości w polu enum
deletion_type_undefined
cancel Anuluje subskrypcję natychmiast. Nie dotyczy to subskrypcji G Suite.
transfer_to_direct

Przeniesienie subskrypcji bezpośrednio do Google.  Klient jest natychmiast przenoszony do bezpośredniego rozliczenia z Google i ma krótki czas bez przerwy w świadczeniu usługi. Klient może skonfigurować rozliczenia bezpośrednio w Google, używając karty kredytowej, lub przenieść je do innego sprzedawcy.