Saltar al contenido principal

getAllSubscriptions

Obtén todas las suscripciones disponibles. 🔐 Este método requiere autorización.

Descripción

Este método devuelve todos los planes de suscripción disponibles en el proyecto. Devuelve una Promesa que se resuelve en un array de objetos ISubscriptionEntity: objetos de suscripción completos, no marcadores.

⚠️ En versiones anteriores del SDK, este método se declaraba como que devolvía string[]. La firma provenía de swagger, mientras que el endpoint siempre ha devuelto objetos completos. Si estabas leyendo marcadores de los elementos del array, cambia al campo identifier:

const subscriptions = await Subscriptions.getAllSubscriptions();

// before: subscriptions // string[]
// now: subscriptions.map((s) => s.identifier)

getActiveSubscriptions no ha cambiado y sigue devolviendo string[].

Suscripciones.getAllSubscriptions(

);

Ejemplos

Ejemplo mínimo

const response = await Subscriptions.getAllSubscriptions();

Ejemplo de respuesta

[
{
"id": 1,
"identifier": "test_subscription",
"localizeInfos": {
"title": "Test subscription"
},
"productIds": [
3445
],
"periodInDays": 30,
"paymentAccountId": 1,
"isUsed": false
}
]

Esquema de respuesta

Esquema: ISubscriptionEntity[]

id: number
Identificador de la suscripción.
ejemplo: 1

identifier: string
Identificador textual de la suscripción (marcador).
ejemplo: "test_subscription"

localizeInfos: ILocalizeInfo
Información de suscripción localizada para el idioma actual.
ejemplo:

{ title: "Test subscription" }

productIds: number[]
Identificadores de los productos incluidos en la suscripción.
ejemplo: [3445]

periodInDays: number
Período de suscripción en días.
ejemplo: 30

paymentAccountId: number
Identificador de la cuenta de pago a través de la cual se factura la suscripción.
ejemplo: 1

isUsed: boolean
Indica si la suscripción está en uso.
ejemplo: false