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 que genera 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 la suscripción y es único para cada cliente. Esta propiedad es obligatoria. Dado que una subscriptionId cambia cuando se actualiza una suscripción, recomendamos no usar este ID como clave para datos persistentes. Usa subscriptionId como se describe en Cómo recuperar todas las suscripciones de revendedores.
skuId

string

Es una propiedad obligatoria. El skuId es un identificador único del sistema para el SKU de un producto que se asigna a un cliente en la suscripción. Para conocer los productos y SKU disponibles en esta versión de la API, consulta los IDs de productos y SKU.
creationTime

string (int64 format)

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

string

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

object (Seats)

Esta propiedad es obligatoria. La cantidad y el límite de licencias de usuario del plan.
renewalSettings

object (RenewalSettings)

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

string

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

string

Esta propiedad es opcional.
resourceUiUrl

string

URL de la página Suscripciones del cliente en la Consola del administrador. El servicio de API genera la URL de solo lectura. Se usa si la aplicación cliente requiere que el cliente complete una tarea desde la página Suscripciones de la Consola del administrador.
billingMethod

string

Campo de solo lectura que muestra el método de facturación actual de 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 simultáneos y superpuestos. La STATUS de una suscripción es SUSPENDED hasta que se quiten todas las suspensiones pendientes.

Estas son algunas opciones posibles:

  • 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: Es una suspensión manual invocada por un revendedor.
  • TRIAL_ENDED: La prueba del cliente venció sin un plan seleccionado.
  • OTHER: Se suspendió al cliente por un motivo interno de Google (p.ej., por abuso o de otra manera).

customerDomain

string

Nombre de dominio principal del cliente
dealCode

string

Código emitido por Google (100 caracteres máx.) para descuentos en precios de planes de suscripción. Se debe incluir el código de oferta en las solicitudes de insert para recibir la tarifa con descuento. Esta propiedad es opcional. El precio normal se aplica si se deja en blanco.
skuName

string

Es el nombre visible externo de solo lectura para el SKU de un producto asignado a un cliente en la suscripción. Los nombres de los SKU están sujetos a cambios a discreción de Google. Para conocer los productos y SKU disponibles en esta versión de la API, consulta los IDs 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 gratuita de 30 días. Para obtener más información sobre los planes de pagos de la API, consulta los conceptos de la API.
plan.planName

string

La propiedad planName es obligatoria. Este es el nombre del plan de la 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: Es el plan de compromiso anual con pagos mensuales.
  • ANNUAL_YEARLY_PAY: Es el plan de compromiso anual con pagos anuales.
  • FLEXIBLE: El plan flexible
  • TRIAL: Es el plan de prueba gratuita de 30 días. Si no se asigna un plan de pagos, se suspenderá la suscripción en período de prueba después del 30o día gratuito. Si llamas a changePlan, se asignará un plan de pagos a una prueba, pero no se activará el plan. Una prueba comenzará automáticamente con el plan de pagos asignado después de que cumpla 30 días gratis o inmediatamente 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 la 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)

El valor de startTime de un intervalo de un plan de compromiso anual en milisegundos con el formato UNIX Epoch. Consulta un ejemplo de conversor de época.
plan.commitmentInterval.endTime

string (int64 format)

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

object

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

boolean

Determina si el plan de la suscripción está 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 se expresa en milisegundos con el formato UNIX Epoch. Consulta un ejemplo de conversor de época.
transferInfo

object

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

string (int64 format)

El momento en que vencerá el token de transferencia o el intent de transferencia. La hora se expresa en milisegundos con el formato UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

Cuando se inserta una suscripción, esta es la cantidad mínima de licencias indicada en el pedido de transferencia de este producto. Por ejemplo, si el cliente tiene 20 usuarios, el revendedor no puede realizar un pedido de transferencia de 15 licencias. El mínimo es de 20 licencias.
transferInfo.currentLegacySkuId

string

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

Licencias

Plantilla JSON para licencias de suscripción.

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

integer

Esta es una propiedad obligatoria y exclusiva para las suscripciones con los 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 revendedor puede agregar más licencias, pero una vez que se establecen, no se puede reducir el numberOfSeats hasta la renovación. Al revendedor se le factura según el valor de numberOfSeats, independientemente de la cantidad de estas licencias de usuario que se asignen.

maximumNumberOfSeats

integer

Esta propiedad es obligatoria y exclusiva para suscripciones con planes FLEXIBLE o TRIAL. Esta propiedad establece la cantidad máxima de usuarios con licencia que se permiten en una suscripción. Esta cantidad se puede aumentar hasta el límite máximo definido en el contrato del revendedor. La cantidad mínima es la cantidad actual de usuarios en la cuenta del 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 de Enterprise License Manager: listForProductAndSku.
kind

string

Identifica el recurso como un parámetro de 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. Si quieres obtener información más detallada, consulta las opciones de renovación en el Centro de ayuda para administradores. Cuando se renueva una suscripción, renewalType es una propiedad obligatoria.
kind

string

Identifica el recurso como una configuración para renovar la suscripción. Valor: subscriptions#renewalSettings

Métodos

activate

 Activa una suscripción que el revendedor suspendió anteriormente.

changePlan

 Actualiza un plan de suscripción.

changeRenewalSettings

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

changeSeats

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

delete

 Cancela, suspende o transfiere una suscripción directa.

get

 Obtiene una suscripción específica.

insert

 Crea o transfiere una suscripción.

list

 Las listas de suscripciones administradas por el revendedor.

startPaidService

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

suspend

 Suspende una suscripción activa.