Listar assinantes

Escopo: subscriptions:read — Assinantes, com dados de contato e CPF/CNPJ do responsável.

Assinantes do estabelecimento, paginados por cursor. Todos os parâmetros vão na query string e são opcionais.

parâmetro
bizIduid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais
statusseparados por vírgula: PENDING, ACTIVE, CANCELLED, INCOMPLETE. Padrão: PENDING,ACTIVE,CANCELLED
dateFieldcreationDate (padrão) ou expireDate — campo do intervalo e da ordenação
from, toISO 8601; sem offset é horário do negócio. from inclusivo, to exclusivo
limit1 a 200, padrão 50
cursorpagination.nextCursor da página anterior

Paginação

  • Ordem: dateField crescente, desempate pelo id — estável. Assinante novo entra no fim; paginando até hasMore: false vêm todos, sem repetir nem pular.
  • O cursor só vale com os mesmos filtros (bizId, status, dateField, from, to); trocar algum responde 400. O limit pode mudar entre páginas.

Campos

  • INCOMPLETE é pré-assinatura ainda não aprovada pelo estabelecimento; só vem se pedida.
  • subscriberName é o assinante; client.name é o responsável financeiro. Só diferem quando o assinante é menor de idade.
  • priceCents é o valor gravado na assinatura. plan vem null no plano padrão ou se o plano foi apagado; quando plan.priceCents é maior que zero, é ele que vai para a fatura.
  • Datas no fuso do negócio; qualquer uma pode vir null. Com dateField=expireDate, assinatura sem expireDate não aparece.
  • Assinatura excluída no app some da lista.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

uid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais.

string

Separados por vírgula: PENDING, ACTIVE, CANCELLED, INCOMPLETE. Padrão: PENDING,ACTIVE,CANCELLED.

string
enum
Defaults to creationDate

Campo do intervalo e da ordenação.

Allowed:
string

ISO 8601, inclusivo. Sem offset é horário do negócio.

string

ISO 8601, exclusivo.

integer
1 to 200
Defaults to 50

Itens por página.

string

pagination.nextCursor da página anterior. Só vale com os mesmos filtros; trocar algum responde 400.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json