Compartir a través de

Obtención de suscripciones para un usuario

Usa este método en la API de compra de Microsoft Store para obtener los complementos de suscripción que un usuario determinado tiene derechos de usar.

Nota:

Microsoft solo puede usar este método para las cuentas de desarrollador aprovisionadas por Microsoft para poder crear complementos de suscripción para aplicaciones para la Plataforma universal de Windows (UWP). Los complementos de suscripción no están disponibles actualmente para la mayoría de las cuentas de desarrollador.

La biblioteca Microsoft.StoreServices proporciona la funcionalidad de este método a través de la API StoreServicesClient.RecurrenceQueryAsync.

Prerrequisitos

Para usar este método, necesitará:

  • Un token de acceso de Azure AD que tiene un URI de audiencia con el valor https://onestore.microsoft.com.
  • Clave de identificador de Microsoft Store que representa la identidad del usuario cuyas suscripciones quiere obtener.

Para obtener más información, consulte la sección Gestión de derechos de producto desde un servicio.

Solicitud

Sintaxis de la solicitud

Método Solicitud de URI
PUBLICACIÓN https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/query

Cabecera de solicitud

Cabecera Tipo Descripción
Autorización cuerda / cadena Obligatorio. El token de acceso de Azure AD en la forma Bearer<token>.
Anfitrión cuerda / cadena Debe establecerse en el valor purchase.mp.microsoft.com.
Longitud del contenido número Longitud del cuerpo de la solicitud.
Tipo de contenido cuerda / cadena Especifica el tipo de solicitud y respuesta. Actualmente, el único valor admitido es application/json.

Cuerpo de la solicitud

Parámetro Tipo Descripción Obligatorio
b2bKey cuerda / cadena La clave de identificador de Microsoft Store que representa la identidad del usuario cuyas suscripciones quiere obtener. Sí
token de continuación cuerda / cadena Si el usuario tiene derechos a varias suscripciones, el cuerpo de la respuesta devuelve un token de continuación cuando se alcanza el límite de página. Proporcione ese token de continuación aquí en las llamadas posteriores para recuperar los productos restantes. No
tamaño de página cuerda / cadena El número máximo de suscripciones a devolver en una sola respuesta. El valor predeterminado es 25. No

Ejemplo de solicitud

En el ejemplo siguiente se muestra cómo usar este método para obtener los complementos de suscripción que un usuario determinado tiene derechos de usar. Reemplace el valor de la clave b2bKey por la clave de Microsoft Store ID que representa la identidad del usuario cuyas suscripciones desea obtener.

POST https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/query HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
Host: purchase.mp.microsoft.com

{
  "b2bKey":  "eyJ0eXAiOiJ..."
}

Respuesta

Este método devuelve un cuerpo de respuesta JSON que contiene una colección de objetos de datos que describen los complementos de suscripción que el usuario tiene derechos de usar. En el ejemplo siguiente se muestra el cuerpo de la respuesta de un usuario que tiene derecho a una suscripción.

{
  "items": [
    {
      "autoRenew":true,
      "beneficiary":"pub:gFVuEBiZHPXonkYvtdOi+tLE2h4g2Ss0ZId0RQOwzDg=",
      "expirationTime":"2017-06-11T03:07:49.2552941+00:00",
      "id":"mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac",
      "lastModified":"2017-01-08T21:07:51.1459644+00:00",
      "market":"US",
      "productId":"9NBLGGH52Q8X",
      "skuId":"0024",
      "startTime":"2017-01-10T21:07:49.2552941+00:00",
      "recurrenceState":"Active"
    }
  ]
}

Cuerpo de respuesta

El cuerpo de la respuesta contiene los datos siguientes.

Importancia Tipo Descripción
Artículos arreglo Matriz de objetos que contienen datos sobre cada complemento de suscripción que el usuario especificado tiene derecho a usar. Para obtener más información sobre los datos de cada objeto, vea la tabla siguiente.

Cada objeto de la matriz de elementos contiene los siguientes valores.

