Skip to main content
PATCH
Update Plan Meter
Enabled per organizationUsage-based billing must be enabled for your organization before these endpoints accept requests. Contact your Yuno account manager to enable it. Requests from an organization where it is not enabled return 403 PRODUCT_NOT_ENABLED.
Send at least one of credits, pricing_strategy, price_per_credit, country_prices. The same currency rules as Attach Meter to Plan apply. If the meter has been archived (INACTIVE) the metered price is frozen and this call returns 400 PLAN_METER_NOT_FOUND until the meter is reactivated.
PACKAGE/TIERED config is attach-time onlypackage_size, package_price, package_country_prices and tiers cannot be sent to this endpoint — any request containing one of them is rejected with 400 PLAN_METER_PRICING_CONFIG_UNSUPPORTED, regardless of the metered price’s current pricing_strategy. Switching pricing_strategy itself is validated against the metered price’s existing config for the target strategy; an unsupported switch is rejected rather than silently applied. To change a PACKAGE/TIERED config, attach a new meter instead — see the Usage-Based Billing guide.
There is no detach endpoint. To stop billing a meter, archive it with Update Meter (status: INACTIVE), or set credits high enough that no overage is billed.
Refer to Meter Error Codes for the possible error outcomes.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Headers

X-Account-Code
string
required

The account_id found in your Yuno Dashboard (UUID). Required — omitting it returns 400 BAD_REQUEST ("Invalid x-account-code header.").

X-Idempotency-Key
string
required

Unique identifier used in HTTP headers to ensure that a request is processed only once, even if it is retried due to network issues or timeouts. Optional, as on the rest of the Yuno API.

Path Parameters

plan_id
string
required

The unique identifier of the plan.

meter_id
string
required

The unique identifier of the meter attached to the plan.

Body

application/json
credits
number<float>

Units included in the plan per billing cycle — the allowance a subscriber can consume before any usage is billed. Must be >= 0. 0 means every unit is billed.

pricing_strategy
enum<string>

How usage beyond credits is priced: PER_UNIT (billable units × price_per_credit), PACKAGE (bundles of N units, partial bundle counts as a full one) or TIERED (graduated tiers, each band at its own rate).

Available options:
PER_UNIT,
PACKAGE,
TIERED
price_per_credit
object
country_prices
object[]

Optional explicit per-country price per unit. One entry per country — a repeated country is rejected with 400 INVALID_PARAMETERS. A country not listed falls back to price_per_credit.

Response

200

id
string

The unique identifier of the metered price (the plan-meter relation).

plan_id
string
meter_id
string
credits
number

Units included in the plan per billing cycle.

pricing_strategy
enum<string>
Available options:
PER_UNIT,
PACKAGE,
TIERED
price_per_credit
object | null

null when inherited from the meter's default_price (USD plans).

country_prices
object[]
created_at
string

Set by Yuno on creation.

updated_at
string

Set by Yuno on every update.