REST Resource: subscriptions

Recurso: Suscripción

Plantilla JSON para una suscripción.

Representación JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Campos
customerId

string

Esta propiedad siempre se mostrará en una respuesta como el identificador único generado por Google. En una solicitud, esta propiedad puede ser el dominio principal o el identificador único generado por Google.
subscriptionId

string

El subscriptionId es el identificador de suscripción y es único para cada cliente. Esta es una propiedad obligatoria. Dado que un subscriptionId cambia cuando se actualiza una suscripción, te recomendamos no usar este ID como clave para datos persistentes. Usa el subscriptionId como se describe en la sección sobre cómo recuperar todas las suscripciones del distribuidor.
skuId

string

Una propiedad obligatoria El skuId es un identificador de sistema único para el SKU de un producto asignado a un cliente de la suscripción. Para obtener información sobre los productos y los SKU disponibles en esta versión de la API, consulta ID de productos y SKU.
creationTime

string (int64 format)

La propiedad creationTime es la fecha en que se creó la suscripción. Se expresa en milisegundos con el formato de época. Consulta un ejemplo de conversor de época.
kind

string

Identifica el recurso como una suscripción. Valor: reseller#subscription
seats

object (Seats)

Esta es una propiedad obligatoria. La cantidad y el límite de licencias de licencias de los usuarios en el plan.
renewalSettings

object (RenewalSettings)

Configuración de renovación del plan de compromiso anual. Para obtener información más detallada, consulte las opciones de renovación en el Centro de ayuda para administradores.
purchaseOrderId

string

Esta es una propiedad opcional. La información de esta orden de compra (PO) es para que los distribuidores la utilicen en el seguimiento del uso de la empresa. Si se proporciona un valor purchaseOrderId, este aparece en las respuestas de la API y aparece en la factura. La propiedad acepta hasta 80 caracteres de texto sin formato.
status

string

Esta es una propiedad opcional.
resourceUiUrl

string

URL de la página de suscripciones del cliente en la Consola del administrador El servicio de API genera la URL de solo lectura. Esta opción se utiliza si su aplicación cliente requiere que el cliente complete una tarea mediante la página Suscripciones de la Consola del administrador.
billingMethod

string

Campo de solo lectura que muestra el método de facturación actual para una suscripción.
suspensionReasons[]

string

Campo de solo lectura que contiene una enumeración de todos los motivos de suspensión actuales de una suscripción. Es posible que una suscripción tenga muchos motivos de suspensión superpuestos. El valor de STATUS de una suscripción es de SUSPENDED hasta que se eliminen todas las suspensiones pendientes.

Entre las opciones posibles, se incluyen las siguientes:

  • PENDING_TOS_ACCEPTANCE - El cliente no accedió ni aceptó las Condiciones del Servicio de Reventa de G Suite.
  • RENEWAL_WITH_TYPE_CANCEL: el compromiso del cliente finalizó y su servicio se canceló al final del período.
  • RESELLER_INITIATED: suspensión manual que invoca un distribuidor.
  • TRIAL_ENDED: la prueba del cliente venció sin un plan seleccionado.
  • OTHER: el cliente está suspendido por un motivo interno de Google (por ejemplo, abuso o de otra manera).

customerDomain

string

Nombre del dominio principal del cliente
dealCode

string

Código de Google (100 caracteres como máximo) para los precios con descuento de los planes de suscripción. El código de oferta debe incluirse en las solicitudes de insert para recibir la tarifa con descuento. Esta propiedad es opcional y se aplican precios regulares si se deja vacío.
skuName

string

Nombre comercial externo de solo lectura para el SKU de un producto asignado a un cliente en la suscripción. Los nombres de SKU están sujetos a cambios a discreción de Google. Para obtener información sobre los productos y los SKU disponibles en esta versión de la API, consulta ID de productos y SKU.
plan

object

La propiedad plan es obligatoria. En esta versión de la API, los planes de G Suite son el plan flexible, el plan de compromiso anual y el plan de prueba gratuito de 30 días. Para obtener más información sobre los planes de pago de la API, consulta los conceptos de la API.
plan.planName

string

La propiedad planName es obligatoria. Este es el nombre del plan de suscripción. Para obtener más información sobre los planes de pagos de Google, consulta los conceptos de la API.

Los valores posibles son los siguientes:

  • ANNUAL_MONTHLY_PAY: el plan de compromiso anual con pagos mensuales.
  • ANNUAL_YEARLY_PAY: el plan de compromiso anual con pagos anuales
  • FLEXIBLE: el plan flexible
  • TRIAL: el plan de prueba gratuita de 30 días. Si no se asigna ningún plan de pagos, se suspenderá la suscripción después del día 30. Si llamas a changePlan, se asignará un plan de pagos a una prueba, pero no se activará. Una prueba comenzará automáticamente su plan de pagos asignado después de que finalice el día 30 o después de llamar a startPaidService.
  • FREE: El plan gratuito es exclusivo del SKU de Cloud Identity y no genera facturación.

