Skip to content
Extrovert Extrovert Docs

redeemGift

POST
/v1/admin/orgs/{org_id}/billing/gifts/redeem

Requires verified human identity and existing billing authority. Maximum request body 4 KiB. Child organizations resolve to their root billing organization.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
string

Request Body required

Section titled “Request Body required ”
object
gift_code
string
<= 64 characters
resume_token
string
<= 43 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Gift result

object
id
required
string
campaign_id
required
string
code_id
string
intent_id
string
root_org_id
required
string
plan_tier
string
duration_days
integer
status
required
string
created_at
string format: date-time
starts_at
string format: date-time
ends_at
string format: date-time
error
string
renewal_state
required
string
Allowed values: off pending arranged revoked
renewal_version
required
integer format: int64

202

Section titled “202 ”

Activation pending

object
id
required
string
campaign_id
required
string
code_id
string
intent_id
string
root_org_id
required
string
plan_tier
string
duration_days
integer
status
required
string
created_at
string format: date-time
starts_at
string format: date-time
ends_at
string format: date-time
error
string
renewal_state
required
string
Allowed values: off pending arranged revoked
renewal_version
required
integer format: int64

409

Section titled “409 ”

Resource conflict (e.g. a duplicate entry).

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean