v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Revenue Recognition

Partial Update Contract Subscription

patch/rr/api/v1/contracts/{contract_id}/subscriptions/{id}

Path parameters

contract_idinteger required

idinteger required

Request body

idinteger

is_deletedboolean

deleted_atstring date-time nullable

linesstring

product_namestring

product_is_renewableboolean nullable

product_bundlestring

product_bundle_namestring

total_valuenumber double

last_modified_atstring date-time

ratenumber double nullable

quantitynumber double nullable

renewal_behavior'FOLLOW_CONTRACT' | 'FIXED_END'

FOLLOW_CONTRACT - Follow Contract
FIXED_END - Fixed End Date

period_amountnumber double nullable

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.

invoiced_amount_migrationnumber double nullable

Migration-only: total amount already invoiced in a prior system. When provided, marks revenue transactions as migration-invoiced up to this amount.

is_contract_amendmentboolean

start_datestring date nullable

end_datestring date nullable

mrrnumber double nullable

discountnumber double nullable

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

notesstring nullable

use_daily_accountingboolean

proration_method'standard' | 'thirty_day' | 'daily'

standard - Standard (actual month length)
thirty_day - Fixed 30-day month
daily - Daily

use_catchupboolean

catchup_datestring date nullable

catchup_manually_overriddenboolean

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'FIXED_RATE' | 'FIXED_QUANTITY'

FIXED_RATE - Fixed Rate
FIXED_QUANTITY - Fixed Quantity

created_atstring date-time

source'SALESFORCE' | 'HUBSPOT' | 'STRIPE' | 'MANUAL'

SALESFORCE - Salesforce
HUBSPOT - Hubspot
STRIPE - Stripe
MANUAL - Manual

external_idstring nullable

rates_are_netboolean

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.

customerinteger

contractinteger

productinteger nullable

modified_subscriptioninteger nullable

Response

idinteger required

is_deletedboolean required

deleted_atstring date-time nullable required

linesstring required

product_namestring required

product_is_renewableboolean nullable required

product_bundlestring required

product_bundle_namestring required

total_valuenumber double required

last_modified_atstring date-time required