Skip to content
Console
Menu

Generated Assets

Workflows

Getting Started

Authentication

KV Store

Usage tiers

A Usage Tier is a trust tier of the merchant's own: the limits a subject starts at and rises to with payment history.

A Usage Tier is a trust tier of the merchant's own: the limits a subject starts at and rises to with payment history. Rank 0 is the base tier.

Service Sylphx Money · Resource type money.sylphx.com/UsageTier · Name pattern orgs/{org}/projects/{project}/envs/{env}/usage_tiers/{usage_tier} · Shape record

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/usage_tiers/{usage_tier}; the id is the tier key.
uidstringutier_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
rankint32Order of tiers; 0 is the base tier. Required.
daily_limit_minorstringDaily exposure limit in minor units, a decimal string; empty for none.
monthly_limit_minorstringMonthly exposure limit in minor units, a decimal string; empty for none.
threshold_minorstringThe amount an invoice would make due at which a threshold invoice is cut. Required.
requires_paid_invoicesint32Paid invoices needed to reach this tier.
requires_paid_minorstringPaid total, minor units, needed to reach this tier.

#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.

MethodCallWhat it does
GETlistLists usage tiers.
PATCHupdateCreates or updates a usage tier.

#list

Lists usage tiers.

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

#update

Creates or updates a usage tier.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_tiers/usage-tier · scope billing:write · effect write · Request, response and examples