The Charge object

idstringrequired

typestringrequired

Possible values: [charges]

attributes required

descriptionsnakecase

The type of charge in a snake_case format. Common values include rent, holding_deposit, security_deposit, upfront_rent, pet_rent, but other values may also be possible.

Example: rent

amountinteger

The amount of the charge in pence.

Example: 250000

frequencyduration

The interval for the charge, represented in ISO 8601 Duration format (e.g., 'P1M' for one month, 'P1W' for one week).

Example: P1M

part_of_referencingboolean

Indicates if the charge should be considered as part of referencing.

Example: true

part_of_initial_paymentboolean

Indicates if the charge is part of the initial payment.

Example: false

metadataobject

Additional metadata for the charge

Example: {"field_1":"value1","field_2":"value2"}

created_atdate-time

updated_atdate-time

The Charge object

{
  "id": "string",
  "type": "charges",
  "attributes": {
    "description": "rent",
    "amount": 250000,
    "frequency": "P1M",
    "part_of_referencing": true,
    "part_of_initial_payment": false,
    "metadata": {
      "field_1": "value1",
      "field_2": "value2"
    },
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  }
}