PATCH
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

Organization id (UUID). Discover ids via the list organizations endpoint or the agent context.

Body

application/json
name
string

New organization display name, 2 to 64 characters.

Required string length: 2 - 64
Example:

"Acme Inc"

onboardingData
object | null

Replacement onboarding wizard state for the organization; null clears it.

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
name
string
required
billingEmail
string | null
required
onboardingData
object | null
required
stripeCustomerId
string | null
required
stripeSubscriptionId
string | null
required
stripePaymentMethodId
string | null
required
stripeMeteredSubscriptionItemId
string | null
required
creditsBalance
number
required
reservedCredits
number
required
autoRechargeEnabled
boolean
required
autoRechargeThreshold
number | null
required
autoRechargeAmount
number | null
required
isSubscribed
boolean
required
subscriptionStatus
enum<string>
required
Available options:
active,
inactive,
trialing,
past_due,
canceled,
paused,
unpaid
subscriptionPlan
string | null
required
subscriptionStartedAt
string | null
required
subscriptionEndsAt
string | null
required
subscriptionCurrentPeriodEnd
string | null
required
createdAt
string
required
updatedAt
string
required