curl --request GET \
--url https://api.abacatepay.com/v2/subscriptions/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/subscriptions/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.abacatepay.com/v2/subscriptions/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.abacatepay.com/v2/subscriptions/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.abacatepay.com/v2/subscriptions/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.abacatepay.com/v2/subscriptions/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "subs_abc123xyz",
"checkoutId": "bill_abc123xyz",
"customerId": "cust_abc123xyz",
"amount": 10000,
"status": "ACTIVE",
"method": "CARD",
"coupons": [],
"devMode": false,
"trialDays": null,
"trialEndsAt": null,
"retryPolicy": {
"maxRetry": 3,
"retryEvery": 1
},
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z"
}
],
"success": true,
"error": null,
"pagination": {
"hasMore": true,
"next": "<string>",
"before": "<string>"
}
}{
"error": "Token de autenticação inválido ou ausente."
}Listar assinaturas
Retorna as assinaturas (subs_...) da sua loja, com paginação por cursor.
A assinatura só existe depois que o cliente paga o checkout de assinatura. Para listar os checkouts de assinatura (bill_...), inclusive os que ainda não foram pagos, use GET /subscriptions/checkouts/list.
Cada assinatura traz o checkoutId do checkout que a originou. Um mesmo checkout pode gerar várias assinaturas, uma por cliente que o pagou; use o filtro checkoutId para encontrá-las.
curl --request GET \
--url https://api.abacatepay.com/v2/subscriptions/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/subscriptions/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.abacatepay.com/v2/subscriptions/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.abacatepay.com/v2/subscriptions/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.abacatepay.com/v2/subscriptions/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.abacatepay.com/v2/subscriptions/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "subs_abc123xyz",
"checkoutId": "bill_abc123xyz",
"customerId": "cust_abc123xyz",
"amount": 10000,
"status": "ACTIVE",
"method": "CARD",
"coupons": [],
"devMode": false,
"trialDays": null,
"trialEndsAt": null,
"retryPolicy": {
"maxRetry": 3,
"retryEvery": 1
},
"createdAt": "2024-11-04T18:38:28.573Z",
"updatedAt": "2024-11-04T18:38:28.573Z"
}
],
"success": true,
"error": null,
"pagination": {
"hasMore": true,
"next": "<string>",
"before": "<string>"
}
}{
"error": "Token de autenticação inválido ou ausente."
}subs_...) da sua loja.
SUBSCRIPTION:READ.limit, after e before para paginar e startDate/endDate (YYYY-MM-DD) para filtrar por data de criação. Consulte Paginação e filtro por data.
bill_...), inclusive os que ainda não foram pagos, use Listar checkouts de assinatura.Encontrar as assinaturas de um checkout
Cada assinatura traz ocheckoutId do checkout de assinatura que a originou. Um mesmo checkout pode gerar várias assinaturas, uma por cliente que o pagou. Para encontrá-las, filtre por checkoutId:
GET /v2/subscriptions/list?checkoutId=bill_abc123xyz
checkoutId que não existe retorna lista vazia.
Filtros
| Parâmetro | Descrição |
|---|---|
status | ACTIVE ou CANCELLED |
checkoutId | Checkout de assinatura (bill_...) que originou a assinatura |
status:
| Valor | Significado |
|---|---|
ACTIVE | Assinatura ativa, com cobranças automáticas a cada ciclo |
CANCELLED | Cancelada; nenhuma cobrança futura é gerada |
Authorizations
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
Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).
Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).
Quantidade de itens por página (1-100).
1 <= x <= 100100
Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).
"2026-01-01"
Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).
"2026-01-31"
Filtrar por status da assinatura
ACTIVE, CANCELLED Filtrar pelo checkout de assinatura que originou a assinatura. Um checkout inexistente retorna lista vazia.
"bill_abc123xyz"
Was this page helpful?