Sign in

flagon-io/g1t

public

g1t/packages/contracts/src/billing.ts

223 lines8,378 bytesCodeBlame

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

Agents as a team: lifecycle, merge queue, billing and a new shell1import type { User, Viewer } from "./identity";
2import type { RepoPath } from "./repos";
3import type { Result } from "./result";
4
5/** Millionths of a US dollar in one dollar: the unit money is held in. */
6export const MICROS_PER_DOLLAR = 1_000_000;
7
8/** Whether workspaces are charged for agents at all, and with real money. */
9export type BillingStatus = {
10 /**
11 * False when no card processor is configured: nothing is charged, and who
12 * may run agents is decided some other way.
13 */
14 enabled: boolean;
15 /** False while the card processor is in its test mode, where cards are not real. */
16 live: boolean;
Free while g1t is being built out; agents can check out their own forks17 /**
18 * True while g1t is being built out: runs are recorded with what they
19 * cost, but nothing is charged and no credit is needed. Not forever.
20 */
21 free?: boolean;
Agents as a team: lifecycle, merge queue, billing and a new shell22};
23
24/** A workspace's standing. */
25export type BillingAccount = {
26 workspace: string;
27 /**
28 * Credit left, in millionths of a dollar. Can dip below zero by the cost
29 * of the runs that were under way when it ran out.
30 */
31 balanceMicros: number;
32 status: BillingStatus;
33 /** What is added to a run's cost, in percent. */
34 marginPercent: number;
Integrations: your own model provider, alerts that open issues, tickets agents read35 /** What a run on the workspace's own model provider is charged instead. */
36 orchestrationFeeMicros: number;
Agents as a team: lifecycle, merge queue, billing and a new shell37};
38
39/** One line of a workspace's statement. */
40export type LedgerEntry = {
41 id: string;
42 /** Credit bought with a card, or an agent's run. */
43 kind: "top_up" | "usage";
44 /** Positive for credit added, negative for usage. */
45 amountMicros: number;
46 description: string;
47 /** For usage: the repository and pull request the agent worked on. */
48 repo: string | null;
49 number: number | null;
50 /** For usage: `implement`, `review` or `update`. */
51 task: string | null;
52 /** For usage: the model, by its public name. */
53 model: string | null;
Integrations: your own model provider, alerts that open issues, tickets agents read54 /** For usage: who paid the model provider. */
55 billedTo: "g1t" | "workspace";
Agents as a team: lifecycle, merge queue, billing and a new shell56 /** For a top-up: the username of whoever paid. */
57 createdBy: string | null;
58 /** RFC 3339. */
59 createdAt: string;
60};
61
62/** What lets a sandbox, and nothing else, report what its run cost. */
63export type RunTicket = { runId: string; token: string };
64
65/**
66 * What agents cost, charged to the workspace they worked for. A workspace
67 * buys credit; each run deducts its cost plus g1t's margin; with no credit,
68 * no agent starts.
69 */
A free allowance on g1t's models, so anyone can try its agents70/**
71 * The free allowance on g1t's hosted models for a workspace not otherwise
72 * open to them: a few dollars of model cost each, out of one pool, until a
73 * date. Mirrors `Trial` in `crates/contracts/src/billing.rs`.
74 */
75export type Trial = {
76 open: boolean;
77 usedMicros: number;
78 limitMicros: number;
79 endsAt: string | null;
80 /** Why it is closed: `off`, `ended`, `used` (this workspace's) or `pool` (everyone's). */
81 reason: "off" | "ended" | "used" | "pool" | null;
82};
83
Paid features: a workspace turns on Deployments with a monthly plan84/**
85 * A paid feature a workspace turns on with a monthly plan, as Cloudflare's
86 * Workers for Platforms or Vercel's Pro are bought. Never free: neither
87 * `free` nor the model allowance covers it. Mirrors `Feature` in
88 * `crates/contracts/src/billing.rs`.
89 */
90export type Feature = "deployments";
91
92/** What the Deployments plan includes each month. Mirrors `deployments_allowance`. */
93export const DEPLOYMENTS_ALLOWANCE = {
94 apps: 10,
95 requests: 1_000_000,
96 cpuMs: 3_000_000,
97 /** What Cloudflare charges g1t past that, in millionths of a dollar. */
98 microsPerAppMonth: 20_000,
99 microsPerMillionRequests: 300_000,
100 microsPerMillionCpuMs: 20_000,
101} as const;
102
103export type FeaturePlan = {
104 feature: Feature;
105 title: string;
106 /** Charged every month while the plan is on, in cents. */
107 monthlyCents: number;
108 /** What the price includes, one line each. */
109 includes: string[];
110 /** How usage past the allowance is charged. */
111 overage: string;
112};
113
114export type SubscriptionStatus = "active" | "canceling" | "past_due" | "canceled";
115
116export type Subscription = {
117 feature: Feature;
118 status: SubscriptionStatus;
119 /** RFC 3339: when the period paid for ends. */
120 periodEnd: string | null;
121 startedBy: string;
122 startedAt: string;
123};
124
125/** A feature as a workspace sees it. */
126export type FeatureState = {
127 plan: FeaturePlan;
128 subscription: Subscription | null;
129 /** Whether the feature works for the workspace now. */
130 on: boolean;
131};
132
Agents as a team: lifecycle, merge queue, billing and a new shell133export interface BillingApi {
134 status(): Promise<BillingStatus>;
135 /** Members of the workspace only. */
136 account(workspace: string, viewer: Viewer): Promise<Result<BillingAccount>>;
137 /** Newest first. Members of the workspace only. */
138 ledger(workspace: string, viewer: Viewer): Promise<Result<LedgerEntry[]>>;
Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request139 /** What the workspace's agents cost since `since`, broken down. Members only. */
140 usage(workspace: string, viewer: Viewer, since: string): Promise<Result<Usage>>;
Agents as a team: lifecycle, merge queue, billing and a new shell141 /**
142 * Starts a card payment for credit and returns the page to send the
143 * person to. Owners only. The payment's id comes back to `returnUrl` as
144 * `session`.
145 */
146 checkout(actor: User, workspace: string, amountCents: number, returnUrl: string): Promise<Result<{ url: string }>>;
147 /** Credits a payment once the processor says it was made. Safe to repeat. */
148 confirm(workspace: string, viewer: Viewer, session: string): Promise<Result<BillingAccount>>;
149 /**
150 * Whether a workspace may start an agent now, asked before anything is
151 * opened for it. A failure, with the reason to show, when it has no credit.
152 */
153 canStart(workspace: string): Promise<Result<boolean>>;
A free allowance on g1t's models, so anyone can try its agents154 /** A workspace's free allowance on g1t's hosted models; `exempt` are open to them anyway. */
155 trial(workspace: string, exempt: string[]): Promise<Trial>;
Agents as a team: lifecycle, merge queue, billing and a new shell156 /**
157 * Asks whether a workspace may start an agent and opens the run it will be
158 * charged for. Null when billing is off; a failure when there is no credit.
159 */
Paid features: a workspace turns on Deployments with a monthly plan160 /** Every paid feature and the workspace's plan for each. Members only. */
161 features(workspace: string, viewer: Viewer): Promise<Result<FeatureState[]>>;
162 /**
163 * Starts the card page for a feature's monthly plan. Owners only. The
164 * page's id comes back to `returnUrl` as `session`.
165 */
166 subscribe(actor: User, workspace: string, feature: Feature, returnUrl: string): Promise<Result<{ url: string }>>;
167 /** Turns the feature on once the plan is paid for. Safe to repeat. */
168 confirmSubscription(workspace: string, viewer: Viewer, session: string): Promise<Result<FeatureState>>;
169 /** Ends a plan at the end of its period, or (`resume`) takes that back. Owners only. */
170 cancelSubscription(actor: User, workspace: string, feature: Feature, resume?: boolean): Promise<Result<FeatureState>>;
171 /** Whether a feature works for a workspace now; a failure with the reason when not. */
172 hasFeature(workspace: string, feature: Feature): Promise<Result<boolean>>;
173 /**
174 * Usage past a plan's allowance, charged from credit at cost plus the
175 * margin, once per `reference`. False if it was charged before.
176 */
177 chargeFeature(charge: {
178 workspace: string;
179 feature: Feature;
180 costMicros: number;
181 description: string;
182 repo?: string | null;
183 reference: string;
184 }): Promise<Result<boolean>>;
Agents as a team: lifecycle, merge queue, billing and a new shell185 startRun(run: {
186 workspace: string;
187 repo: RepoPath;
188 number: number;
189 task: string;
190 model: string;
Integrations: your own model provider, alerts that open issues, tickets agents read191 /** `workspace` when the run uses the workspace's own model provider. */
192 billedTo?: "g1t" | "workspace";
Agents as a team: lifecycle, merge queue, billing and a new shell193 }): Promise<Result<RunTicket | null>>;
194}
Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request195
196
197/** One slice of usage: what it was for, what it cost, how many runs. */
198export type UsageSlice = { key: string; micros: number; runs: number };
199
200/** What a workspace's agents cost over a period. */
201export type Usage = {
202 since: string;
203 /** Charged, including g1t's margin. */
204 spentMicros: number;
Integrations: your own model provider, alerts that open issues, tickets agents read205 /** What g1t's model provider charged, before the margin. */
Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request206 costMicros: number;
Integrations: your own model provider, alerts that open issues, tickets agents read207 /** What runs on the workspace's own provider cost there, estimated. Not charged by g1t. */
208 providerMicros: number;
Usage while free is shown at cost; agents get rustfmt and clippy209 /** What the runs used, at cost: g1t's models and the workspace's own provider together. */
210 usedMicros: number;
211 /** g1t charges nothing for now; the slices then measure usage at cost. */
212 free: boolean;
Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request213 runs: number;
214 /** Spend per day and task, keyed `YYYY-MM-DD/task`. */
215 byDay: UsageSlice[];
216 byTask: UsageSlice[];
217 byRepo: UsageSlice[];
218 /** Keyed `namespace/name#number`. */
219 byPull: UsageSlice[];
220 byModel: UsageSlice[];
221 /** Credit bought in the period. */
222 addedMicros: number;
223};