API ReferenceSubscription Change Requests

Add Changes

View as Markdown
Add changes to a draft change request. Changes can be added to change requests in draft or ready state. Adding changes to a ready change request will revert it to draft state.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired
request_idstringRequired
account_idstringRequired

Request

This endpoint expects an object.
item_changeslist of objects or nullOptional
Item changes to add
coupon_changeslist of objects or nullOptional
Coupon changes to add
balance_changeslist of objects or nullOptional
Balance changes to add
trial_behaviorenum or nullOptional

How to treat an ongoing trial when the change is applied. ‘preserve’ (the default) keeps the trial’s original end date and applies the change in place, so the customer keeps the trial time they were promised and is first charged at the new price when the trial ends. ‘end_now’ ends the trial immediately and bills the first period at the new price straight away. Ignored when the subscription has no trial time remaining.

Response

Successful Response
change_requestobject
Response containing a change request.
changes_addedinteger

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error