Skip to main content
GET
Listar assinaturas

Authorizations

Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Query Parameters

customer
string

Filtrar pelo ID do cliente (TypeID com prefixo cus_).

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02p"

status
enum<string>

Filtrar por status da assinatura.

Available options:
pending,
active,
inactive,
suspended
limit
integer
default:20

Resultados por página

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

Cursor para próxima página

Response

Lista de assinaturas

Lista paginada de assinaturas.

object
enum<string>
required

Tipo do objeto. Sempre 'list'.

Available options:
list
Example:

"list"

data
object[]
required

Assinaturas retornadas.

has_more
boolean
required

Indica se existem mais páginas de resultados.

Example:

false

url
string<uri-reference>
required

Endpoint da listagem.

Example:

"/api/v1/subscriptions"