Recipes

Instantiate recipe (idempotent apply)

Changed on

Applies the recipe for the tenant under one transaction: rating rules and meters are adopted-or-created, pricing rules bound, a fresh born-unique plan generated, optional dunning policy and (inactive) webhook endpoint created, then the install badge written. Idempotent per (tenant, livemode): re-posting an installed recipe returns the EXISTING instance — 201 both times, never a 409, never a duplicate plan (ADR-085; badge livemode-scoped per m0157).

post/v1/recipes/{key}/instantiate

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/recipes/{key}/instantiate
  • Auth: HTTP bearer

Path parameters

keystring required

Request body

overridesobject

Response

Install badge (fresh, or existing on idempotent re-apply)

idstring required
tenant_idstring

Omitted when empty.

recipe_keystring required
recipe_versionstring required
overridesobject required
created_atstring date-time required
created_bystring

Operator email or API key ID. Omitted when empty.

Changes