Method: subscriptions.delete

Annulla, sospende o trasferisce un abbonamento al canale diretto.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
customerId

string

Può trattarsi del nome di dominio principale del cliente o dell'identificatore univoco del cliente. Se il nome di dominio di un cliente cambia, il nome di dominio precedente non può essere utilizzato per accedere al cliente, ma è sempre possibile utilizzare l'identificatore univoco del cliente (come restituito dall'API). Ti consigliamo di archiviare l'identificatore univoco nei tuoi sistemi, ove applicabile.
subscriptionId

string

Questa è una proprietà obbligatoria. subscriptionId è l'identificatore dell'abbonamento ed è univoco per ciascun cliente. Poiché un subscriptionId cambia quando viene aggiornato un abbonamento, consigliamo di non utilizzare questo ID come chiave per i dati permanenti. Inoltre, subscriptionId è reperibile utilizzando il metodo recupera tutti gli abbonamenti del rivenditore.

Parametri di ricerca

Parametri
deletionType

enum (DeletionType)

La stringa di query deletionType consente l'annullamento, il downgrade o la sospensione di un abbonamento.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio che rappresenta un corpo HTTP arbitrario. Deve essere utilizzato solo per i formati di payload che non possono essere rappresentati come JSON, ad esempio un programma binario raw o una pagina HTML.

Questo messaggio può essere utilizzato nei metodi API in streaming e non in streaming, sia nella richiesta sia nella risposta.

Può essere utilizzato come campo di richiesta di livello superiore, il che è utile se si vogliono estrarre dei parametri dall'URL o dal modello HTTP per i campi della richiesta e si vuole anche l'accesso al corpo HTTP raw.

Esempio:

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

}

Esempio con metodi in streaming:

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

}

L'utilizzo di questo tipo modifica solo il modo in cui vengono gestiti i corpi di richiesta e risposta; tutte le altre funzionalità continueranno a funzionare in modo invariato.

In caso di esito positivo, la risposta è una risposta HTTP generica il cui formato è definito dal metodo.

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

string

Il valore dell'intestazione Content-Type HTTP che specifica il tipo di contenuto del corpo.
data

string (bytes format)

Il corpo della richiesta/risposta HTTP come programma binario non elaborato.

Una stringa con codifica Base64.
extensions[]

object

Metadati di risposta specifici dell'applicazione. Devono essere impostati nella prima risposta per le API in streaming.

Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida alle autorizzazioni.

DeletionType

Enum
deletion_type_undefined
cancel L'abbonamento viene annullato immediatamente. Questo non vale per gli abbonamenti a G Suite.
transfer_to_direct

Trasferisce un abbonamento direttamente a Google. Il cliente viene immediatamente trasferito a un rapporto di fatturazione diretta con Google e gli viene concesso un breve periodo di tempo senza interruzioni del servizio. Il cliente può quindi scegliere di configurare la fatturazione direttamente con Google utilizzando una carta di credito oppure può trasferire la fatturazione a un altro rivenditore.