Resources
- Tenancies
- Leases
- Bills
- Pending bills
- Payments
- Payouts
- Recurring bill items
- One time bill items
- Transactions
- Products
- Contacts
- Rent adjustment
- Categories
List recurring bill items
curl --request GET \
--url https://api.helloproper.com/recurring-bill-items \
--header 'Authorization: <api-key>'{
"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.
The lease for which recurring bill items will be returned
Response
The unique identifier for the recurring bill item
The identifier for the owner associated with the recurring bill item
The identifier for the lease associated with the recurring bill item
The creation date and time of the recurring bill item in ISO 8601 format
The last modification date and time of the recurring bill item in ISO 8601 format
The key or identifier for the product or service billed (e.g., “key:rent”)
First due date for the recurring bill item in ISO 8601 format
The date in ISO 8601 format on which recurring bill item is stopped from being billed
The date in ISO 8601 format on which recurring bill item ends billing
The unique identifier for the amount record
The date in ISO 8601 format from which the amount is valid
curl --request GET \
--url https://api.helloproper.com/recurring-bill-items \
--header 'Authorization: <api-key>'{
"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>"
}
]
}
]
}