Reference

Tax threshold statuses

A Tax Threshold Status is where the environment's consumer (B2C) paid sales stand against one jurisdiction's registration threshold for…

Checked 2026-09-28

A Tax Threshold Status is where the environment's consumer (B2C) paid sales stand against one jurisdiction's registration threshold for digital services. It is computed on read from the sales Money recorded and the threshold table; nothing about it is written by a caller.

Service Sylphx Money · Resource type money.sylphx.com/TaxThresholdStatus · Name pattern orgs/{org}/projects/{project}/envs/{env}/tax_threshold_statuses/{tax_threshold_status} · Shape record

#Fields

Field	Type	What it is
name	string	orgs/{org}/projects/{project}/envs/{env}/tax_threshold_statuses/{threshold}, the threshold's id (au-gst, us-tx).
uid	string	The threshold's id, as in name. Output only.
meta	ResourceMeta	Resource metadata; not set for a computed view.
region_code	string	The jurisdiction's country, upper-case ISO 3166-1 alpha-2. Output only.
subdivision_code	string	The jurisdiction's subdivision (a US state, TX); empty for a country. Output only.
tax_name	string	The tax the threshold registers for, for example GST. Output only.
currency_code	string	The threshold's currency, upper-case ISO 4217. Output only.
threshold_amount	string	The amount that triggers registration, integer minor units of currency_code; "0" when the threshold is a transaction count only. Output only.
threshold_transaction_count	int64	The transaction count that triggers registration; 0 when none. Output only.
window_kind	string	rolling_12_months, calendar_year, or prior_or_current_calendar_year. Output only.
window_start_time	timestamp	The start (inclusive) of the window the figures below cover. Output only.
window_end_time	timestamp	The end of the window (the moment of the read for a rolling window). Output only.
sales_amount	string	The consumer paid sales in the window, net of tax, in currency_code minor units. Business sales (a tax id was given) are excluded. Output only.
sales_transaction_count	int64	The number of those sales. Output only.
percent	int32	How close the sales are to the threshold, in whole percent (the higher of the amount and the count); it can exceed 100. Output only.
alerted_percent	int32	The highest alert level (70, 90, 100) already sent for this window; 0 if none. Output only.
unconverted_currency_codes	string[]	Currencies of sales that could not be converted into currency_code (no rate in the rate table) and so are not counted in sales_amount. Output only.
source_url	string	The authority page the threshold comes from. Output only.
effective_time	timestamp	When the threshold row took effect. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

Method	Call	What it does
GET	list	Lists where the environment's consumer sales stand against each jurisdiction's digital-services tax registration threshold, per its own window. EU and UK have no threshold and are not tracked.

#list

Lists where the environment's consumer sales stand against each jurisdiction's digital-services tax registration threshold, per its own window. EU and UK have no threshold and are not tracked.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/tax_threshold_statuses · scope billing:read · effect read · paginated · Request, response and examples