Se usó la API de Cloud Translation para traducir esta página.

Cómo recuperar y actualizar una suscripción

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

Cómo recuperar una suscripción

Para recuperar una suscripción que se solicitó o transfirió correctamente, usa la siguiente solicitud HTTP GET.

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

Reemplaza lo siguiente:

CUSTOMER_ID: Es el dominio principal del cliente. nombre o el identificador único del cliente.
SUBSCRIPTION_ID: El identificador de la suscripción que es únicos para cada cliente. Puedes recuperar este valor usando el Recupera todos los métodos de suscripción de revendedores.

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

Una respuesta correcta devuelve un estado HTTP 200 y la configuración de la suscripción. En la siguiente respuesta de ejemplo, se muestra La propiedad isInTrial está false, pero no hay trialEndTime, lo que significa que este cliente nunca estuvo en un 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"
}

Recupera todas las suscripciones de un cliente

Para recuperar todas las suscripciones de un cliente revendedor específico que se se solicitó o transfiriera correctamente, usa la siguiente solicitud HTTP GET y 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: Es el dominio principal del cliente. nombre o el identificador único del cliente.
START_DATE: Es la fecha de inicio en el formato. YYYY-MM-DD
MAX_NUMBER: 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 devuelve un código de estado 200 HTTP y una lista de los 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 para revendedores.

Si no administras a este cliente sin una administración, se generará un error 403 "Forbidden" que se devuelven.

Recupera todas las suscripciones transferibles de un cliente.

Para recuperar todas las suscripciones de un cliente que transferido a la administración del revendedor, usa la siguiente solicitud HTTP GET e incluir el token de autorización. El customerId es obligatorio y es el identificador único del cliente que se muestra cuando recuperar la cuenta de un cliente de reventa El customerAuthToken es un token de transferencia proporcionado por tu cliente que se específica de tu ID de revendedor. Una vez que el cliente lo genera, es válido por 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: Es el dominio principal del cliente. nombre o el identificador único del cliente.
AUTH_TOKEN: Es un token de transferencia proporcionado por tu cliente específico de su ID de revendedor. Después de que se generen cliente, tiene una validez de 30 días. Para obtener más información sobre cómo los clientes generar el token; consulta Transfiere tu cuenta de Google Workspace a un revendedor. Si este valor no es válido o venció, la respuesta de la API muestra un 403 "Forbidden" error.
START_DATE: Es la fecha de inicio en el formato. YYYY-MM-DD
MAX_NUMBER: 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 devuelve un código de estado 200 HTTP y una lista de los las suscripciones transferibles del cliente con la fecha de vencimiento de la transferencia token y la cantidad mínima de licencias necesarias para el pedido de transferencia. Un cliente podría retener 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 operación, transferir todas las suscripciones. Transfiere cada suscripción uno por uno generará un error. Además, la operación por lotes solo transfiere suscripciones con el estado ACTIVE. Para obtener más información, consulta Transfiere una suscripción.

Recuperar todas las suscripciones de revendedores

Para recuperar todos los datos solicitados o transferidos correctamente de un revendedor suscripciones, usa la siguiente solicitud HTTP GET y, luego, 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: El principio del nombre del cliente cuya las suscripciones que buscas.
TOKEN: Un token que identifica una página específica de resultados que el servidor debería devolver.
MAX_NUMBER: 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. El customerNamePrefix, pageToken y maxResults son cadenas de consulta opcionales.

En el siguiente ejemplo, se recuperan todas las suscripciones de un revendedor que pertenecen a clientes cuyos nombres comienzan 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 difiere según el plan. Antes de actualizar un plan, considera lo siguiente:

Cuando creas una suscripción y el cliente cumple con los requisitos, el el plan de tu suscripción puede ser una prueba de 30 días. Tanto el entorno flexible como el anual los planes de pagos por compromiso pueden ser pruebas gratuitas de 30 días. Durante la prueba, puede cambiar el plan de pagos de la suscripción a flexible o anual y planes de compromiso con la frecuencia que sea necesaria. Pero, después de que termine la prueba y el plan se activa, la actualización del plan sigue las mismas reglas que otras suscripciones los planes activos. Para transferir inmediatamente una suscripción de prueba a una plan activo, iniciar un servicio pagado desde una suscripción de prueba gratuita de 30 días Para obtener más información sobre la prueba de 30 días y las reglas de calificación del cliente, consulte la Centro de ayuda de la 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 productos que usan estos planes, consulta Productos y SKU

Para actualizar un plan de prueba de 30 días o de una suscripción a un plan flexible usa la siguiente solicitud HTTP POST:

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

