REST Resource: subscriptions

Recurso: Suscripción

Es una 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 que genera Google.
subscriptionId

string

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 que no uses este ID como clave para los datos persistentes. Usa subscriptionId como se describe en Cómo recuperar todas las suscripciones de revendedores.
skuId

string

Es una propiedad obligatoria. skuId es un identificador de sistema único para el SKU de un producto asignado a un cliente en la suscripción. Para conocer los productos y los SKU disponibles en esta versión de la API, consulta 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 de época. Consulta un ejemplo de convertidor 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 puestos de usuario en el plan
renewalSettings

object (RenewalSettings)

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

string

Esta es una propiedad opcional. Esta información de la orden de compra (OC) es para que los revendedores la usen para el seguimiento de su empresa. Si se proporciona un valor purchaseOrderId, este aparecerá en las respuestas de la API y 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 Suscripciones del cliente en la Consola del administrador El servicio de API genera la URL de solo lectura. Se usa si tu aplicación cliente requiere que el cliente complete una tarea en la página Suscripciones de la Consola del administrador.
billingMethod

string

Es un campo de solo lectura que muestra el método de facturación actual de una suscripción.
suspensionReasons[]

string

Es un campo de solo lectura que contiene un enumerable 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. El STATUS de una suscripción es SUSPENDED hasta que se quitan 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 G Suite para revendedores.
  • RENEWAL_WITH_TYPE_CANCEL: El compromiso del cliente finalizó y su servicio se canceló al final del plazo.
  • RESELLER_INITIATED: Es una suspensión manual que invoca un distribuidor.
  • TRIAL_ENDED: La prueba del cliente venció sin que se seleccionara un plan.
  • OTHER: El cliente está suspendido por un motivo interno de Google (p.ej., abuso o algún otro motivo).

customerDomain

string

Nombre de dominio principal del cliente
dealCode

string

Código emitido por Google (máximo 100 caracteres) para obtener precios con descuento en los planes de suscripción. El código de oferta se debe incluir en las solicitudes de insert para recibir la tarifa con descuento. Esta propiedad es opcional. Si se deja en blanco, se aplicará el precio normal.
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 los SKU disponibles en esta versión de la API, consulta 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 flexible, el de compromiso anual y el 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. 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: Es 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 prueba después del 30º día gratuito. Si llamas a changePlan, se asignará un plan de pagos a una prueba, pero no se activará. Una prueba comenzará automáticamente el plan de pagos asignado después del 30º día gratuito 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)

Es el startTime del intervalo de un plan de compromiso anual en milisegundos con el formato de época Unix. Consulta un ejemplo de convertidor de época.
plan.commitmentInterval.endTime

string (int64 format)

Es el endTime del intervalo de un plan de compromiso anual en milisegundos con el formato de época Unix. Consulta un ejemplo de convertidor de época.
trialSettings

object

El compromiso anual de G Suite y los planes de pago flexibles pueden estar 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 el plan de una suscripción está en una prueba gratuita de 30 días:

  • true: El plan está en período de prueba.
  • false: El plan no está en prueba.
trialSettings.trialEndTime

string (int64 format)

Es la fecha en la que finaliza la prueba. El valor se expresa en milisegundos con el formato de época Unix. Consulta un ejemplo de convertidor de época.
transferInfo

object

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

string (int64 format)

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

integer

Cuando insertas una suscripción, esta es la cantidad mínima de asientos que se indica 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 asientos.
transferInfo.currentLegacySkuId

string

Es el skuId de la suscripción revendida actual. Este campo solo se completa 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 asientos 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 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 configura, el numberOfSeats no se puede reducir hasta la renovación. Se le factura al revendedor en función del valor de numberOfSeats, independientemente de la cantidad de estas licencias de usuario que se asignen.

maximumNumberOfSeats

integer

Esta es una propiedad obligatoria y exclusiva para las suscripciones con planes FLEXIBLE o TRIAL. Esta propiedad establece la cantidad máxima de usuarios con licencia permitidos 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 de cliente.

licensedNumberOfSeats

integer

Es un 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 asiento 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, 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 un parámetro de configuración de renovación de suscripción. Valor: subscriptions#renewalSettings

Métodos

activate

 Activa una suscripción que el distribuidor 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 la licencia de usuario de una suscripción.

delete

 Cancela, suspende o transfiere una suscripción a Direct.

get

 Obtiene una suscripción específica.

insert

 Crea o transfiere una suscripción.

list

 Son listas de suscripciones administradas por el revendedor.

startPaidService

 Cambiar inmediatamente una suscripción de prueba gratuita de 30 días a una suscripción a un servicio pagado

suspend

 Suspende una suscripción activa.