Skip to main content

CheckoutSessionDto

agentIdstringrequired
amountTotalobjectnullablerequired

Amount in the smallest currency unit (e.g. cents).

currencyobjectnullablerequired
sessionIdstringrequired
statusstringrequired

Possible values: [paid, free, pending, expired]

subscription objectnullable

Local subscription row — null when the Stripe webhook has not yet activated the sub. Client should fall back to polling /me/subscriptions in that case.

agentIdstringrequired
cancelAtPeriodEndbooleanrequired
canceledAtobjectnullablerequired
createdAtdate-timerequired
currentPeriodEndobjectnullablerequired
idstringrequired
statusstringrequired

canceling is a derived status surfaced when cancelAtPeriodEnd=true and Stripe still reports active/trialing (sub runs until currentPeriodEnd, then becomes canceled).

Possible values: [active, trialing, canceling, past_due, canceled, incomplete, incomplete_expired, unpaid]

stripeCustomerIdobjectnullablerequired
stripeSubscriptionIdobjectnullablerequired
tier object

Snapshot of the active tier — included on detail/list responses.

billingIntervalstringrequired

Possible values: [month, year, one_time]

currencystringrequired

ISO 4217 currency the price is denominated in (lower-case, sourced from the tier row; defaults usd).

Example: inr
isFreebooleanrequired
pricenumberrequired
tierIdstringrequired
tierNamestringrequired
tierIdstringrequired
updatedAtdate-timerequired
userIdstringrequired
tierIdstringrequired
CheckoutSessionDto
{
"agentId": "string",
"amountTotal": {},
"currency": {},
"sessionId": "string",
"status": "paid",
"subscription": {
"agentId": "string",
"cancelAtPeriodEnd": true,
"canceledAt": {},
"createdAt": "2024-07-29T15:51:28.071Z",
"currentPeriodEnd": {},
"id": "string",
"status": "active",
"stripeCustomerId": {},
"stripeSubscriptionId": {},
"tier": {
"billingInterval": "month",
"currency": "inr",
"isFree": true,
"price": 0,
"tierId": "string",
"tierName": "string"
},
"tierId": "string",
"updatedAt": "2024-07-29T15:51:28.071Z",
"userId": "string"
},
"tierId": "string"
}