instances

Create an instance (starts a checkout)

post/instances

Request

  • Base URL: https://app.lathe.live/api/v1
  • URL: https://app.lathe.live/api/v1/instances
  • Auth: none declared

Request body

tierstring required

free | mini | starter | plus | pro (see GET /plans; Free only where offered)

namestring

A label shown instead of the id; free text, not unique.

tagsstring[]

Lowercase tokens for grouping: letters, digits, . _ : -

locationstring

Location code from GET /locations; empty = the default.

couponstring

A discount code for the first month.

Response

Successful Response

instance_idstring required
tierstring required
status'awaiting_payment' | 'pending' required
checkout_urlstring nullable

Open in a browser and pay (or, for a trial, verify the card). Present for paid purchases.

trialboolean

The checkout verifies the card and starts a free trial; the first month is charged when it ends.

freeboolean

A free instance: no checkout, nothing to pay now or later. One per person.

job_idstring nullable
urlstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.