billing

Start the one-time trial from Onplana Schedule (OWNER only)

The same claim as POST /billing/trial/claim, for Onplana Schedule's lock. Accepts a session or an OAuth app token holding PROJECTS_WRITE (the Onplana Schedule grant). Refused, before anything is written: a personal access token (403 PERSONAL_TOKEN_REFUSED), the operator switch schedule_trial_claim_enabled off (403 SCHEDULE_TRIAL_OFF), anyone but an owner (403), an unverified email (403 EMAIL_UNVERIFIED), a demo workspace (403 SANDBOX_REFUSED), more than 5 tries an hour (429 RATE_LIMITED), and a source that is not schedule_<command> (400 VALIDATION). Eligibility, the answer and the audit rows are the web route's.

post/schedule-trial/claim

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/schedule-trial/claim
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

sourcestring required

The lock that started it, written to the audit row

Response

Trial started; returns the new plan and the trial end date

Changes

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