Update Catalog Product

Edit a draft catalog definition with an expected version.

POST/api/v1/billing/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/billing/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: UPDATE_CATALOG_PRODUCT" \
  -H "Content-Type: application/json" \
  -d '{
    "definition": {
      "base_price": "string",
      "currency": "USD",
      "features": [
        "string"
      ],
      "kind": "BASE_PLAN",
      "name": "string",
      "pricing_model": "FLAT"
    },
    "expected_version": 1,
    "product_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: FinanceThe caller must hold this role or a higher one.
Action: UPDATE_CATALOG_PRODUCT

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 UPDATE_CATALOG_PRODUCT 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

definitionobjectRequired
No description yet.
9 child fields
- base_pricestringRequired
  No description yet.
- currencystringRequired
  No description yet.
- featuresarray of stringRequired
  No description yet.
- kindenumRequired
  No description yet.
  Allowed values
  BASE_PLAN
  ADDON
  USAGE_TOKEN
  ONE_TIME_SETUP
- namestringRequired
  No description yet.
  minimum length 1
- pricing_modelenumRequired
  No description yet.
  Allowed values
  FLAT
  TIERED
  VOLUME
  SEAT_BASED
- billing_cycleenum or nullOptional
  No description yet.
  Allowed values
  MONTHLY
  QUARTERLY
  ANNUAL
  SEMI_ANNUAL
- componentsarray of objectOptional
  No description yet.
  2 child fields
  product_iduuidRequired
  No description yet.
  quantitystringRequired
  No description yet.
- descriptionstring or nullOptional
  No description yet.
expected_versionintegerRequired
No description yet.
product_iduuidRequired
No description yet.
tenant_iduuidRequired
No description yet.

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 UPDATE_CATALOG_PRODUCT.
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 or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_VERSIONexpected_version is not the record's current version. Read the record again, then retry.
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.