> ## Documentation Index > Fetch the complete documentation index at: https://docs.akua.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create offer > Creates an Offer for a product or a specific package version. When `product_id` is supplied without `package_version_id`, the server resolves the product’s current package version pin, validates `field_values` against that resolved version’s input schema, and stores the concrete package version on the Offer. Customers reach the Offer at `/i/` to start an install. When `allowed_emails` is non-empty, only those email addresses can use the Offer; when empty or omitted, any authenticated customer can. ## OpenAPI ````yaml /openapi-public.json post /offers openapi: 3.1.0 info: title: Akua API version: 1.0.0 description: >- Public API for managing Akua workspaces, clusters, products, and installs. Authenticate with a workspace API token via the `Authorization: Bearer sk_akua_...` header. A workspace-owned token implies its workspace. Broad tokens select the active workspace via the optional `Akua-Context` header. contact: name: Akua API support email: support@akua.dev url: https://akua.dev/docs servers: - url: https://api.akua.dev/v1 description: Production security: [] tags: - name: Auth description: Authentication and token management. - name: Agents description: Agent identities and configuration. - name: Agent sessions description: Durable agent conversations and tasks. - name: Agent turns description: Submitted agent work and event emission. - name: Agent events description: Normalized agent event history and streams. - name: Custom domains description: Workspace custom domains and routing targets. - name: Cloudflare description: Cloudflare account credentials and gateway control. - name: Clusters description: Kubernetes clusters and cluster access operations. - name: ComputeConfigs description: Workspace compute provider configurations. - name: Entitlements description: Effective workspace capabilities and limits. - name: Dashboards description: Dashboard and widget resources. - name: Installs description: Installation and render operations. - name: Machines description: Compute machines and lifecycle events. - name: Notifications description: User notification state. - name: Offer Channels description: Private offer channels and policy versions. - name: Offers description: Marketplace offers and redemption tracking. - name: Operations description: Long-running operation status and controls. - name: Order Drafts description: Draft checkout orders and checkout sessions. - name: Organizations description: Organizations, memberships, and managed workspaces. - name: Packages description: Software packages, versions, and input schemas. - name: Products description: Marketplace product catalog resources. - name: Preview hostnames description: Install preview hostnames and routing state. - name: Quotas description: Workspace quota limits and usage. - name: Regions description: Available deployment regions. - name: Registry description: Container registry credentials and repositories. - name: Repository change requests description: Fork-backed repository change reviews and lifecycle actions. - name: Repositories description: Source repositories available to the workspace. - name: Secrets description: Workspace secrets and secret versions. - name: Snippets description: Reusable snippets and snippet runs. - name: Workspace subdomains description: Workspace subdomain identity. - name: Workspaces description: Workspace resources, members, and billing state. paths: /offers: post: tags: - Offers summary: Create offer description: >- Creates an Offer for a product or a specific package version. When `product_id` is supplied without `package_version_id`, the server resolves the product’s current package version pin, validates `field_values` against that resolved version’s input schema, and stores the concrete package version on the Offer. Customers reach the Offer at `/i/` to start an install. When `allowed_emails` is non-empty, only those email addresses can use the Offer; when empty or omitted, any authenticated customer can. operationId: offers.create parameters: - schema: type: string minLength: 1 maxLength: 53 description: >- Optional workspace/scope context for the request. Carries a single workspace wire id (`ws_…`) today. Only needed for broad tokens — a workspace-owned token implies its workspace. example: ws_j572abc123def456 required: false description: >- Optional workspace/scope context for the request. Carries a single workspace wire id (`ws_…`) today. Only needed for broad tokens — a workspace-owned token implies its workspace. name: akua-context in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOfferBody' responses: '201': description: Offer created content: application/json: schema: $ref: '#/components/schemas/OfferCreated' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '422': description: Unprocessable entity content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' security: - BearerAuth: [] components: schemas: CreateOfferBody: anyOf: - type: object properties: product_id: type: string minLength: 1 maxLength: 55 description: >- Product ID for attribution and package-version resolution. Required for channel-backed offers. When `package_version_id` is omitted, the server uses the product’s current package version pin. package_version_id: type: string minLength: 1 maxLength: 55 description: >- Package version ID to pin explicitly at create time. Optional when `product_id` is supplied; if both are supplied, this value overrides the product’s current package version pin. allowed_emails: type: array items: type: string maxLength: 254 format: email maxItems: 50 description: >- Verified customer email allowlist. Empty or omitted means any authenticated customer can redeem the offer. field_values: type: object additionalProperties: type: object properties: value: description: Pre-fill value for this schema property locked: type: boolean description: >- When true the customer cannot override; submit ignores client value required: - value - locked description: >- Package input pre-fills keyed by input-schema property name. Values are validated against the resolved package version input schema before the offer is created. tier: type: string maxLength: 32 description: >- Legacy advisory billing tier for non-channel offers. Do not send this with `offer_channel_id`; channel-backed offers use `commercial_mode` and `pricing_request`. offer_channel_id: type: string minLength: 1 maxLength: 54 description: >- Offer Channel whose active policy resolves approval, checkout, support, and pricing terms. Requires `product_id`. commercial_mode: allOf: - $ref: '#/components/schemas/CommercialMode' - description: >- Requested customer path for channel policy resolution. This is not settlement authority; the active channel policy decides the final terms. pricing_request: $ref: '#/components/schemas/OfferPricingRequest' notes: type: string maxLength: 500 description: >- Seller-private note for operators reviewing or supporting the offer. Not shown to the customer. expires_at: type: integer exclusiveMinimum: 0 description: >- Unix timestamp in seconds after which the offer can no longer be redeemed. Omit for no explicit expiration. max_uses: type: integer exclusiveMinimum: 0 maximum: 10000 description: >- Maximum number of successful redemptions allowed for this offer. Omit for the default single-use behavior. order_ttl_minutes: type: integer exclusiveMinimum: 0 maximum: 1440 description: >- Per-redemption order TTL in minutes. Defaults to 120; capped at 1440 (24h). required: - product_id additionalProperties: false - type: object properties: package_version_id: type: string minLength: 1 maxLength: 55 description: >- Package version ID to pin explicitly at create time. Optional when `product_id` is supplied; if both are supplied, this value overrides the product’s current package version pin. product_id: type: string minLength: 1 maxLength: 55 description: >- Product ID for attribution and package-version resolution. Required for channel-backed offers. When `package_version_id` is omitted, the server uses the product’s current package version pin. allowed_emails: type: array items: type: string maxLength: 254 format: email maxItems: 50 description: >- Verified customer email allowlist. Empty or omitted means any authenticated customer can redeem the offer. field_values: type: object additionalProperties: type: object properties: value: description: Pre-fill value for this schema property locked: type: boolean description: >- When true the customer cannot override; submit ignores client value required: - value - locked description: >- Package input pre-fills keyed by input-schema property name. Values are validated against the resolved package version input schema before the offer is created. tier: type: string maxLength: 32 description: >- Legacy advisory billing tier for non-channel offers. Do not send this with `offer_channel_id`; channel-backed offers use `commercial_mode` and `pricing_request`. offer_channel_id: type: string minLength: 1 maxLength: 54 description: >- Offer Channel whose active policy resolves approval, checkout, support, and pricing terms. Requires `product_id`. commercial_mode: allOf: - $ref: '#/components/schemas/CommercialMode' - description: >- Requested customer path for channel policy resolution. This is not settlement authority; the active channel policy decides the final terms. pricing_request: $ref: '#/components/schemas/OfferPricingRequest' notes: type: string maxLength: 500 description: >- Seller-private note for operators reviewing or supporting the offer. Not shown to the customer. expires_at: type: integer exclusiveMinimum: 0 description: >- Unix timestamp in seconds after which the offer can no longer be redeemed. Omit for no explicit expiration. max_uses: type: integer exclusiveMinimum: 0 maximum: 10000 description: >- Maximum number of successful redemptions allowed for this offer. Omit for the default single-use behavior. order_ttl_minutes: type: integer exclusiveMinimum: 0 maximum: 1440 description: >- Per-redemption order TTL in minutes. Defaults to 120; capped at 1440 (24h). required: - package_version_id additionalProperties: false description: >- Provide either `product_id` or `package_version_id`. Product-backed requests may omit `package_version_id`; the server resolves the product’s current package version pin at create time, validates `field_values` against the resolved package version input schema, and stores the resolved package version on the offer. OfferCreated: type: object properties: id: type: string minLength: 1 maxLength: 56 description: Offer ID short_hash: type: string required: - id - short_hash ApiErrorResponse: type: object properties: success: type: boolean enum: - false errors: type: array items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object properties: {} description: Always empty for error responses required: - success - errors - result CommercialMode: type: string enum: - paid - non_billable_test description: >- Customer commercial path requested for an offer. `paid` routes through checkout when policy requires it; `non_billable_test` creates a non-billable test offer when policy allows it. OfferPricingRequest: type: object properties: currency: type: string enum: - eur - usd example: eur description: ISO currency code for the requested price. unit_amount: type: integer minimum: 0 maximum: 100000000 description: >- Requested price in the smallest currency unit, for example cents for EUR or USD. interval: allOf: - $ref: '#/components/schemas/PricingInterval' - description: Billing interval for the requested price. required: - currency - unit_amount - interval additionalProperties: false description: >- Requested customer-visible price for channel policy resolution. The active policy validates the request before the offer is created. ApiErrorEntry: type: object properties: code: type: integer example: 7002 description: Machine-readable error code message: type: string example: Resource not found description: Human-readable error message path: type: array items: type: string example: - body - name description: Field path that caused the error, when applicable metadata: type: object additionalProperties: type: string required: - code - message PricingInterval: type: string enum: - month - year securitySchemes: BearerAuth: type: http scheme: bearer description: >- workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens ````