Create Price

Define a price for a product — flat, per-seat, or a graduated/volume tier table. Rejected unless it can actually rate.

POST/api/v1/billing/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/billing/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: CREATE_PRICE" \
  -H "Content-Type: application/json" \
  -d '{
    "billing_cycle": "MONTHLY",
    "currency": "USD",
    "included_units": "string",
    "model": "FLAT",
    "price_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "product_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "tier_mode": "GRADUATED",
    "tiers": [
      {
        "unit_price": "string"
      }
    ],
    "unit_amount": "string"
  }'

Authorization

Minimum role: FinanceThe caller must hold this role or a higher one.
Multi-factor sign-in: Required. The access token must come from a session that completed multi-factor sign-in.
Action: CREATE_PRICE

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be CREATE_PRICE for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

billing_cycleenumRequired
No description yet.
Allowed values
- MONTHLY
- QUARTERLY
- ANNUAL
- SEMI_ANNUAL
currencystringRequired
No description yet.
minimum length 3
maximum length 3
included_unitsstringRequired
No description yet.
modelenumRequired
No description yet.
Allowed values
- FLAT
- TIERED
- VOLUME
- SEAT_BASED
price_iduuidRequired
No description yet.
product_iduuidRequired
No description yet.
tier_modeenumRequired
No description yet.
Allowed values
- GRADUATED
- VOLUME
GRADUATED
Bracketed — each tier prices only its own slice (income-tax style).
VOLUME
Landed — the tier the total reaches prices every unit.
tiersarray of objectRequired
No description yet.
3 child fields
- unit_pricestringRequired
  No description yet.
- flat_feestringOptional
  Charged once when this tier is used at all.
  Default
  0
- limitstring or nullOptional
  Inclusive upper bound. None marks the final, unbounded tier.
unit_amountstringRequired
No description yet.
meter_iduuid or nullOptional
The meter this price rates. Required for metered prices.
usage_aggregationenum or nullOptional
No description yet.
Allowed values
- SUM
- MAX
- LAST
- UNIQUE_COUNT
SUM
Total consumption over the period.
MAX
Highest value seen — peak provisioning.
LAST
Value at period close — current state, e.g. storage.
UNIQUE_COUNT
Distinct subjects — monthly active users.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send CREATE_PRICE.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below finance, the session has not completed multi-factor sign-in, or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.