Importancia Tipo Descripción
renovación automática Booleano Indica si la suscripción está configurada para renovarse automáticamente al final del período de suscripción actual.
beneficiario cuerda / cadena Identificador del beneficiario del derecho asociado a esta suscripción.
tiempo de expiración cuerda / cadena La fecha y hora en que expirará la suscripción, en formato ISO 8601. Este campo solo está disponible cuando la suscripción está en determinados estados. La hora de expiración suele indicar cuándo expira el estado actual. Por ejemplo, para una suscripción activa, la fecha de expiración indica cuándo se producirá la siguiente renovación automática.
tiempoDeExpiraciónConTolerancia cuerda / cadena La fecha y hora en que expirará la suscripción, incluido el período de gracia, en formato ISO 8601. Este valor indica cuándo el usuario perderá el acceso a la suscripción después de que la suscripción no se haya renovado automáticamente.
identificación cuerda / cadena Identificador de la suscripción. Utilice este valor para indicar qué suscripción desea modificar al llamar al método para cambiar el estado de facturación de una suscripción para un usuario.
isTrial Booleano Indica si la suscripción es una prueba.
última modificación cuerda / cadena Fecha y hora en que se modificó la suscripción por última vez, en formato ISO 8601.
mercado cuerda / cadena Código de país (en formato ISO 3166-1 alfa-2 de dos letras) en el que el usuario adquirió la suscripción.
ID de producto cuerda / cadena La id. de la Tienda del producto que representa el complemento de suscripción en el catálogo de Microsoft Store. Un ejemplo de Id. de la Tienda para un producto es 9NBLGGH42CFD.
skuId cuerda / cadena El id. de Store para el de SKU de que representa el complemento de suscripción en el catálogo de Microsoft Store. Un id. de tienda de ejemplo para una SKU es 0010.
hora de inicio cuerda / cadena Fecha y hora de inicio de la suscripción, en formato ISO 8601.
estadoDeRecurrencia cuerda / cadena Uno de los siguientes valores:
  • None: indica una suscripción perpetua.
  • Active: la suscripción está activa y el usuario tiene derecho a usar los servicios.
  • inactivo: la suscripción ha pasado la fecha de expiración y el usuario desactivó la opción de renovación automática de la suscripción.
  • cancelada: la suscripción se ha terminado intencionadamente antes de la fecha de expiración, con o sin reembolso.
  • inDunning: la suscripción está en (es decir, la suscripción está a punto de expirar y Microsoft está intentando adquirir fondos para renovar automáticamente la suscripción).
  • Falló: El período de cobro ha finalizado y la suscripción no se pudo renovar después de varios intentos.

Nota:

  • Inactivo/Cancelado/Fallido son estados terminales. Cuando una suscripción entra en uno de estos estados, el usuario debe volver a comprar la suscripción para activarla de nuevo. El usuario no tiene derecho a usar los servicios en estos estados.
  • Cuando se cancela una suscripción, el tiempo de expiración se actualizará con la fecha y hora de la cancelación.
  • El identificador de la suscripción seguirá siendo el mismo durante toda su duración. No cambiará si la opción de renovación automática está activada o desactivada. Si un usuario vuelve a comprar una suscripción después de alcanzar un estado de terminal, se creará un nuevo identificador de suscripción.
  • El identificador de una suscripción debe usarse para ejecutar cualquier operación en una suscripción individual.
  • Cuando un usuario vuelve a comprar una suscripción después de cancelarla o interrumpirla, si consulta los resultados del usuario, obtendrá dos entradas: una con el identificador de suscripción anterior en un estado de terminal y otra con el nuevo identificador de suscripción en un estado activo.
  • Siempre es recomendable comprobar recurrenceState y expirationTime, ya que las actualizaciones de recurrenceState pueden retrasarse en unos minutos (o en ocasiones horas).
fechaDeCancelación cuerda / cadena Fecha y hora en que se canceló la suscripción del usuario, en formato ISO 8601.