Skip to main content
GET
/
recurring-bill-items
List recurring bill items
curl --request GET \
  --url https://api.helloproper.com/recurring-bill-items \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.helloproper.com/recurring-bill-items"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.helloproper.com/recurring-bill-items', 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.helloproper.com/recurring-bill-items",
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: <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://api.helloproper.com/recurring-bill-items"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<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://api.helloproper.com/recurring-bill-items")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helloproper.com/recurring-bill-items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "recurringBillItems": [
    {
      "id": "<string>",
      "ownerId": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "productKey": "<string>",
      "startedOn": "<string>",
      "cancelledOn": "<string>",
      "endedOn": "<string>",
      "billingCycle": {
        "timeUnit": "<string>",
        "periodLength": 123,
        "start": 123
      },
      "amountRecords": [
        {
          "id": "<string>",
          "value": {
            "currency": "<string>",
            "amount": 123
          },
          "start": "<string>"
        }
      ],
      "vatRecords": [
        {
          "id": "<string>",
          "value": {
            "taxMode": "<string>",
            "taxRate": 123
          },
          "start": "<string>"
        }
      ],
      "descriptionRecords": [
        {
          "id": "<string>",
          "value": "<string>",
          "start": "<string>"
        }
      ],
      "quantityRecords": [
        {
          "id": "<string>",
          "value": 123,
          "start": "<string>"
        }
      ]
    }
  ]
}

Request

This request supports pagination.
leaseId
string
The lease for which recurring bill items will be returned

Response

recurringBillItems
array