curl --request GET \
--url https://app.sure.am/api/v1/recurring_transactions/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.sure.am/api/v1/recurring_transactions/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.sure.am/api/v1/recurring_transactions/{id}', 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://app.sure.am/api/v1/recurring_transactions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$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://app.sure.am/api/v1/recurring_transactions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/recurring_transactions/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sure.am/api/v1/recurring_transactions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"amount_cents": 123,
"currency": "<string>",
"expected_day_of_month": 16,
"last_occurrence_date": "2023-12-25",
"next_expected_date": "2023-12-25",
"status": "suggested",
"occurrence_count": 1,
"manual": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"payment_url": "<string>",
"autopay": true,
"notes": "<string>",
"bill_type": "bill",
"category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"anchor_date": "2023-12-25",
"weekend_adjust": "none",
"end_mode": "never",
"end_on": "2023-12-25",
"end_after_count": 123,
"renews_on": "2023-12-25",
"trial_ends_on": "2023-12-25",
"cancelled_on": "2023-12-25",
"recurrence_rules": [
{
"frequency": "weekly",
"interval": 123,
"day_of_month": 123,
"weekday": 123,
"weekday_ordinal": 123,
"month_of_year": 123
}
],
"expected_amount_min": "<string>",
"expected_amount_min_cents": 123,
"expected_amount_max": "<string>",
"expected_amount_max_cents": 123,
"expected_amount_avg": "<string>",
"expected_amount_avg_cents": 123,
"account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"account_type": "<string>",
"status": "<string>"
},
"merchant": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}Retrieve recurring transaction
curl --request GET \
--url https://app.sure.am/api/v1/recurring_transactions/{id} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.sure.am/api/v1/recurring_transactions/{id}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.sure.am/api/v1/recurring_transactions/{id}', 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://app.sure.am/api/v1/recurring_transactions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$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://app.sure.am/api/v1/recurring_transactions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/recurring_transactions/{id}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sure.am/api/v1/recurring_transactions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"amount_cents": 123,
"currency": "<string>",
"expected_day_of_month": 16,
"last_occurrence_date": "2023-12-25",
"next_expected_date": "2023-12-25",
"status": "suggested",
"occurrence_count": 1,
"manual": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"payment_url": "<string>",
"autopay": true,
"notes": "<string>",
"bill_type": "bill",
"category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"anchor_date": "2023-12-25",
"weekend_adjust": "none",
"end_mode": "never",
"end_on": "2023-12-25",
"end_after_count": 123,
"renews_on": "2023-12-25",
"trial_ends_on": "2023-12-25",
"cancelled_on": "2023-12-25",
"recurrence_rules": [
{
"frequency": "weekly",
"interval": 123,
"day_of_month": 123,
"weekday": 123,
"weekday_ordinal": 123,
"month_of_year": 123
}
],
"expected_amount_min": "<string>",
"expected_amount_min_cents": 123,
"expected_amount_max": "<string>",
"expected_amount_max_cents": 123,
"expected_amount_avg": "<string>",
"expected_amount_avg_cents": 123,
"account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"account_type": "<string>",
"status": "<string>"
},
"merchant": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}{
"error": "<string>",
"message": "<string>",
"details": [
"<string>"
],
"errors": [
"<string>"
]
}Authorizations
API key for authentication. Generate one from your account settings.
Path Parameters
Recurring transaction ID
Response
recurring transaction retrieved
Amount in currency minor units
1 <= x <= 31suggested, active, paused, inactive, ended x >= 0Link to the biller portal where this bill is paid. Only http and https are accepted; a bare host is stored as https.
Whether this bill pays itself automatically.
Free-text notes shown alongside the bill.
What kind of obligation this is.
bill, subscription, installment, income, transfer, other Reference occurrence that phases every-N cadences.
none, skip, before, after never, on_date, after_count Repetition patterns; multiple rows express semimonthly and similar multi-pattern cadences. Empty means legacy monthly on expected_day_of_month.
Show child attributes
Show child attributes
Minimum expected amount in currency minor units
Maximum expected amount in currency minor units
Average expected amount in currency minor units
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?