Advance a test clock

Changed on

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

post/v1/test_helpers/test_clocks/{test_clock}/advance

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/test_clocks/{test_clock}/advance
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

test_clockstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

frozen_timeinteger required

The time to advance the test clock. Must be after the test clock's current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

deletes_afterinteger required

Time at which this clock is scheduled to auto delete.

frozen_timeinteger required

Time at which all objects belonging to this clock are frozen.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

namestring nullable

The custom name supplied at creation.

object'test_helpers.test_clock' required

String representing the object's type. Objects of the same type share the same value.

status'advancing' | 'internal_failure' | 'ready' required

The status of the Test Clock.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.