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>"
        }
      ]
    }
  ]
}

GET

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.

leaseId

string

The lease for which recurring bill items will be returned

Response

recurringBillItems

array

Show child attributes

string

The unique identifier for the recurring bill item

ownerId

string

The identifier for the owner associated with the recurring bill item

leaseId

string

The identifier for the lease associated with the recurring bill item

created

date

The creation date and time of the recurring bill item in ISO 8601 format

modified

date

The last modification date and time of the recurring bill item in ISO 8601 format

productKey

string

The key or identifier for the product or service billed (e.g., “key:rent”)

startedOn

date

First due date for the recurring bill item in ISO 8601 format

cancelledOn

date

The date in ISO 8601 format on which recurring bill item is stopped from being billed

endedOn

date

The date in ISO 8601 format on which recurring bill item ends billing

billingCycle

object

Show child attributes

timeUnit

string

Time unit based on which the billing cycle is calculated (“Month”)

periodLength

integer

The number of time units in the billing cycle (e.g., 1 month, 3 months)

start

integer

Index of a month when the billing cycle starts (e.g., 1 for January)

amountRecords

array

Show child attributes

string

The unique identifier for the amount record

value

object

The amount charged for the recurring bill item

Show child attributes

currency

string

The currency code for the recurring bill item amount (e.g., “DKK”)

amount

number

The amount of the recurring bill item amount (e.g., 100.00)

start

date

The date in ISO 8601 format from which the amount is valid

vatRecords

array

Show child attributes

string

The unique identifier for the VAT Record

value

object

The VAT details for the recurring bill item

Show child attributes

taxMode

string

The tax mode for the VAT (e.g., “Exempt”, “Exclusive”)

taxRate

number

The tax rate for the VAT (e.g., 0.25)

start

date

The date in ISO 8601 format from which the VAT is valid

descriptionRecords

array

Show child attributes

string

The unique identifier for the description record

value

string

The content of the description that is going to be put on the bill

start

date

The date in ISO 8601 format from which the description is valid

quantityRecords

array

Show child attributes

string

The unique identifier for the quantity record

value

Number

The quantity of items that is going to be put on the bill

start

date

The date in ISO 8601 format from which the quantity is valid

The recurring bill item object Create recurring bill item

Documentation Index

​Request

​Response

Request

Response