plan.isCommitmentPlan

boolean

El valor booleano de la propiedad isCommitmentPlan identifica el plan como un plan de compromiso anual:

  • true: el plan de suscripción es un plan de compromiso anual.
  • false: El plan no es un plan de compromiso anual.
plan.commitmentInterval

object

En esta versión de la API, el intervalo del plan de compromiso anual es de un año.

plan.commitmentInterval.startTime

string (int64 format)

Un intervalo de compromiso anual: el intervalo de un año en startTime con el formato UNIX Epoch. Consulta un ejemplo de conversor de época.
plan.commitmentInterval.endTime

string (int64 format)

Intervalo de un plan de compromiso anual en endTime con el formato UNIX Epoch. Consulta un ejemplo de conversor de época.
trialSettings

object

El compromiso anual de G Suite y los planes de pago flexibles pueden estar disponibles en una prueba gratuita de 30 días. Para obtener más información, consulta los conceptos de la API.
trialSettings.isInTrial

boolean

Determina si un plan de suscripción se encuentra en una prueba gratuita de 30 días:

  • true: El plan está en prueba.
  • false: El plan no está en prueba.
trialSettings.trialEndTime

string (int64 format)

Fecha en la que finaliza la prueba. El valor está en milisegundos con el formato de época de UNIX. Consulta un ejemplo de conversor de época.
transferInfo

object

Información relacionada con la transferencia de solo lectura para la suscripción. Para obtener más información, consulta Cómo recuperar suscripciones transferibles de un cliente.
transferInfo.transferabilityExpirationTime

string (int64 format)

La hora a la que vencerá el token de transferencia o el intent de transferencia. La hora se expresa en milisegundos con el formato de época UNIX.
transferInfo.minimumTransferableSeats

integer

Cuando inserte una suscripción, esta es la cantidad mínima de licencias que aparecen en el pedido de transferencia de este producto. Por ejemplo, si el cliente tiene 20 usuarios, el distribuidor no puede realizar un pedido de transferencia de 15 licencias. La cantidad mínima es de 20 licencias.
transferInfo.currentLegacySkuId

string

Es el skuId de la suscripción de reventa actual. Esto se propaga solo cuando el cliente tiene una suscripción con un SKU heredado y el recurso de suscripción se propaga con el skuId del SKU recomendado para la transferencia.

Licencias

Plantilla JSON para las licencias suscritas.

Representación JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Campos
numberOfSeats

integer

Esta es una propiedad obligatoria y es exclusiva de suscripciones con planes ANNUAL_MONTHLY_PAY y ANNUAL_YEARLY_PAY. Esta propiedad establece la cantidad máxima de licencias que se pueden asignar a los usuarios en una suscripción. El distribuidor puede agregar más licencias, pero, una vez establecido, no se puede reducir el numberOfSeats hasta la renovación. Se factura al distribuidor según el valor numberOfSeats, independientemente de la cantidad de estas licencias de usuario asignadas.

maximumNumberOfSeats

integer

Esta es una propiedad obligatoria y es exclusiva de suscripciones con planes de FLEXIBLE o TRIAL. Esta propiedad establece la cantidad máxima de usuarios con licencia que se permiten en una suscripción. Esta cantidad puede aumentarse hasta el límite máximo definido en el contrato del distribuidor. La cantidad mínima es la cantidad actual de usuarios en la cuenta de cliente.

licensedNumberOfSeats

integer

Campo de solo lectura que contiene la cantidad actual de usuarios a los que se les asignó una licencia para el producto definido en skuId. El valor de este campo es equivalente al recuento numérico de usuarios que muestra el método de la API del administrador de licencias empresariales: listForProductAndSku.
kind

string

Identifica el recurso como una configuración de licencia de suscripción. Valor: subscriptions#seats

RenewalSettings

Plantilla JSON para la configuración de renovación de una suscripción.

Representación JSON 
{
  "renewalType": string,
  "kind": string
}
Campos
renewalType

string

Configuración de renovación del plan de compromiso anual. Para obtener información más detallada, consulte las opciones de renovación en el Centro de ayuda para administradores. Cuando renuevas una suscripción, renewalType es una propiedad obligatoria.
kind

string

Identifica el recurso como una configuración de renovación de suscripción. Valor: subscriptions#renewalSettings

Métodos

activate

 Activa una suscripción que el distribuidor había suspendido anteriormente.

changePlan

 Actualiza un plan de suscripción.

changeRenewalSettings

 Actualiza la configuración de renovación de la licencia de un usuario.

changeSeats

 Actualiza la configuración de licencias de usuario de una suscripción.

delete

 Cancela, suspende o transfiere una suscripción para dirigir.

get

 Obtiene una suscripción específica.

insert

 Crea o transfiere una suscripción.

list

 Listas de suscripciones administradas por el distribuidor.

startPaidService

 Transfiere de inmediato una suscripción de prueba gratuita de 30 días a una suscripción de servicio pagado.

suspend

 Suspende una suscripción activa.