Look up a prepaid credit balance
curl --request GET \
--url https://sendpaperplane.com/v1/credits/{code}import requests
url = "https://sendpaperplane.com/v1/credits/{code}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://sendpaperplane.com/v1/credits/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET'};
fetch('https://sendpaperplane.com/v1/credits/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sendpaperplane.com/v1/credits/{code}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://sendpaperplane.com/v1/credits/{code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sendpaperplane.com/v1/credits/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://sendpaperplane.com/v1/credits/{code}")
.asString();{
"status": "ok",
"code": "pp-ab12-cd34-ef56",
"balance_cents": 5400,
"face_cents": 5000,
"bonus_cents": 400,
"bonus_expires_at": "2027-08-23T00:00:00.000Z",
"face_expires_at": "2031-08-23T00:00:00.000Z"
}{
"status": "failed",
"code": "<string>",
"reason": "<string>",
"next": [
"<string>"
]
}Look up a prepaid credit balance
Balances are split in two: face_cents is paid-for value (5 years, per the CARD Act) and bonus_cents is promotional value (12 months, spent first).
GET
/
v1
/
credits
/
{code}
Look up a prepaid credit balance
curl --request GET \
--url https://sendpaperplane.com/v1/credits/{code}import requests
url = "https://sendpaperplane.com/v1/credits/{code}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://sendpaperplane.com/v1/credits/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET'};
fetch('https://sendpaperplane.com/v1/credits/{code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sendpaperplane.com/v1/credits/{code}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://sendpaperplane.com/v1/credits/{code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sendpaperplane.com/v1/credits/{code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://sendpaperplane.com/v1/credits/{code}")
.asString();{
"status": "ok",
"code": "pp-ab12-cd34-ef56",
"balance_cents": 5400,
"face_cents": 5000,
"bonus_cents": 400,
"bonus_expires_at": "2027-08-23T00:00:00.000Z",
"face_expires_at": "2031-08-23T00:00:00.000Z"
}{
"status": "failed",
"code": "<string>",
"reason": "<string>",
"next": [
"<string>"
]
}Path Parameters
Credit code, formatted pp-xxxx-xxxx-xxxx. Case-insensitive — the route lower-cases before lookup.
Pattern:
^[Pp][Pp]-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}$Response
Spendable balance
Allowed value:
"ok"Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Last modified on September 17, 2026
Was this page helpful?