Skip to main content
GET
Buscar um checkout de assinatura
Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via Criar checkout de assinatura.
Requer a permissão SUBSCRIPTION:READ.
O formato da resposta é o mesmo do Buscar um Checkout. Informe ao menos um entre id, externalId e customerId.
Até 23/09/2026, checkouts de assinatura também saíam pelo GET /checkouts/get. Essa rota agora retorna apenas checkouts de pagamento único e links de pagamento. Veja o changelog.
Valores de status: Depois do pagamento, use Listar assinaturas com checkoutId para encontrar as assinaturas geradas por este checkout.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

id
string

Identificador único do checkout de assinatura

Example:

"bill_abc123xyz"

externalId
string

Identificador do checkout no seu sistema

Example:

"assinatura-123"

customerId
string

Identificador do cliente associado

Example:

"cust_abc123xyz"

method
enum<string>

Método de pagamento. Casa o checkout que oferece este método, mesmo que ofereça outros também.

Available options:
PIX,
CARD

Response

Checkout de assinatura encontrado com sucesso.

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true