TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'
const client = new TxAgentKitClient({
token: process.env.TX_AGENT_KIT_TOKEN
})
const response = await client.traceLearn.getTraceLearnBillingOverview(){
"plans": [
{
"id": "<string>",
"name": "<string>",
"priceCents": 500000,
"features": [
"<string>"
],
"description": "<string>",
"payerKind": "tutor",
"maxStudents": 123,
"createdAt": "<string>",
"recommended": true
}
],
"activeSubscription": {
"id": "<string>",
"payerKind": "tutor",
"payerId": "<string>",
"planId": "<string>",
"startedAt": "<string>",
"trialEndsAt": "<string>",
"nextBillingDate": "<string>",
"cancelledAt": "<string>",
"seatsPurchased": 123
},
"seatEntitlements": [
{
"id": "<string>",
"subscriptionId": "<string>",
"tutorId": "<string>",
"studentId": "<string>",
"grantedAt": "<string>",
"revokedAt": "<string>"
}
],
"freeDiagnosticAccess": [
{
"id": "<string>",
"parentEmail": "<string>",
"childUsername": "<string>",
"studentId": "<string>",
"diagnosticStartedAt": "<string>",
"diagnosticCompletedAt": "<string>",
"convertedTutorSubscriptionId": "<string>",
"createdAt": "<string>"
}
],
"invoices": [
{
"id": "<string>",
"subscriptionId": "<string>",
"amountCents": 123,
"issuedAt": "<string>",
"dueAt": "<string>",
"paidAt": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"hostedInvoiceUrl": "<string>"
}
],
"paymentMethods": [
{
"id": "<string>",
"subscriptionId": "<string>",
"providerId": "<string>",
"last4": "<string>",
"expiryMonth": 123,
"expiryYear": 123,
"isDefault": true,
"createdAt": "<string>"
}
],
"entitlementSummary": {
"activeSeatCount": 123,
"learnerLimit": 123,
"diagnosticOnlyCount": 123,
"managedBy": "tutor"
},
"projectionFreshness": {
"asOf": "<string>",
"stale": true
}
}Trace Learn
Trace learn billing overview
GET
/
v1
/
trace-learn
/
billing
/
overview
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'
const client = new TxAgentKitClient({
token: process.env.TX_AGENT_KIT_TOKEN
})
const response = await client.traceLearn.getTraceLearnBillingOverview(){
"plans": [
{
"id": "<string>",
"name": "<string>",
"priceCents": 500000,
"features": [
"<string>"
],
"description": "<string>",
"payerKind": "tutor",
"maxStudents": 123,
"createdAt": "<string>",
"recommended": true
}
],
"activeSubscription": {
"id": "<string>",
"payerKind": "tutor",
"payerId": "<string>",
"planId": "<string>",
"startedAt": "<string>",
"trialEndsAt": "<string>",
"nextBillingDate": "<string>",
"cancelledAt": "<string>",
"seatsPurchased": 123
},
"seatEntitlements": [
{
"id": "<string>",
"subscriptionId": "<string>",
"tutorId": "<string>",
"studentId": "<string>",
"grantedAt": "<string>",
"revokedAt": "<string>"
}
],
"freeDiagnosticAccess": [
{
"id": "<string>",
"parentEmail": "<string>",
"childUsername": "<string>",
"studentId": "<string>",
"diagnosticStartedAt": "<string>",
"diagnosticCompletedAt": "<string>",
"convertedTutorSubscriptionId": "<string>",
"createdAt": "<string>"
}
],
"invoices": [
{
"id": "<string>",
"subscriptionId": "<string>",
"amountCents": 123,
"issuedAt": "<string>",
"dueAt": "<string>",
"paidAt": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"hostedInvoiceUrl": "<string>"
}
],
"paymentMethods": [
{
"id": "<string>",
"subscriptionId": "<string>",
"providerId": "<string>",
"last4": "<string>",
"expiryMonth": 123,
"expiryYear": 123,
"isDefault": true,
"createdAt": "<string>"
}
],
"entitlementSummary": {
"activeSeatCount": 123,
"learnerLimit": 123,
"diagnosticOnlyCount": 123,
"managedBy": "tutor"
},
"projectionFreshness": {
"asOf": "<string>",
"stale": true
}
}Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I