Listar checkout links
Lista paginada dos seus templates de cobrança, com filtros por status, tipo e nome de item.
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.
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.Exemplo
Authorizations
API key unificada (z2_{live|test}{sk|pk}...) — secret (sk) para integração backend, publishable (pk) para uso no frontend público
Query Parameters
Página da listagem. Padrão: 1.
x >= 1Itens por página. Padrão: 20. Máximo: 100.
1 <= x <= 100Situaçã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.
active, archived Tipo do Link: payment (cobrança única) ou subscription (assinatura). Omitido, traz os dois.
payment, subscription Links que tenham algum item cujo nome case parcialmente com o texto. Filtra o Link, não o item.
255Apenas Links de assinatura com período de teste (true) ou apenas sem (false). Omitido, traz os dois.
true, false Campo de ordenação: createdAt ou name. Default: createdAt.
createdAt, name Direção da ordenação: asc ou desc. Default: desc.
asc, desc