Start an org’s trial

POST

/billing/admin/orgs/{orgId}/trial

curl --request POST \
  --url https://api.sloose.com/billing/admin/orgs/org_9f3c/trial \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

Backoffice route: a staff session, or ADMIN_TOKEN; never a customer’s session. The same eligibility rules as the customer-facing route — once per org and once per billing account. A start is written down as org.trial.

Authorizations

• sessionAuth
• adminToken

Parameters

Path Parameters

orgId

required

The org id.

string

Example

org_9f3c

The org id.

Responses

200

Not eligible.

Media typeapplication/json

object

started

required

boolean

key

additional properties

Example

{
  "started": false
}

201

Trial started.

Media typeapplication/json

object

started

required

boolean

key

additional properties

Example

{
  "started": true
}

401

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}