Skip to main content
GET
Buscar uma assinatura
Retorna os dados de uma assinatura (subs_...).
Requer a permissão SUBSCRIPTION:READ.
Informe ao menos um destes filtros: Sem nenhum deles, a API retorna Provide id, externalId or customerId. Quando o filtro casa mais de uma assinatura (por exemplo, um cliente com várias), a mais recente é retornada. O campo checkoutId da resposta aponta o checkout de assinatura (bill_...) que originou a assinatura.
Para buscar o checkout de assinatura (bill_...), antes ou depois do pagamento, use Buscar checkout de assinatura.

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 da assinatura

Example:

"subs_abc123xyz"

externalId
string

externalId informado ao criar o checkout de assinatura que originou a assinatura

Example:

"assinatura-123"

customerId
string

Identificador do cliente dono da assinatura

Example:

"cust_abc123xyz"

Response

Assinatura encontrada com sucesso.

data
object

Dados de uma assinatura (subs_...). Existe a partir do pagamento do checkout de assinatura que a originou (checkoutId).

error
string | null
Example:

null

success
boolean

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

Example:

true