Skip to main content
POST
Modify Subscription Schedule

Body

start_date
string<date>
required

Start date of the subscription period.

total_value
number<double>
required

Total contract value for the subscription period.

Required range: -1000000000000000000 < x < 1000000000000000000
end_date
string<date> | null

End date of the subscription period. Defaults to 1 year from start date if not provided.

mrr
number<double>

Monthly recurring revenue. If not provided, it is calculated from total_value and the subscription period.

Required range: -1000000000000000000 < x < 1000000000000000000
use_daily_accounting
boolean
default:false

Whether to use daily (vs monthly) revenue recognition.

proration_method

Proration method. When provided, takes precedence over use_daily_accounting (DAILY↔True, STANDARD/THIRTY_DAY↔False).

  • standard - Standard (actual month length)
  • thirty_day - Fixed 30-day month
  • daily - Daily
Available options:
standard,
thirty_day,
daily
use_catchup
boolean
default:false

Enable catch-up accounting for retroactive amendments.

catchup_date
string<date> | null

Date from which to apply catch-up adjustments. Required if use_catchup is true.

modified_subscription
integer | null

ID of the existing contract subscription being modified.

does_modify_contract_end_date
boolean
default:false

Whether this modification changes the contract end date.

apply_prospectively
boolean
default:false

Apply changes prospectively from catchup_date instead of retroactively. Only valid when use_catchup is true.

billing_cadence
  • monthly - Monthly
  • quarterly - Quarterly
  • biannual - Semiannual
  • annual - Annual
Available options:
monthly,
quarterly,
biannual,
annual
billing_timing
  • advance - In advance
  • arrears - In arrears
Available options:
advance,
arrears
first_invoice_date
string<date> | null
revenue_recognition_type

Recognition type of the subscription being previewed. RATABLE keeps the monthly recognition schedule and stamps each row with its billing date. Omitted means the preview mirrors the billing installments.

  • RATABLE - Ratable
  • RELATIVE_TO_PREPAID_COMMIT - Relative to prepaid commit
Available options:
RATABLE,
RELATIVE_TO_PREPAID_COMMIT

Response

200 - application/json
start_date
string<date>
required
end_date
string<date>
required
total_value
number<double>
required
Required range: -1000000000000000000 < x < 1000000000000000000
id
integer | null
scheduled_invoice_date
string<date> | null
original_value
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
original_mrr
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
mrr
number<double>
Required range: -1000000000000000000 < x < 1000000000000000000
original_quantity
number<double> | null
Required range: -100000000000000 < x < 100000000000000
quantity
number<double> | null
Required range: -100000000000000 < x < 100000000000000
original_rate
number<double> | null
Required range: -10000000000000 < x < 10000000000000
rate
number<double> | null
Required range: -10000000000000 < x < 10000000000000
billed_amount
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
use_daily_accounting
boolean
default:false
is_contract_amendment
boolean
default:false