FIfirefly-iii
bills

Update existing subscription.

Changed on

Update existing subscription.

put/v1/subscriptions/{id}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/subscriptions/{id}
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Path parameters

idstring required
Example:123

The ID of the subscription.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

currency_idstring string

Use either currency_id or currency_code

currency_codestring string

Use either currency_id or currency_code

namestring string required
amount_minstring amount
amount_maxstring amount
datestring date-time
end_datestring date-time

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

extension_datestring date-time

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

repeat_freq'weekly' | 'monthly' | 'quarterly' | 'half-year' | 'yearly' string

How often the bill must be paid.

skipinteger

How often the bill must be skipped. 1 means a bi-monthly bill.

activeboolean

If the bill is active.

notesstring string nullable
object_group_idstring string nullable

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

object_group_titlestring string nullable

The name of the group. NULL if no group.

Example request

{
  "currency_id": "5",
  "currency_code": "EUR",
  "name": "Rent",
  "amount_min": "123.45",
  "amount_max": "123.45",
  "date": "2026-08-01T00:00:00+00:00",
  "end_date": "2026-08-31T23:59:59+00:00",
  "extension_date": "2026-08-31T23:59:59+00:00",
  "repeat_freq": "monthly",
  "active": true,
  "notes": "Some example notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}

Response

Updated subscription stored, result in response

Example response

{
  "data": {
    "type": "bills",
    "id": "2",
    "attributes": {
      "created_at": "2026-08-01T00:00:00+00:00",
      "updated_at": "2026-08-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-08-01T00:00:00+00:00",
      "end_date": "2026-08-31T23:59:59+00:00",
      "extension_date": "2026-08-31T23:59:59+00:00",
      "repeat_freq": "monthly",
      "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-08-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-08-01T00:00:00+00:00"
      ],
      "next_expected_match": "2026-08-01T00:00:00+00:00",
      "next_expected_match_diff": "today"
    }
  }
}

Changes