---
# @generated by sylphx-gen 0.1.0 from contracts@190f1b33b937c1aef79697684018db853389b521c75e19ff69ac6af609e96f45. Do not edit.
title: "Usage settings"
description: "The `usage_settings` collection of Sylphx Money: Usage Settings is the environment's usage-billing account: its currency, the enforcement switch (dark until a merchant admin turns it on), the free allowance, the dunning schedule and an…"
type: reference
product: payments
summary: "Usage Settings is the environment's usage-billing account: its currency, the enforcement switch (dark until a merchant admin turns it on),…"
updated: 2026-09-28
order: 900
---

Usage Settings is the environment's usage-billing account: its currency, the enforcement switch (dark until a merchant admin turns it on), the free allowance, the dunning schedule and an extra token issuer. One per environment (AIP-156 singleton, id `default`).

**Service** Sylphx Money · **Resource type** `money.sylphx.com/UsageSettings` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/usage_settings/{usage_settings}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/usage_settings/default`. |
| `uid` | `string` | `uset_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `currency_code` | `string` | The currency usage is rated and invoiced in (ISO 4217, upper case). Required. |
| `enforcement_enabled` | `bool` | While false a reservation is always granted and a would-be refusal is only recorded. Off until the merchant's admin turns it on. |
| `free_allowance_nano` | `string` | What a subject with no payment method may use each month, nano-minor, as a decimal string. |
| `past_due_grace_days` | `int32` | Days after an invoice's due time before the subject is past due. |
| `suspend_grace_days` | `int32` | Days after an invoice's due time before the subject is suspended. |
| `extra_issuer` | `string` | A further token issuer (the merchant's own OIDC provider) besides Sylphx Auth; empty for Sylphx Auth only. It needs `extra_issuer_jwks_url`. |
| `extra_issuer_jwks_url` | `string` | The issuer's HTTPS JWKS URL. |
| `extra_issuer_audience` | `string` | The audience that issuer's tokens must carry; required with `extra_issuer`. |
| `extra_issuer_org_claim` | `string` | The claim that names a customer organization in that issuer's tokens; empty means the issuer proves no organization subject. |

## 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` | [`get`](/docs/api/usage_settings#get) | Gets the environment's usage settings. |
| `PATCH` | [`update`](/docs/api/usage_settings#update) | Updates the usage settings, the enforcement switch included. A change is recorded with who made it. |

## get

Gets the environment's usage settings.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings` · scope `billing:read` · effect `read` · [Request, response and examples](/docs/api/usage_settings/get)

## update

Updates the usage settings, the enforcement switch included. A change is recorded with who made it.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings` · scope `billing:write` · effect `write` · [Request, response and examples](/docs/api/usage_settings/update)