Method: subscriptions.delete

Отменяет, приостанавливает или переносит подписку в Direct.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customerId

string

Это может быть либо основное доменное имя клиента, либо уникальный идентификатор клиента. Если доменное имя клиента изменится, старое доменное имя нельзя будет использовать для доступа к клиенту, но всегда можно использовать уникальный идентификатор клиента (возвращаемый API). Мы рекомендуем хранить уникальный идентификатор в ваших системах, где это возможно.

subscriptionId

string

Это обязательное свойство. subscriptionId — это идентификатор подписки, который уникален для каждого клиента. Поскольку subscriptionId меняется при обновлении подписки, мы рекомендуем не использовать этот идентификатор в качестве ключа для постоянных данных. А subscriptionId можно найти с помощью метода получения всех подписок реселлера .

Параметры запроса

Параметры
deletionType

enum ( DeletionType )

Строка запроса deletionType позволяет отменить, понизить или приостановить подписку.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Сообщение, представляющее произвольное тело HTTP. Его следует использовать только для форматов полезной нагрузки, которые не могут быть представлены как JSON, например необработанных двоичных файлов или HTML-страниц.

Это сообщение можно использовать как в потоковых, так и в непотоковых методах API в запросе, а также в ответе.

Его можно использовать в качестве поля запроса верхнего уровня, что удобно, если вы хотите извлечь параметры из URL-адреса или шаблона HTTP в поля запроса, а также хотите получить доступ к необработанному телу HTTP.

Пример:

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);

}

Пример с методами потоковой передачи:

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

}

Использование этого типа меняет только способ обработки тел запроса и ответа, все остальные функции продолжат работать без изменений.

В случае успеха ответ представляет собой общий ответ HTTP, формат которого определяется методом.

JSON-представление 
{
  "contentType": string,
  "data": string,
  "extensions": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Поля
contentType

string

Значение заголовка HTTP Content-Type, указывающее тип содержимого тела.

data

string ( bytes format)

Тело HTTP-запроса/ответа в виде необработанного двоичного файла.

Строка в кодировке Base64.

extensions[]

object

Метаданные ответа конкретного приложения. Должен быть установлен в первом ответе для API потоковой передачи.

Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Тип удаления

Перечисления
deletion_type_undefined
cancel Отменяет подписку немедленно. Это не относится к подписке G Suite.
transfer_to_direct

Переносит подписку напрямую в Google. Клиент немедленно переводится на прямые платежные отношения с Google, и ему предоставляется короткий промежуток времени без перерыва в обслуживании. Затем клиент может выбрать настройку выставления счетов непосредственно в Google с помощью кредитной карты или перейти к другому реселлеру.