Recuperar y actualizar una suscripción

Después de recuperar una suscripción, puedes usar la información de la respuesta correcta para cambiar el estado de la suscripción o actualizarla. En esta página, se describen las diferentes formas en las que puedes recuperar y actualizar una suscripción.

Cómo recuperar una suscripción

Para recuperar una suscripción que se pidió o se transfirió de forma correcta, usa la siguiente solicitud HTTP GET.

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

Reemplaza lo siguiente:

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Si la respuesta es correcta, se muestra un código de estado HTTP 200 y la configuración de la suscripción. En la siguiente respuesta de ejemplo, la propiedad isInTrial es false, pero no hay trialEndTime, lo que significa que este cliente nunca tuvo una prueba gratuita de 30 días con este plan.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

Recuperar todas las suscripciones de un cliente

Para recuperar todas las suscripciones de un cliente revendedor específico que se ordenaron o transfirieron con éxito, usa la siguiente solicitud HTTP GET y, además, incluye el token de autorización:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

Reemplaza lo siguiente:

  • CUSTOMER_ID: El nombre de dominio principal del cliente o el identificador único del cliente.
  • START_DATE: Es la fecha de inicio en el formato YYYY-MM-DD.
  • MAX_NUMBER: Es la cantidad máxima de resultados que se muestran en una página de respuesta.

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Si la respuesta es correcta, se muestra un código de estado HTTP 200 y una lista de las suscripciones y la configuración del cliente. La lista de suscripciones puede incluir productos que no se administran en esta versión de la API de revendedor.

Si no administras a este cliente sin administrarlo, se mostrará un error 403 "Forbidden".

Recuperar todas las suscripciones transferibles de un cliente

Para recuperar todas las suscripciones de un cliente que podrían transferirse a la administración del revendedor, usa la siguiente solicitud HTTP GET y, además, incluye el token de autorización. El customerId es obligatorio y es el identificador único del cliente que se muestra cuando se recupera la cuenta de un cliente de reventa. El customerAuthToken es un token de transferencia que proporciona tu cliente y que es específico para tu ID de revendedor. Una vez que lo genera el cliente, tiene una validez de 30 días. Para obtener más información sobre cómo los clientes generan el token, consulta Transfiere tu cuenta de Google Workspace a un revendedor.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

Reemplaza lo siguiente:

  • CUSTOMER_ID: El nombre de dominio principal del cliente o el identificador único del cliente.
  • AUTH_TOKEN: Es un token de transferencia que proporciona el cliente y que es específico para tu ID de revendedor. Una vez que lo genera el cliente, tiene una validez de 30 días. Para obtener más información sobre cómo los clientes generan el token, consulta Transfiere tu cuenta de Google Workspace a un revendedor. Si este valor no es válido o ya venció, la respuesta de la API muestra un error 403 "Forbidden".
  • START_DATE: Es la fecha de inicio en el formato YYYY-MM-DD.
  • MAX_NUMBER: Es la cantidad máxima de resultados que se muestran en una página de respuesta.

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Una respuesta correcta muestra un código de estado HTTP 200 y una lista de las suscripciones transferibles del cliente con la fecha de vencimiento del token de transferencia y la cantidad mínima de licencias necesarias en el pedido de transferencia. Un cliente puede tener suscripciones adicionales que no son transferibles.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Si planeas transferir estas suscripciones mediante la operación por lotes, debes transferirlas todas. La transferencia de cada suscripción una por una genera un error. Además, la operación por lotes solo transfiere suscripciones con estado ACTIVE. Para obtener más información, consulta Cómo transferir una suscripción.

Recuperar todas las suscripciones de revendedores

Para recuperar todas las suscripciones ordenadas o transferidas de un revendedor de forma correcta, usa la siguiente solicitud HTTP GET y, además, incluye el token de autorización.

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

Reemplaza lo siguiente:

  • PREFIX: Es el comienzo del nombre del cliente cuyas suscripciones buscas.
  • TOKEN: Es un token que identifica una página específica de resultados que debe mostrar el servidor.
  • MAX_NUMBER: Es la cantidad máxima de resultados que se muestran en una página de respuesta.

Esta operación puede usar el permiso de acceso de solo lectura de OAuth. customerNamePrefix, pageToken y maxResults son strings de consulta opcionales.

En el siguiente ejemplo, se recuperan todas las suscripciones de un revendedor que pertenecen a clientes cuyo nombre comienza con “exam”:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "purchaseOrderId": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

Actualiza un plan de suscripción

La actualización de planes de Google Workspace varía según el plan. Antes de actualizar un plan, considera lo siguiente:

  • Cuando creas una suscripción y el cliente califica, el plan de la suscripción puede ser una prueba de 30 días. Los planes de pagos de compromiso flexible y anuales pueden ser pruebas gratuitas de 30 días. Durante la prueba, puedes cambiar el plan de pagos de la suscripción a planes de compromiso flexibles o anuales con la frecuencia que sea necesaria. Sin embargo, una vez que finaliza la prueba y se activa el plan, su actualización sigue las mismas reglas que los planes activos de otras suscripciones. Para cambiar inmediatamente una suscripción de prueba a un plan activo, inicia un servicio pagado desde una suscripción de prueba gratuita de 30 días. Para obtener más información sobre las pruebas de 30 días y las reglas de calificación de los clientes, consulta el Centro de ayuda de administración.

  • Puedes actualizar un plan flexible a un plan de compromiso anual.

  • No puedes actualizar un plan de compromiso anual.

  • No todos los planes funcionan con todos los productos. Para obtener más información sobre qué productos se usan en estos planes, consulta Productos y SKU.

