Skip to main content
GET
Get offer details

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Path Parameters

id
string
required

Offer ID

Required string length: 1 - 56
Example:

"offer_j572abc..."

Response

Offer details

id
string
required

Offer ID

Required string length: 1 - 56
short_hash
string
required

8-char base62 code that appears in the customer-clicked URL /i/<short_hash>

Example:

"aB3xK9pQ"

package_id
string
required

Package ID

Required string length: 1 - 54
package_version_id
string
required

Package version ID — pinned at create time

Required string length: 1 - 55
status
enum<string>
required

Computed lifecycle status — never set directly; derived from row state.

Available options:
active,
archived,
expired,
redeemed
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
workspace_id
string

Workspace ID

Required string length: 1 - 53
target_workspace_id
string

Optional workspace that receives the offer outcome when visible to the caller

Required string length: 1 - 53
created_by
string

User ID of the seller who issued the offer

product_id
string

Product ID

Required string length: 1 - 55
input_schema
object

JSON Schema 2020-12 with x-ui extensions for the pinned package version. Present on customer resolve responses so the install wizard can render the configure step.

allowed_emails
string[]

Empty / omitted = anyone authed can claim. Non-empty = the customer's verified email must match. Only returned to authed callers.

field_values
object

Seller pre-fills keyed by package input-schema property name. Only returned to authed callers whose email matches the allowlist.

tier
string

Suggested billing tier

region_id
string

Region pin

Required string length: 1 - 54
cluster_id
string

Cluster pin

Required string length: 1 - 54
offer_channel_id
string

Offer Channel that resolved private-offer policy for this offer

Required string length: 1 - 54
commercial_mode
enum<string>

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.

Available options:
paid,
non_billable_test
approval_state
enum<string>
Available options:
not_required,
pending,
approved,
rejected
requested_policy_snapshot
object
approved_policy_snapshot
object
notes
string
expires_at
integer

Unix timestamp (seconds)

Required range: x >= 0
max_uses
integer
order_ttl_minutes
integer

Per-redemption order TTL in minutes. Defaults to 120; capped at 1440 (24h).

Required range: x <= 1440
used_count
integer
Required range: x >= 0
archived_at
integer

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer

Unix timestamp (seconds)

Required range: x >= 0
etag
string
product_name
string

Display name of the offered product

image_url
string

Logo or icon URL for the customer landing page

seller_name
string

Display name of the seller who issued this offer