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

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

const response = await client.billing.createCheckoutSession({
  body: {},
})
{
  "id": "<string>",
  "url": "<string>"
}

Body

application/json
​
organizationId
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}$
​
subscriptionPlan
enum<string>
required
Available options:
try_me,
pro,
agency
​
successUrl
string
required

a string matching the pattern ^https?://

Pattern: ^https?:\/\/
​
cancelUrl
string
required

a string matching the pattern ^https?://

Pattern: ^https?:\/\/

Response

Success

​
id
string
required
​
url
string
required