Skip to main content
GET
/
rr
/
api
/
v1
/
contracts
/
{contract_id}
/
subscriptions
List Contract Subscriptions
curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/contracts/{contract_id}/subscriptions \
  --header 'Authorization: <api-key>'
[
  {
    "id": 123,
    "is_deleted": false,
    "deleted_at": "2023-11-07T05:31:56Z",
    "lines": "<string>",
    "product_name": "<string>",
    "product_is_renewable": true,
    "product_bundle": "<string>",
    "product_bundle_name": "<string>",
    "contract_product_bundle": {
      "id": 123,
      "source_bundle_name": "<string>",
      "total_amount": 0,
      "lines": [
        {
          "id": 123,
          "product": 123,
          "product_name": "<string>",
          "amount": 0,
          "percentage": "<string>",
          "original_percentage": 0
        }
      ],
      "source_bundle": 123,
      "currency": "<string>"
    },
    "total_value": 0,
    "last_modified_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "customer": 123,
    "contract": 123,
    "rate": 0,
    "quantity": 0,
    "period_amount": 0,
    "is_contract_amendment": true,
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "mrr": 0,
    "discount": 5000000000000,
    "notes": "<string>",
    "use_daily_accounting": true,
    "use_catchup": true,
    "catchup_date": "2023-12-25",
    "catchup_manually_overridden": true,
    "external_id": "<string>",
    "rates_are_net": true,
    "product": 123,
    "modified_subscription": 123
  }
]

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
string
required
read-only
​
product_name
string
required
read-only
​
product_is_renewable
boolean | null
required
read-only
​
product_bundle
string
required
read-only
​
product_bundle_name
string
required
read-only
​
contract_product_bundle
object
required

Read-only serializer for ContractProductBundle in milestone responses.

​
total_value
number<double>
required
read-only
Required range: -1000000000000000000 < x < 1000000000000000000
​
last_modified_at
string<date-time>
required
read-only
​
created_at
string<date-time>
required
read-only
​
customer
integer
required
read-only
​
contract
integer
required
​
rate
number<double> | null
Required range: -10000000000000 < x < 10000000000000
​
quantity
number<double> | null
Required range: -100000000000000 < x < 100000000000000
​
renewal_behavior
enum<string>

Controls how this subscription ends. FOLLOW_CONTRACT extends with the evergreen contract's rolling end boundary (working_end_date / effective_end_date). FIXED_END keeps an explicit subscription end_date. Default is FIXED_END.

  • FOLLOW_CONTRACT - Follow Contract
  • FIXED_END - Fixed End Date
Available options:
FOLLOW_CONTRACT,
FIXED_END
​
period_amount
number<double> | null

Evergreen-only input amount per billing period (for example 10000.00 for a quarterly period). Provide this to auto-generate lines for evergreen subscriptions. Ignored for non-evergreen writes.

Required range: -1000000000000000000 < x < 1000000000000000000
​
is_contract_amendment
boolean
​
start_date
string<date> | null
​
end_date
string<date> | null
​
mrr
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
​
discount
number<double> | null

Per-unit discount in contract currency. Line amount is Quantity × (Rate − Discount). Null when no discount is configured.

Required range: 0 <= x < 10000000000000
​
notes
string | null
​
use_daily_accounting
boolean
​
proration_method
enum<string>
  • standard - Standard (actual month length)
  • thirty_day - Fixed 30-day month
  • daily - Daily
Available options:
standard,
thirty_day,
daily
​
use_catchup
boolean
​
catchup_date
string<date> | null
​
catchup_manually_overridden
boolean

True when a user explicitly set use_catchup or catchup_date via the modal. Suppresses automatic reconciliation by integration syncs so the user's choice survives.

​
invoice_calculation
enum<string>

Fixed Rate: rate stays constant, quantity calculated. Fixed Quantity: quantity stays constant (e.g., seats), rate calculated.

  • FIXED_RATE - Fixed Rate
  • FIXED_QUANTITY - Fixed Quantity
Available options:
FIXED_RATE,
FIXED_QUANTITY
​
source
enum<string>
  • SALESFORCE - Salesforce
  • HUBSPOT - Hubspot
  • STRIPE - Stripe
  • MANUAL - Manual
Available options:
SALESFORCE,
HUBSPOT,
STRIPE,
MANUAL
​
external_id
string | null
Maximum string length: 250
​
rates_are_net
boolean

When True, this subscription's rate and waterfall amounts already reflect post-discount (net) pricing. Prevents invoice creation from double-counting discounts via a separate Discount RevenueTransaction.

​
product
integer | null
​
modified_subscription
integer | null