You are viewing the documentation for Chargebee API V2. If you're using the older version (V1), click here.

Time Machine is a simulation feature which imitates the key characteristics, behaviours and functions of the billing configurations. It is a virtual time travelling tool which facilitates the integration testing process by carrying out subscription renewals, dunning, webhooks etc on a hypothetical time frame.

You can use Time Machine in the test site to verify if the billing rules configured in your site adhere to your expectations before executing them in real time. This feature can be used in both API and UI versions.

View this doc for more details.

Note: Inorder to use the Time Machine via API , you need to first "enable" the Time Travel option which is available under the "Settings"-> "Configuration & Data" option.

Sample time machine [ JSON ]

{ "destination_time": 1585065021, "genesis_time": 1585065021, "name": "delorean", "object": "time_machine", "time_travel_status": "succeeded" }

API Index URL GET

https://{site}.chargebee.com/api/v2/time_machines
name
string, default=delorean, max chars=50
The name of the time machine. Currently only delorean is allowed.
time_travel_status
enumerated string, default=not_enabled
The current status of time travel.
Possible values are
not_enabledTime travel has not been enabled for the site.in_progressTime travel is in progress.succeededTime travel has succeeded.failedTime travel has failed. Check the failure code and failure reason attributes for further details.
Note: The time machine needs to be reset by starting afresh again.
genesis_time
timestamp(UTC) in seconds
The start time of the time machine. Specified when 'starting afresh'.
destination_time
timestamp(UTC) in seconds
The destination time to which the time machine is travelling (or has traveled).
failure_code
optional, string, max chars=250
The failure code. This will follow the api error code convention.
failure_reason
optional, string, max chars=250
The more descriptive failure reason.
error_json
optional, string, max chars=1000
The failure details as error json.
Retrieves the time machine. Currently only one time machine is available per site and is named 'delorean'.
Sample Request
curl  https://{site}.chargebee.com/api/v2/time_machines/delorean \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/time_machines/delorean \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"time_machine": { "destination_time": 1585065021, "genesis_time": 1585065021, "name": "delorean", "object": "time_machine", "time_travel_status": "succeeded" }}

URL Format GET

https://{site}.chargebee.com/api/v2/time_machines/{time_machine_name}
always returned
Resource object representing time_machine.

Restart the time machine. This will clear the "customer" data like customer details, subscriptions, invoices, transactions. Also a time travel is initiated to travel back to specified genesis time.

Note: This API call is asynchronous. You need to check if the "start afresh" operation has completed by checking if the time travel status is successful by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. In case you are using any of the client libraries, use the wait for time travel completion function provided as a instance method in the library. Use method waitForTimeTravelCompletion() on the returned time_machine resource which will block until the time travel completes. Use method waitForTimeTravelCompletion() on the returned time_machine resource which will block until the time travel completes. Use method wait_for_time_travel_completion on the returned time_machine resource which will block until the time travel completes. Use method wait_for_time_travel_completion on the returned time_machine resource which will block until the time travel completes. Use method WaitForTimeTravelCompletion on the returned time_machine resource which will block until the time travel completes. Use method wait_for_time_travel_completion on the returned time_machine resource which will block until the time travel completes. Use method waitForTimeTravelCompletion on the returned time_machine resource which will block until the time travel completes. Use method wait_for_time_travel_completion on the returned time_machine resource which will block until the time travel completes.

Sample Request
curl  https://{site}.chargebee.com/api/v2/time_machines/delorean/start_afresh \
     -X POST  \
     -u {site_api_key}:
copy
curl  https://{site}.chargebee.com/api/v2/time_machines/delorean/start_afresh \
     -X POST  \
     -u {site_api_key}:

Sample Response [ JSON ]

Show more...
{"time_machine": { "destination_time": 1585066228, "genesis_time": 1585066228, "name": "delorean", "object": "time_machine", "time_travel_status": "in_progress" }}

URL Format POST

https://{site}.chargebee.com/api/v2/time_machines/{time_machine_name}/start_afresh
genesis_time
optional, timestamp(UTC) in seconds
The genesis time to travel back as part of the reset operation. If not provided, then the travel is set to 6 months in the past.
Note: Can only be in the past.
always returned
Resource object representing time_machine.

Travel forward in time. This operation is asynchronous. You need to check if the "start afresh" operation has completed by checking if the time travel status is successful by retrieving the time machine in a loop with a minimum delay of 3 secs between two retrieve requests. Use method waitForTimeTravelCompletion() on the returned time_machine resource which will block until the time travel completes.

Sample Request
curl  https://{site}.chargebee.com/api/v2/time_machines/delorean/travel_forward \
     -X POST  \
     -u {site_api_key}:\
     -d destination_time=1586274640
copy
curl  https://{site}.chargebee.com/api/v2/time_machines/delorean/travel_forward \
     -X POST  \
     -u {site_api_key}:\
     -d destination_time=1586274640

Sample Response [ JSON ]

Show more...
{"time_machine": { "destination_time": 1586274640, "genesis_time": 1585066234, "name": "delorean", "object": "time_machine", "time_travel_status": "in_progress" }}

URL Format POST

https://{site}.chargebee.com/api/v2/time_machines/{time_machine_name}/travel_forward
destination_time
optional, timestamp(UTC) in seconds
The time to travel to. Should be between the 'current' destination time of the time machine and present time.
always returned
Resource object representing time_machine.