POST
/
v1
/
organizations
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.organizations.createOrganization({
  body: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "billingEmail": "<string>",
  "onboardingData": {
    "version": 1,
    "completedSteps": [],
    "organizationProfile": {
      "displayName": "<string>"
    },
    "workspaceProfile": {
      "teamName": "<string>",
      "website": "<string>",
      "brandSettings": {
        "colors": {
          "primary": "<string>",
          "secondary": "<string>",
          "accent": "<string>",
          "background": "<string>",
          "text": "<string>"
        },
        "brandGuidelines": "<string>",
        "industry": "<string>",
        "targetAudience": "<string>"
      }
    },
    "goals": {},
    "completedAt": "<string>"
  },
  "stripeCustomerId": "<string>",
  "stripeSubscriptionId": "<string>",
  "stripePaymentMethodId": "<string>",
  "stripeMeteredSubscriptionItemId": "<string>",
  "creditsBalance": 123,
  "reservedCredits": 123,
  "autoRechargeEnabled": true,
  "autoRechargeThreshold": 123,
  "autoRechargeAmount": 123,
  "isSubscribed": true,
  "subscriptionPlan": "<string>",
  "subscriptionStartedAt": "<string>",
  "subscriptionEndsAt": "<string>",
  "subscriptionCurrentPeriodEnd": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Body

application/json
name
string
required

a string at most 64 character(s) long

Required string length: 2 - 64

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
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