Skip to main content
GET
Get renewal options for a category

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

category
string
required

Response

category
string
required
mode
enum<string>
required
Available options:
pending_choice,
early_order,
express_reorder,
blocked
blocked_code
required
Available options:
early_order_subscription_ending,
early_order_period_unavailable,
early_order_period_already_advanced,
early_order_pending_review,
no_prior_treatment,
subscription_payment_required
subscription
object | null
required
pending_consultation_id
string<uuid> | null
required
current
object | null
required
ladder
object | null
required
alternatives
object[]
required
required_steps
object[]
required
review_steps
object[]
required
reusable_prefill
object[]
required
baseline_bmi
number<double> | null
required
baseline_unknown
boolean
required
plan
required
Available options:
subscription,
one_off
price
object | null
required

What the next order costs. plan says whether the amount is the category's subscription or its one-off consultation; supply_days is how many days of treatment that amount covers — 30 for a one-off hair-loss consultation, 28 for a one-off weight-loss one, the billing cycle on a plan.

period
object
required
express
object | null
required