Skip to main content
GET
Listar checkout links
GET /checkout/links Faz parte do recurso Links — o conceito e os estados estão lá. Devolve os templates da sua conta, do mais recente para o mais antigo, em páginas de 20 por padrão (máximo 100). Os filtros são opcionais e se somam: quem envia mais de um recebe só os Links que atendem a todos. Cada item traz o mesmo objeto de GET /checkout/links/{id}, incluindo a url pronta para divulgar.
Arquivados não somem da listagem. Sem filtro, a resposta traz active e archived juntos — arquivar muda o estado, não remove o registro. Para ver só o que está no ar, use ?status=active.
status aceita mais de um valor, separados por vírgula: ?status=active,archived. Um valor fora da lista responde 400 com os aceitos.
A listagem não diz se o Link vende. O filtro status enxerga só a sua decisão de arquivar. Um Link active com sellable: false continua aparecendo como qualquer outro — é preciso ler o campo sellable de cada item. Veja Do Link à Session.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API key unificada (z2_{live|test}{sk|pk}...) — secret (sk) para integração backend, publishable (pk) para uso no frontend público

Query Parameters

page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100
status
enum<string>[]

Situação do Link: active ou archived. Aceita vários valores, separados por vírgula ou repetindo o parâmetro. Um valor inválido responde 400 com a lista dos aceitos.

Available options:
active,
archived
mode
enum<string>

Tipo do Link: payment (cobrança única) ou subscription (assinatura). Omitido, traz os dois.

Available options:
payment,
subscription
itemName
string

Links que tenham algum item cujo nome case parcialmente com o texto. Filtra o Link, não o item.

Maximum string length: 255
trial
enum<string>

Apenas Links de assinatura com período de teste (true) ou apenas sem (false). Omitido, traz os dois.

Available options:
true,
false
sortBy
enum<string>

Campo de ordenação: createdAt ou name. Default: createdAt.

Available options:
createdAt,
name
sortDir
enum<string>

Direção da ordenação: asc ou desc. Default: desc.

Available options:
asc,
desc

Response

Lista paginada

data
object[]

Lista de registros retornados nesta página.

pagination
object

Metadados de paginação do resultado (página, limite e totais).