Skip to main content
POST
/
rr
/
api
/
v1
/
modify-subscription-schedule
Modify Subscription Schedule
curl --request POST \
  --url https://api.meetcampfire.com/rr/api/v1/modify-subscription-schedule \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_date": "2023-12-25",
  "total_value": 0,
  "end_date": "2023-12-25",
  "mrr": 0,
  "use_daily_accounting": false,
  "use_catchup": false,
  "catchup_date": "2023-12-25",
  "modified_subscription": 123,
  "does_modify_contract_end_date": false,
  "apply_prospectively": false
}
'
[
  {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "total_value": 0,
    "id": 123,
    "original_value": 0,
    "original_mrr": 0,
    "mrr": 0,
    "original_quantity": 0,
    "quantity": 0,
    "original_rate": 0,
    "rate": 0,
    "use_daily_accounting": false,
    "is_contract_amendment": false
  }
]

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

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: -100000000 < x < 100000000
​
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: -100000000 < x < 100000000
​
use_daily_accounting
boolean
default:false

Whether to use daily (vs monthly) revenue recognition.

​
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.

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
​
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
​
use_daily_accounting
boolean
default:false
​
is_contract_amendment
boolean
default:false