Reemplaza lo siguiente:

CUSTOMER_ID: Es el dominio principal del cliente. nombre o el identificador único del cliente.
SUBSCRIPTION_ID: El identificador de la suscripción que es únicos para cada cliente. Puedes recuperar este valor usando el Recupera todos los métodos de suscripción de revendedores.

En el siguiente ejemplo, se actualiza la suscripción con el 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"
}

Una respuesta correcta devuelve un código de estado HTTP 201 y el estado configuración 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"
}

Actualiza las licencias de una suscripción

La actualización de una suscripción al plan de compromiso anual usa una suscripción diferente que actualizar la suscripción de un plan flexible de Google Workspace.

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

Para actualizar la configuración de la licencia de usuario de una suscripción a un plan anual, usa lo siguiente: Solicitud HTTP POST:

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

Reemplaza lo siguiente:

CUSTOMER_ID: Es el dominio principal del cliente. nombre o el identificador único del cliente.
SUBSCRIPTION_ID: El identificador de la suscripción que es únicos para cada cliente. Puedes recuperar este valor usando el Recupera todos los métodos de suscripción de revendedores.

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

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

La suscripción a un plan de compromiso anual de Google Workspace usa este cuerpo de solicitud para lo siguiente: 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 de 5 licencias nuevas, el total en el cuerpo de la solicitud de 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 del usuario. El valor maximumNumberOfSeats es el total de las licencias existentes y las nuevas. Esta es la cantidad máxima de usuarios licencias que la cuenta puede aprovisionar.

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

Una respuesta correcta devuelve un código de estado HTTP 201 y el estado configuración de licencias de la 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:

CUSTOMER_ID: Es el dominio principal del cliente. nombre o el identificador único del cliente.
SUBSCRIPTION_ID: El identificador de la suscripción que es únicos para cada cliente. Puedes recuperar este valor usando el Recupera todos los métodos de suscripción de revendedores.

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, renovar automáticamente el plan de la suscripción como ANNUAL_YEARLY_PAY con el mismo numberOfSeats.
AUTO_RENEW_MONTHLY_PAY: Al final de un plan de compromiso anual se renueva automáticamente el plan de la suscripción ANNUAL_MONTHLY_PAY con el mismo numberOfSeats.
RENEW_CURRENT_USERS_YEARLY_PAY: Al final de un plan de compromiso anual de suscripción, 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 opción predeterminada configuración de planes de compromiso anual activos (pagados anualmente).
RENEW_CURRENT_USERS_MONTHLY_PAY: Al final de un plan de compromiso anual de suscripción, 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 opción predeterminada parámetro de configuración para planes de compromiso anual activos (pago mensual).
RENEW_ON_PROPOSED_OFFER: Al final del plan de compromiso actual intervalo, renueve en la última propuesta de renovación con numberOfSeats como número de las licencias de usuario activas actuales o el compromiso de oferta propuesto, lo que ocurra mayores.
SWITCH_TO_PAY_AS_YOU_GO: Al final de un plan de compromiso anual el plan de compromiso anual por uno flexible.
CANCEL: Al final de un intervalo de plan de compromiso anual, la suscripción está suspendido. Para comprender cómo quitar una suspensión, consulta la Centro de ayuda de la administración.

Una respuesta correcta devuelve un código de estado HTTP 201 y el estado Configuración para renovar suscripciones:

{
  "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"
}

Iniciar el servicio pagado a partir de una suscripción de prueba gratuita

Cambiar inmediatamente una suscripción de prueba gratuita de 30 días a un servicio pagado suscripción, si ya se configuró un plan de pagos para la 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:

CUSTOMER_ID: Es el dominio principal del cliente. nombre o el identificador único del cliente.
SUBSCRIPTION_ID: El identificador de la suscripción que es únicos para cada cliente. Puedes recuperar este valor usando el Recupera todos los métodos de suscripción de revendedores.

El siguiente ejemplo tiene C0123456 como la customerId y la Valor de 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.

Una respuesta correcta 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

Tampoco puedes cambiar los planes anuales a la mitad de su período de vigencia. y programar un cambio a una versión inferior mediante la configuración de renovación. Te recomendamos que configures configuración de renovación para cambiar a FLEXIBLE y, luego, pasar a una versión anterior después de la fecha de renovación.

Para actualizar una suscripción o regresar a una versión anterior, crea una suscripción nueva con el skuId que quieres actualizar o cambiar a una versión inferior.

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

Reemplaza lo siguiente:

CUSTOMER_ID: Es el dominio principal del cliente. nombre 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 inferiores en los Productos y en la página de SKU.