---
# @generated by sylphx-gen 0.1.0 from contracts@9f583d0fafbf9813b0da162eef18cd95767f9a68d1de3edf29cf2143c78b11fb. Do not edit.
title: "Generate a licence key"
description: "`money.licence_keys.generate` (POST /v1/{parent}/licence_keys:generate): Generates a licence key: Money creates the Ed25519 key, seals it, and never returns the private half."
type: reference
product: payments
summary: "Generates a licence key: Money creates the Ed25519 key, seals it, and never returns the private half."
updated: 2026-09-28
nav: false
---

Generates a licence key: Money creates the Ed25519 key, seals it, and never returns the private half. Needs the approval-class scope, which the developer role does not hold.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys:generate`
- **Scope** `billing:licence_keys.approve`
- **Effect** `write` — a successful call changes state.
- **Collection** [licence_keys](/docs/api/licence_keys)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The environment the key belongs to. Required. |
| `licence_key_id` | `string` | The key's id; `^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$`. Empty: Money assigns one. |
| `spec` | `LicenceKeySpec` | Shown to operators. |

### LicenceKeySpec

| Field | Type | What it is |
| --- | --- | --- |
| `description` | `string` | Shown to operators. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/licence_keys/{licence_key}`. |
| `uid` | `string` | `lkey_<cell><ulid>`; never reused. The keyless public export is addressed by it. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `LicenceKeySpec` | Desired state. Required. |
| `status` | `LicenceKeyStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong 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_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### LicenceKeySpec

| Field | Type | What it is |
| --- | --- | --- |
| `description` | `string` | Shown to operators. |

### LicenceKeyStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready while the key exists. Output only. |
| `state` | `string` | `active` signs new terms; `retired` signs only terms already frozen to it and stays exported for verification. Output only. |
| `origin` | `string` | `generated` or `imported`. Output only. |
| `public_key` | `string` | The raw Ed25519 public key, base64url without padding. Output only. |
| `retire_time` | `timestamp` | When the key was retired. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/licence_keys:generate" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

```ts
const response = await sylphx.money.licenceKeys.generate({ parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::money::GenerateLicenceKeyRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.money().licence_keys().generate(req).await?;
```

**CLI**

```bash
sylphx money licence-keys generate orgs/acme/projects/shop/envs/production
```

**MCP**

```json
{ "method_id": "money.licence_keys.generate", "args": {"parent":"orgs/acme/projects/shop/envs/production"} }
```