Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Jobs and cron
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Create an usage meter price
Appends a price to a meter's history.
Appends a price to a meter's history. It applies from its effective time on and never rewrites usage already rated.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meter_prices - Scope
billing:write - Effect
write— a successful call changes state. - Collection usage_meter_prices
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The environment to create in. Required. |
usage_meter_price | UsageMeterPrice | The price. Required. |
#UsageMeterPrice
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_meter_prices/{usage_meter_price}. |
meta | ResourceMeta | Resource metadata. |
meter | string | The meter's key. Required. |
currency_code | string | ISO 4217; it must be the environment's currency. Required. |
unit_price_nano | string | List price of one unit, nano-minor (a billionth of a minor unit), a decimal string. Required. |
effective_time | timestamp | When it starts applying; now when absent. Not in the past, and after the meter's latest price. |
tax_code | string | The processor's tax code for the usage line; empty for the merchant's default. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_meter_prices/{usage_meter_price}. |
uid | string | umpr_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
meter | string | The meter's key. Required. |
currency_code | string | ISO 4217; it must be the environment's currency. Required. |
unit_price_nano | string | List price of one unit, nano-minor (a billionth of a minor unit), a decimal string. Required. |
effective_time | timestamp | When it starts applying; now when absent. Not in the past, and after the meter's latest price. |
tax_code | string | The processor's tax code for the usage line; empty for the merchant's default. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meter_prices" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"currency_code":"…","meter":"…","unit_price_nano":"…"}'