Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

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

FieldTypeWhat it is
parentstringThe environment to create in. Required.
usage_meter_priceUsageMeterPriceThe price. Required.

#UsageMeterPrice

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/usage_meter_prices/{usage_meter_price}.
metaResourceMetaResource metadata.
meterstringThe meter's key. Required.
currency_codestringISO 4217; it must be the environment's currency. Required.
unit_price_nanostringList price of one unit, nano-minor (a billionth of a minor unit), a decimal string. Required.
effective_timetimestampWhen it starts applying; now when absent. Not in the past, and after the meter's latest price.
tax_codestringThe processor's tax code for the usage line; empty for the merchant's default.

#ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/usage_meter_prices/{usage_meter_price}.
uidstringumpr_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
meterstringThe meter's key. Required.
currency_codestringISO 4217; it must be the environment's currency. Required.
unit_price_nanostringList price of one unit, nano-minor (a billionth of a minor unit), a decimal string. Required.
effective_timetimestampWhen it starts applying; now when absent. Not in the past, and after the meter's latest price.
tax_codestringThe processor's tax code for the usage line; empty for the merchant's default.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

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":"…"}'