Si deseas actualizar un plan para una prueba de 30 días o una suscripción de plan flexible a un plan de compromiso anual, usa la siguiente solicitud HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan

Reemplaza lo siguiente:

En el siguiente ejemplo, se actualiza la suscripción con subscriptionId con un valor de 123. El customerId es C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

El cuerpo de la solicitud tiene lo siguiente:

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

Si la respuesta es correcta, se muestra un código de estado HTTP 201 y la configuración actualizada del plan de suscripción:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

Cómo actualizar las licencias de una suscripción

La actualización de una suscripción al plan de compromiso anual usa propiedades de suscripción diferentes a las de la actualización de la suscripción de un plan flexible de Google Workspace.

Actualiza las licencias de la suscripción de un plan anual

Para actualizar la configuración de licencias de usuario de una suscripción al plan anual, usa la siguiente solicitud HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats

Reemplaza lo siguiente:

En el siguiente ejemplo, se actualiza la suscripción con 123 subscriptionId. El customerId es C0123456. El cuerpo de la solicitud difiere según el tipo de plan:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

La suscripción de un plan de compromiso anual de Google Workspace usa este cuerpo de solicitud para actualizar la cantidad de licencias de usuario. El valor numberOfSeats es un total. Por ejemplo, si antes tenías 10 licencias de usuario y tienes un pedido de cliente de 5 licencias nuevas, el total en el cuerpo de la solicitud para numberOfSeats es 15, como se muestra en el siguiente ejemplo:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

Actualiza las licencias de la suscripción de un plan flexible

La suscripción de un plan flexible de Google Workspace usa el cuerpo de la solicitud para actualizar las licencias de los usuarios. El valor maximumNumberOfSeats es el total de licencias existentes y las nuevas. Esta es la cantidad máxima de licencias de usuario que la cuenta puede aprovisionar.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

Si la respuesta es correcta, se muestra un código de estado HTTP 201 y la configuración actualizada de la licencia de suscripción:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

Cómo actualizar la configuración de renovación de una suscripción

Para actualizar la configuración de renovación de una suscripción de compromiso anual, usa la siguiente solicitud HTTP POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings

Reemplaza lo siguiente:

A continuación, se muestra un ejemplo de cuerpo de solicitud:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

El valor de la propiedad renewalType puede ser cualquiera de los siguientes:

  • AUTO_RENEW_YEARLY_PAY: Al final del intervalo de un plan de compromiso anual, renueva automáticamente el plan de suscripción como ANNUAL_YEARLY_PAY con el mismo numberOfSeats.
  • AUTO_RENEW_MONTHLY_PAY: Al final del intervalo de un plan de compromiso anual, renueva automáticamente el plan de las suscripciones como ANNUAL_MONTHLY_PAY con el mismo numberOfSeats.
  • RENEW_CURRENT_USERS_YEARLY_PAY: Al final del intervalo de un plan de compromiso anual, renueva el plan de la suscripción como ANNUAL_YEARLY_PAY, pero usa la cantidad total de licencias de usuario activas actuales. Esta es la configuración predeterminada para los planes de compromiso anuales activos (que se pagan de forma anual).
  • RENEW_CURRENT_USERS_MONTHLY_PAY: Al final del intervalo de un plan de compromiso anual, renueva el plan de la suscripción como ANNUAL_MONTHLY_PAY, pero usa la cantidad total de licencias de usuario activas actuales. Esta es la configuración predeterminada para los planes de compromiso anuales activos (que se pagan mensualmente).
  • RENEW_ON_PROPOSED_OFFER: Al final del intervalo del plan de compromiso actual, renueva en la propuesta de renovación más reciente con numberOfSeats como cantidad de licencias de usuario activas actuales o compromiso de oferta propuesto, lo que sea mayor.
  • SWITCH_TO_PAY_AS_YOU_GO: Al final del intervalo de un plan de compromiso anual, cambia el plan de compromiso anual a uno flexible.
  • CANCEL: Al final de un intervalo del plan de compromiso anual, se suspende la suscripción. Para comprender cómo quitar una suspensión, consulta el Centro de ayuda de administración.

Si la respuesta es correcta, se muestra un código de estado HTTP 201 y la configuración actualizada de renovación de la suscripción:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Cómo iniciar un servicio pagado desde una suscripción de prueba gratuita

A fin de trasladar de inmediato una suscripción de prueba gratuita de 30 días a una suscripción de servicio pagado, si ya se configuró un plan de pagos para la suscripción de prueba, usa la siguiente solicitud HTTP POST.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService

Reemplaza lo siguiente:

El siguiente ejemplo tiene C0123456 como customerId y el valor subscriptionId de 123:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

Esta operación no tiene parámetros en el cuerpo de la solicitud.

Si la respuesta es correcta, se muestra un código de estado HTTP 201 y la configuración actualizada de la suscripción:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

Cómo actualizar una suscripción o cambiar a una versión inferior

No puedes cambiar a un plan inferior anual a mitad de período ni programar un cambio a una versión inferior mediante la configuración de renovación. Te recomendamos que establezcas la configuración de renovación para cambiar a FLEXIBLE y, luego, cambiar a una versión inferior después de la hora de renovación.

Para actualizar o cambiar una suscripción a una versión anterior, crea una suscripción nueva con el skuId al que deseas cambiarte.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

Reemplaza lo siguiente:

  • CUSTOMER_ID: El nombre de dominio principal del cliente o el identificador único del cliente.

Esta llamada finaliza la suscripción anterior y crea una nueva.

Obtén más información sobre actualizaciones y cambios a versiones anteriores en la página Productos y SKU.