Models

BillProperties

object

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

namestring

The name of the subscription.

Example

Rent

object_has_currency_settingbooleanread only

Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency.

Example

true

currency_idstring

The currency ID of the currency associated with this object.

Example

currency_namestring

The currency name of the currency associated with this object.

Example

Euro

currency_codestring

The currency code of the currency associated with this object.

Example

EUR

currency_symbolstringread only

Example

currency_decimal_placesinteger<int32>read only

Example

primary_currency_idstringread only

The currency ID of the administration's primary currency.

Example

primary_currency_namestringread only

The currency name of the administration's primary currency.

Example

Euro

primary_currency_codestringread only

The currency code of the administration's primary currency.

Example

EUR

primary_currency_symbolstringread only

The currency symbol of the administration's primary currency.

Example

primary_currency_decimal_placesinteger<int32>read only

The currency decimal places of the administration's primary currency.

Example

amount_minstring<amount>

The minimum amount that is expected for this subscription in the subscription's currency.

Example

123.45

pc_amount_minstring<amount>

The minimum amount that is expected for this subscription in the administration's primary currency.

Example

123.45

amount_maxstring<amount>

The maximum amount that is expected for this subscription in the subscription's currency.

Example

123.45

pc_amount_maxstring<amount>

The maximum amount that is expected for this subscription in the administration's primary currency.

Example

123.45

amount_avgstring<amount>

The average amount that is expected for this subscription in the subscription's currency.

Example

123.45

pc_amount_avgstring<amount>

The average amount that is expected for this subscription in the administration's primary currency.

Example

123.45

datestring<date-time>

Example

2026-10-01T00:00:00+00:00

end_datestring<date-time> | null

The date after which this subscription is no longer valid or applicable

Example

2026-10-31T23:59:59+00:00

extension_datestring<date-time> | null

The date before which the subscription must be renewed (or cancelled)

Example

2026-10-31T23:59:59+00:00

repeat_freqBillRepeatFrequencyweeklymonthlyquarterlyhalf-yearyearly

How often the bill must be paid.

Example

monthly

skipinteger<int32>

How often the subscription will be skipped. 1 means a bi-monthly subscription.

Example

activeboolean

If the subscription is active.

Example

true

orderinteger<int32>

Order of the subscription.

Example

notesstring | null

Example

Some example notes

object_group_idstring | null

The group ID of the group this object is part of. NULL if no group.

Example

object_group_orderinteger<int32> | nullread only

The order of the group. At least 1, for the highest sorting.

Example

object_group_titlestring | null

The name of the group. NULL if no group.

Example

Example Group

paid_datesArray<object>read only

Array of past transactions when the subscription was paid.

Show child attributes

transaction_group_idstringread only

Transaction group ID of the transaction linked to this subscription.

Example

transaction_journal_idstringread only

Transaction journal ID of the transaction linked to this subscription.

Example

datestring<date-time>read only

Date the bill was paid.

Example

2026-10-01T00:00:00+00:00

subscription_idstringread only

ID of this subscription.

Example

currency_idstring

The currency ID of the currency associated with this object.

Example

currency_namestring

The currency name of the currency associated with this object.

Example

Euro

currency_codestring

The currency code of the currency associated with this object.

Example

EUR

currency_symbolstringread only

Example

currency_decimal_placesinteger<int32>read only

Example

primary_currency_idstringread only

The currency ID of the administration's primary currency.

Example

primary_currency_namestringread only

The currency name of the administration's primary currency.

Example

Euro

primary_currency_codestringread only

The currency code of the administration's primary currency.

Example

EUR

primary_currency_symbolstringread only

The currency symbol of the administration's primary currency.

Example

primary_currency_decimal_placesinteger<int32>read only

The currency decimal places of the administration's primary currency.

Example

amountstring<amount>

The amount that was paid for this subscription in the subscription's currency.

Example

123.45

pc_amountstring<amount>

The amount that was paid for this subscription in the administration's primary currency.

Example

123.45

foreign_amountstring<amount>

The foreign amount that was paid for this subscription in the subscription's currency.

Example

123.45

pc_foreign_amountstring<amount>

The foreign amount that was paid for this subscription in the administration's primary currency.

Example

123.45

pay_datesArray<string>read only

Array of future dates when the bill is expected to be paid. Autogenerated.

next_expected_matchstring<date-time> | nullread only

When the subscription is expected to be due.

Example

2026-10-01T00:00:00+00:00

next_expected_match_diffstring | nullread only

Formatted (locally) when the subscription is due.

Example

today

Example

{
  "created_at": "2026-10-01T00:00:00+00:00",
  "updated_at": "2026-10-01T00:00:00+00:00",
  "name": "Rent",
  "object_has_currency_setting": true,
  "currency_id": "5",
  "currency_name": "Euro",
  "currency_code": "EUR",
  "currency_symbol": "$",
  "currency_decimal_places": 2,
  "primary_currency_id": "5",
  "primary_currency_name": "Euro",
  "primary_currency_code": "EUR",
  "primary_currency_symbol": "$",
  "primary_currency_decimal_places": 2,
  "amount_min": "123.45",
  "pc_amount_min": "123.45",
  "amount_max": "123.45",
  "pc_amount_max": "123.45",
  "amount_avg": "123.45",
  "pc_amount_avg": "123.45",
  "date": "2026-10-01T00:00:00+00:00",
  "end_date": "2026-10-31T23:59:59+00:00",
  "extension_date": "2026-10-31T23:59:59+00:00",
  "repeat_freq": "monthly",
  "skip": 0,
  "active": true,
  "order": 1,
  "notes": "Some example notes",
  "object_group_id": "5",
  "object_group_order": 5,
  "object_group_title": "Example Group",
  "paid_dates": [
    {
      "transaction_group_id": "123",
      "transaction_journal_id": "123",
      "date": "2026-10-01T00:00:00+00:00",
      "subscription_id": "123",
      "currency_id": "5",
      "currency_name": "Euro",
      "currency_code": "EUR",
      "currency_symbol": "$",
      "currency_decimal_places": 2,
      "primary_currency_id": "5",
      "primary_currency_name": "Euro",
      "primary_currency_code": "EUR",
      "primary_currency_symbol": "$",
      "primary_currency_decimal_places": 2,
      "amount": "123.45",
      "pc_amount": "123.45",
      "foreign_amount": "123.45",
      "pc_foreign_amount": "123.45"
    }
  ],
  "pay_dates": [
    "2026-10-01T00:00:00+00:00"
  ],
  "next_expected_match": "2026-10-01T00:00:00+00:00",
  "next_expected_match_diff": "today"
}