Documentation Index
Fetch the complete documentation index at: https://docs.crxbase.com/llms.txt
Use this file to discover all available pages before exploring further.
User
Properties
| Property | Type | Description |
|---|
email | string | Email address of the user. |
paid | boolean | True if the user has at least one active plan or a lifetime plan. |
plans | UserPlan[] | Array of plans the user has purchased. |
credits_left | number | Remaining credits for the user. |
Example
{
email: "user@example.com",
paid: true,
plans: [
{
id: "plan_12345",
name: "Pro Plan",
price: 1999,
credits: 100,
description: "The Pro Plan gives you access to all features.",
billing_cycle: "monthly",
status: "active",
paid_at: "2023-10-01T12:00:00Z",
canceled_at: null,
},
...
],
credits_left: 50
}
Plan
Properties
| Property | Type | Description |
|---|
id | string | Unique identifier for the plan. |
name | string | Name of the plan. |
price | number | Price in cents (e.g., 1000 for $10.00). |
credits | number | null | Number of credits included in the plan, null if not applicable. |
description | string | null | Description of the plan, null if not applicable. |
billing_cycle | string | Billing cycle, one of once, monthly, or yearly. |
Examples
{
id: "plan_12345",
name: "Pro Plan",
price: 1999, // $19.99
credits: 100,
description: "Access to all premium features and 100 credits.",
billing_cycle: "monthly"
}
{
id: "plan_67890",
name: "Lifetime Plan",
price: 9999, // $99.99
credits: null, // No credits included
description: "One-time purchase for lifetime access.",
billing_cycle: "once"
}
UserPlan
Properties
| Property | Type | Description |
|---|
id | string | Unique identifier for the plan. |
name | string | Name of the plan. |
price | number | Price in cents (e.g., 1000 for $10.00). |
credits | number | null | Number of credits included in the plan, null if not applicable. |
description | string | null | Description of the plan, null if not applicable. |
billing_cycle | string | Billing cycle, one of once, monthly, or yearly. |
status | string | One of active, past_due or canceled |
paid_at | string | null | The date when the plan was paid/resubscribed. |
canceled_at | string | null | The date when the plan was canceled. |
Examples
{
id: "plan_67890",
name: "Lifetime Plan",
price: 9999, // $99.99
credits: null, // No credits included
description: "One-time purchase for lifetime access.",
billing_cycle: "once"
status: "active",
paid_at: "2023-10-01T12:00:00Z",
canceled_at: null,
}
{
id: "plan_12345",
name: "Pro Plan",
price: 1999, // $19.99
credits: 100,
description: "Access to all premium features and 100 credits.",
billing_cycle: "monthly"
status: "canceled",
paid_at: "2023-10-01T12:00:00Z",
canceled_at: "2023-10-15T12:00:00Z",
}
{
...
status: "past_due",
paid_at: null,
canceled_at: null,
}
UseCreditsResult
Properties
| Property | Type | Description |
|---|
success | boolean | true if credits were consumed |
credits_left | number | Remaining credits for user |
Examples
{
success: true,
credits_left: 50
}
{
success: false,
credits_left: 0
}
