List Contract Bundles

Retrieve a list of contract bundles with optional filtering and sorting.

Supports including soft-deleted records for audit and recovery purposes. When include_deleted=true, returns ONLY deleted records instead of active records. Deleted records contain minimal data: ‘id’, ‘is_deleted=true’, ‘deleted_at’ timestamp, and ‘last_modified_at’. When ‘false’ or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

GET /rr/api/v1/contracts/{contract_id}/bundles

List Contract Bundles

cURL

curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/contracts/{contract_id}/bundles \
  --header 'Authorization: <api-key>'

200

[
  {
    "id": 123,
    "is_deleted": false,
    "deleted_at": "2023-11-07T05:31:56Z",
    "lines": [
      {
        "id": 123,
        "is_deleted": false,
        "deleted_at": "2023-11-07T05:31:56Z",
        "product_name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "last_modified_at": "2023-11-07T05:31:56Z",
        "customer": 123,
        "amount": 0,
        "product": 123
      }
    ],
    "bundle_name": "<string>",
    "start_date": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "last_modified_at": "2023-11-07T05:31:56Z",
    "customer": 123,
    "contract": 123,
    "end_date": "2023-12-25",
    "rebalance_journal_entries_indefinitely": false,
    "bundle_description": "<string>",
    "use_daily_accounting": true,
    "use_catchup": true,
    "catchup_date": "2023-12-25"
  }
]

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

contract_id · integer · required

Query Parameters

include_deleted · boolean · default: false

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

last_modified_at__gte · string

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__lte · string

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

Response

200 - application/json

id · integer · required · read-only

is_deleted · boolean · default: false · required · read-only

deleted_at · string<date-time> | null · required · read-only

lines · object[] · required

Show child attributes

bundle_name · string · required

Maximum string length: 250

start_date · string<date> · required

proration_method · enum<string> · required

• standard - Standard (actual month length)
• daily - Daily

Available options: standard, daily

created_at · string<date-time> · required · read-only

last_modified_at · string<date-time> · required · read-only

customer · integer · required · read-only

contract · integer · required

end_date · string<date> | null

Bundle end date. Required for standard contracts. For evergreen contracts this may be null to follow the contract timeline, or set to a billing-period end date.

rebalance_journal_entries_indefinitely · boolean · default: false

Should only be used for Evergreen contracts. When true, linked invoice journal entries are rebalanced on each evergreen contract extension.

bundle_description · string | null

Maximum string length: 250

use_daily_accounting · boolean

use_catchup · boolean

catchup_date · string<date> | null