Skip to main content
GET
Listar assinaturas

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Página (começa em 1). Página além da última devolve data vazio e hasMore false.

Required range: x >= 1
perPage
integer
default:50

Itens por página (1 a 100; default 50).

Required range: 1 <= x <= 100
productId
string

Assinaturas cuja oferta pertence a este produto.

offerId
string

Assinaturas desta oferta.

customerEmail
string

E-mail do cliente, sem diferenciar maiúsculas e ignorando espaços nas pontas. Vazio responde 400.

customerDocument
string

CPF ou CNPJ do cliente. Compara só os dígitos: 123.456.789-09 e 12345678909 acham a mesma assinatura, gravada de qualquer um dos jeitos. Valor sem nenhum dígito responde 400.

status
enum<string>

Status da assinatura. Outro valor responde 400.

Available options:
active,
past_due,
canceled,
incomplete

Response

Lista de assinaturas

object
enum<string>
required
Available options:
list
data
object[]
required
page
integer
required
perPage
integer
required
total
integer
required
totalPages
integer
required
hasMore
boolean
required