Pular para o conteúdo principal

getAllSubscriptions

Obtenha todas as assinaturas disponíveis. 🔐 Este método requer autorização.

Descrição

Este método retorna todos os planos de assinatura disponíveis no projeto. Ele retorna uma Promise que resolve para um array de objetos ISubscriptionEntity - objetos de assinatura completos, não marcadores.

⚠️ Em versões anteriores do SDK, este método foi declarado como retornando string[]. A assinatura veio do swagger, enquanto o endpoint sempre retornou objetos completos. Se você estava lendo marcadores dos elementos do array, mude para o campo identifier deles:

const subscriptions = await Subscriptions.getAllSubscriptions();

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

getActiveSubscriptions permanece inalterado e ainda retorna string[].

Assinaturas.getAllSubscriptions(

);

Exemplos

Exemplo mínimo

const response = await Subscriptions.getAllSubscriptions();

Exemplo de resposta

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

Esquema de resposta

Esquema: ISubscriptionEntity[]

id: number
Identificador da assinatura.
exemplo: 1

identifier: string
Identificador textual da assinatura (marcador).
exemplo: "test_subscription"

localizeInfos: ILocalizeInfo
Informações da assinatura localizadas para o idioma atual.
exemplo:

{ title: "Test subscription" }

productIds: number[]
Identificadores dos produtos incluídos na assinatura.
exemplo: [3445]

periodInDays: number
Período da assinatura em dias.
exemplo: 30

paymentAccountId: number
Identificador da conta de pagamento pela qual a assinatura é cobrada.
exemplo: 1

isUsed: boolean
Indica se a assinatura está em uso.
exemplo: false