GET
/
v1
/
trace-learn
/
learner
/
billing
/
core-context
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.getTraceLearnLearnerCoreContext()
{
  "planId": "plan_core_monthly",
  "planName": "<string>",
  "trialDays": 365,
  "amountDueTodayCents": 500000,
  "recurringAmountCents": 500000,
  "currency": "GBP",
  "billingInterval": "monthly",
  "childCoverage": 1,
  "features": [
    "<string>"
  ],
  "delegationExpiresAt": "<string>"
}

Response

Success

state
enum<string>
required
Available options:
trial_available,
paid_restart,
checkout_pending,
active,
billing_attention,
parent_required
planId
enum<string>
required
Available options:
plan_core_monthly
planName
string
required
trialDays
integer
required

a number between 0 and 730

Required range: 0 <= x <= 730
amountDueTodayCents
integer
required

a number between 0 and 1000000

Required range: 0 <= x <= 1000000
recurringAmountCents
integer
required

a number between 0 and 1000000

Required range: 0 <= x <= 1000000
currency
enum<string>
required
Available options:
GBP
billingInterval
enum<string>
required
Available options:
monthly
childCoverage
enum<number>
required
Available options:
1
features
string[]
required
delegationExpiresAt
string | null
required

a string at least 10 character(s) long

Minimum string length: 10