FIfirefly-iii
bills

List all rules associated with the subscription.

Changed on

This endpoint will list all rules that have an action to set the subscription (bill) to this subscription.

get/v1/subscriptions/{id}/rules

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/subscriptions/{id}/rules
  • 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.

Response

A list of rules

Example response

{
  "data": [
    {
      "type": "rules",
      "id": "2",
      "attributes": {
        "created_at": "2026-08-01T00:00:00+00:00",
        "updated_at": "2026-08-01T00:00:00+00:00",
        "title": "First rule title.",
        "description": "First rule description",
        "rule_group_id": "81",
        "rule_group_title": "New rule group",
        "order": 5,
        "trigger": "store-journal",
        "active": true,
        "strict": true,
        "triggers": [
          {
            "id": "2",
            "created_at": "2026-08-01T00:00:00+00:00",
            "updated_at": "2026-08-01T00:00:00+00:00",
            "type": "user_action",
            "value": "tag1",
            "order": 5,
            "active": true
          }
        ],
        "actions": [
          {
            "id": "2",
            "created_at": "2026-08-01T00:00:00+00:00",
            "updated_at": "2026-08-01T00:00:00+00:00",
            "type": "set_category",
            "value": "Daily groceries",
            "order": 5,
            "active": true
          }
        ]
      },
      "links": {
        "0": {
          "rel": "self",
          "uri": "/OBJECTS/1"
        },
        "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 20,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "links": {
    "self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4",
    "first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1",
    "next": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=3",
    "prev": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=2",
    "last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"
  }
}

Changes