Documentation · API reference
POST/api/v1/billing/buyer

Say who the account buys as

This page as Markdown, or in an AI chatMore ways to read this page
View as MarkdownThis page as plain text, for you or an agentOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page

Say who the account buys as: a business or an organisation, or a consumer of 18 or older.

What to send

BuyerChoice Who an account buys as. A consumer says they are 18 or older, and, where it decides who sells to them, whether they live in the EU.

adult
boolean
buyer
stringneeded`business` or `consumer`.
lives
string`eu` or `outside`, where `asks_where` says it is asked.

The answer

Status 200

BillingView

address
stringneeded
adult_said
booleanThe owner said they are 18 or older when the workspace was made (doc/sign-in-services.md, B.1): the Plan screen does not ask again.
asks_where
booleanA consumer is asked whether they live in the EU: it decides who sells to them (doc/managed-payments.md §4.1).
billing_email
stringneeded
buyer
stringWho the account buys as: empty until asked, `business` or `consumer` (doc/consumers.md §1).
buyer_open
booleanWho buys can still be changed: no subscription is running.
buyer_where
string`eu`, `outside`, or empty where not asked.
by_site
list of SiteUseneeded
cancelled
integer or null
consumers
booleanConsumers are offered the plans here, so who buys is asked.
dpa
integer or nullWhen the data processing agreement was accepted, and by whom.
dpa_by
stringneeded
events
integerneededViews and events received this month, across every site. Bots, spam and rejected hits are not in it, and neither is anything imported.
grace_days
integerneeded
history
HistoryNotice or null
instance
booleanThis is the account of whoever runs this tidekeeper: its plan is its own, limits nothing, costs nothing and is offered to nobody.
invoices
list of InvoiceViewThe provider's invoices, newest first.
limit
integerneeded
members
integerneeded
month
stringneeded`2026-10`, and the stretch of it so far in words.
month_label
stringneeded
now
integerneeded
own_limits
OwnLimits or null
passes_on
string or nullThe day the limit is passed if the month goes on as it has.
pays
booleanA provider that takes payment is connected: a plan with a price is paid for on its pages, not chosen here.
plan
PlanViewneeded
plans
list of PlanViewneeded
provider
booleanneededWhether a payment provider is connected. Without one there are no invoices and no card, and a plan is changed by choosing it.
read_only_days
integerneeded
region
stringneeded
renews
integer or null
resets
stringneededThe first day of the next month.
sites
integerneeded
sold_by_provider
booleanThe next checkout is sold by the payment provider as merchant of record (Stripe's Managed Payments), not by whoever runs this.
standing
objectneeded
subscription
SubscriptionView or null
test_mode
booleanThe provider takes no real payment: its keys are test keys.
trial_days
integerneededThe days of trial a card starts, for an account that has not given one.
unset
booleanneeded
vat
stringneeded
withdraw_until
integer or nullA consumer may withdraw from the agreement until then (§3).
withdrawn
integer or nullWhen a consumer withdrew, and in whose name.
withdrawn_by
string

Asking

With your token from Settings
curl -X POST https://tidekeeper.eu/api/v1/billing/buyer \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"buyer": "…"}'
With your token from Settings
const answer = await fetch("https://tidekeeper.eu/api/v1/billing/buyer", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"buyer": "…"}),
}).then((r) => r.json());