curl --request GET \
--url https://api.abacatepay.com/v2/subscriptions/get \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/subscriptions/get"
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/get', 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/get",
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/get"
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/get")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/get")
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"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found"
}Buscar uma assinatura
Retorna os dados de uma assinatura (subs_...).
Informe ao menos um entre id, externalId e customerId. 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.
Para buscar o checkout de assinatura (bill_...), use GET /subscriptions/checkouts/get.
curl --request GET \
--url https://api.abacatepay.com/v2/subscriptions/get \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.abacatepay.com/v2/subscriptions/get"
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/get', 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/get",
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/get"
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/get")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/get")
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"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found"
}subs_...).
SUBSCRIPTION:READ.| Parâmetro | Descrição |
|---|---|
id | ID da assinatura (subs_...) |
externalId | O externalId que você informou ao criar o checkout de assinatura |
customerId | ID do cliente (cust_...) |
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.
bill_...), antes ou depois do pagamento, use Buscar checkout de assinatura.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
Identificador único da assinatura
"subs_abc123xyz"
externalId informado ao criar o checkout de assinatura que originou a assinatura
"assinatura-123"
Identificador do cliente dono da assinatura
"cust_abc123xyz"
Was this page helpful?