Products
Este endpoint retorna todos os produtos cadastrados na plataforma, incluindo a quantidade de assinaturas com acesso liberado.
Observação importante:
Uma assinatura possui dois tipos de status:
Status de acesso: indica se o aluno está com acesso ativo ou inativo na plataforma. É esse status que efetivamente controla o bloqueio ou liberação de acesso ao conteúdo.
Status da assinatura: pode assumir valores como active, inactive, refunded, chargeback ou canceled.
É importante destacar que um aluno pode estar com o acesso liberado, mesmo que o status da assinatura esteja como canceled ou refunded.
Portanto, o campo de quantidade retornado por este endpoint considera apenas os alunos com acesso liberado, independentemente do status da assinatura.
The request has succeeded.
Access is unauthorized.
Client error
Server error
GET /api/v1/products HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"id": "text",
"title": "text",
"description": "text",
"period": 1,
"external_checkout_product": "text",
"lifetime": true,
"status": "active",
"type": "recurring",
"sales_page_url": "text",
"support_email": "text",
"trial": "text",
"upsell": "text",
"upsell_url": "text",
"created_at": "text",
"updated_at": "text",
"subscribers": {
"active": 1,
"inactive": 1
}
}
],
"links": {
"first": "text",
"last": "text",
"prev": "text",
"next": "text"
},
"meta": {
"first": "text",
"last": "text",
"prev": "text",
"next": "text"
}
}Este endpoint retorna retorna um produto pro ID cadastrado na plataforma, incluindo a quantidade de assinaturas com acesso liberado.
Observação importante:
Uma assinatura possui dois tipos de status:
Status de acesso: indica se o aluno está com acesso ativo ou inativo na plataforma. É esse status que efetivamente controla o bloqueio ou liberação de acesso ao conteúdo.
Status da assinatura: pode assumir valores como active, inactive, refunded, chargeback ou canceled.
É importante destacar que um aluno pode estar com o acesso liberado, mesmo que o status da assinatura esteja como canceled ou refunded.
Portanto, o campo de quantidade retornado por este endpoint considera apenas os alunos com acesso liberado, independentemente do status da assinatura.
Caso o produto não seja encontrado, será lançada a exceção ProductNotFoundException.
The request has succeeded.
Access is unauthorized.
The server cannot find the requested resource.
Client error
Server error
GET /api/v1/products/{product_id} HTTP/1.1
Host: api.themembers.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"id": "text",
"title": "text",
"description": "text",
"period": 1,
"external_checkout_product": "text",
"lifetime": true,
"status": "active",
"type": "recurring",
"sales_page_url": "text",
"support_email": "text",
"trial": "text",
"upsell": "text",
"upsell_url": "text",
"created_at": "text",
"updated_at": "text",
"subscribers": {
"active": 1,
"inactive": 1
}
}
}Last updated