g1t/crates/contracts/src/billing.rs
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 shell | 1 | //! The billing service: what agents cost, charged to the workspace they |
| 2 | //! worked for. | |
| 3 | //! | |
| 4 | //! A workspace buys credit and each agent run deducts what it cost, plus | |
| 5 | //! g1t's margin. With no credit, no agent starts. Money is held in | |
| 6 | //! millionths of a US dollar, so that a run costing a fraction of a cent is | |
| 7 | //! recorded exactly. | |
| 8 | //! | |
| 9 | //! Each `*Args` struct is the argument of the method of the same name, | |
| 10 | //! served at `POST /rpc/<method>`. | |
| 11 | ||
| 12 | use serde::{Deserialize, Serialize}; | |
| 13 | ||
| 14 | use crate::repos::RepoPath; | |
| 15 | use crate::{User, Viewer}; | |
| 16 | ||
| 17 | /// Millionths of a US dollar in one dollar. | |
| 18 | pub const MICROS_PER_DOLLAR: i64 = 1_000_000; | |
| 19 | ||
| 20 | /// Whether workspaces are charged for agents at all, and with real money. | |
| 21 | /// `status` takes nothing and returns this. | |
| 22 | #[derive(Clone, Copy, Debug, Default, Serialize, Deserialize)] | |
| 23 | pub struct Status { | |
| 24 | /// False when no payment provider is configured: nothing is charged, | |
| 25 | /// and who may run agents is decided some other way. | |
| 26 | pub enabled: bool, | |
| 27 | /// False while the payment provider is in its test mode, where cards | |
| 28 | /// are not real. | |
| 29 | pub live: bool, | |
| Free while g1t is being built out; agents can check out their own forks | 30 | /// True while g1t is being built out: runs are recorded, with what |
| 31 | /// they cost, but nothing is charged and no credit is needed. Not a | |
| 32 | /// promise that it stays free. | |
| 33 | #[serde(default)] | |
| 34 | pub free: bool, | |
| Agents as a team: lifecycle, merge queue, billing and a new shell | 35 | } |
| 36 | ||
| A free allowance on g1t's models, so anyone can try its agents | 37 | /// `trial`: the free allowance on g1t's hosted models for a workspace that |
| 38 | /// is not otherwise open to them, so people can try g1t's agents without a | |
| 39 | /// key of their own. Each workspace gets a few dollars of model cost, out | |
| 40 | /// of one pool, until an end date. Returns `Trial`. | |
| 41 | #[derive(Debug, Serialize, Deserialize)] | |
| 42 | #[serde(rename_all = "camelCase")] | |
| 43 | pub struct TrialArgs { | |
| 44 | pub workspace: String, | |
| 45 | /// Workspaces open to hosted models anyway, whose use is not counted | |
| 46 | /// against the pool. | |
| 47 | #[serde(default)] | |
| 48 | pub exempt: Vec<String>, | |
| 49 | } | |
| 50 | ||
| 51 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 52 | #[serde(rename_all = "camelCase")] | |
| 53 | pub struct Trial { | |
| 54 | /// Whether its agents may use g1t's hosted models on the allowance now. | |
| 55 | pub open: bool, | |
| 56 | /// What its runs on g1t's models have cost, in millionths of a dollar. | |
| 57 | pub used_micros: i64, | |
| 58 | pub limit_micros: i64, | |
| 59 | /// RFC 3339; when the allowance ends for everyone. | |
| 60 | pub ends_at: Option<String>, | |
| 61 | /// Why it is closed: `off` (no allowance), `ended`, `used` (this | |
| 62 | /// workspace's is spent) or `pool` (everyone's is). | |
| 63 | pub reason: Option<String>, | |
| 64 | } | |
| 65 | ||
| Agents as a team: lifecycle, merge queue, billing and a new shell | 66 | /// A workspace's standing. |
| 67 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 68 | #[serde(rename_all = "camelCase")] | |
| 69 | pub struct Account { | |
| 70 | pub workspace: String, | |
| 71 | /// Credit left, in millionths of a dollar. Can dip below zero by the | |
| 72 | /// cost of the runs that were under way when it ran out. | |
| 73 | pub balance_micros: i64, | |
| 74 | pub status: Status, | |
| 75 | /// What is added to a run's cost, in percent. | |
| 76 | pub margin_percent: u32, | |
| Integrations: your own model provider, alerts that open issues, tickets agents read | 77 | /// What a run on the workspace's own model provider is charged: g1t's |
| 78 | /// sandbox and orchestration, with the model paid for elsewhere. | |
| 79 | pub orchestration_fee_micros: i64, | |
| Agents as a team: lifecycle, merge queue, billing and a new shell | 80 | } |
| 81 | ||
| 82 | #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] | |
| 83 | #[serde(rename_all = "snake_case")] | |
| 84 | pub enum EntryKind { | |
| 85 | /// Credit bought with a card. | |
| 86 | TopUp, | |
| Paid features: a workspace turns on Deployments with a monthly plan | 87 | /// An agent's run, or a paid feature's usage past its allowance. |
| Agents as a team: lifecycle, merge queue, billing and a new shell | 88 | Usage, |
| 89 | } | |
| 90 | ||
| 91 | /// One line of a workspace's statement. | |
| 92 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 93 | #[serde(rename_all = "camelCase")] | |
| 94 | pub struct LedgerEntry { | |
| 95 | pub id: String, | |
| 96 | pub kind: EntryKind, | |
| 97 | /// Positive for credit added, negative for usage. | |
| 98 | pub amount_micros: i64, | |
| 99 | pub description: String, | |
| 100 | /// For usage: the repository and pull request the agent worked on. | |
| 101 | pub repo: Option<String>, | |
| 102 | pub number: Option<u32>, | |
| 103 | /// For usage: `implement`, `review` or `update`. | |
| 104 | pub task: Option<String>, | |
| 105 | /// For usage: the model, by its public name. | |
| 106 | pub model: Option<String>, | |
| Integrations: your own model provider, alerts that open issues, tickets agents read | 107 | /// For usage: `g1t` when g1t paid the model provider, `workspace` when |
| 108 | /// the workspace's own account did and only orchestration is charged. | |
| 109 | #[serde(default = "g1t")] | |
| 110 | pub billed_to: String, | |
| Agents as a team: lifecycle, merge queue, billing and a new shell | 111 | /// For a top-up: the username of whoever paid. |
| 112 | pub created_by: Option<String>, | |
| 113 | /// RFC 3339. | |
| 114 | pub created_at: String, | |
| 115 | } | |
| 116 | ||
| Integrations: your own model provider, alerts that open issues, tickets agents read | 117 | fn g1t() -> String { |
| 118 | "g1t".to_owned() | |
| 119 | } | |
| 120 | ||
| Agents as a team: lifecycle, merge queue, billing and a new shell | 121 | /// `account` (`Outcome<Account>`) and `ledger` (`Outcome<Vec<LedgerEntry>>`, |
| 122 | /// newest first). Members of the workspace only. | |
| 123 | #[derive(Debug, Serialize, Deserialize)] | |
| 124 | pub struct AccountArgs { | |
| 125 | pub workspace: String, | |
| 126 | pub viewer: Viewer, | |
| 127 | } | |
| 128 | ||
| 129 | /// `checkout`: starts a card payment for credit. Owners of the workspace | |
| 130 | /// only. Returns `Outcome<Checkout>`. | |
| 131 | #[derive(Debug, Serialize, Deserialize)] | |
| 132 | #[serde(rename_all = "camelCase")] | |
| 133 | pub struct CheckoutArgs { | |
| 134 | pub actor: User, | |
| 135 | pub workspace: String, | |
| 136 | /// How much credit to buy, in cents. | |
| 137 | pub amount_cents: u32, | |
| 138 | /// Where the payment page sends the person afterwards. The payment's | |
| 139 | /// id is appended as `session`. | |
| 140 | pub return_url: String, | |
| 141 | } | |
| 142 | ||
| 143 | #[derive(Debug, Serialize, Deserialize)] | |
| 144 | pub struct Checkout { | |
| 145 | /// The payment page to send the person to. | |
| 146 | pub url: String, | |
| 147 | } | |
| 148 | ||
| 149 | /// `confirm`: credits a payment once the provider says it was made. Safe | |
| 150 | /// to call any number of times. Returns `Outcome<Account>`. | |
| 151 | #[derive(Debug, Serialize, Deserialize)] | |
| 152 | pub struct ConfirmArgs { | |
| 153 | pub workspace: String, | |
| 154 | pub viewer: Viewer, | |
| 155 | /// The payment's id, as returned to `return_url`. | |
| 156 | pub session: String, | |
| 157 | } | |
| 158 | ||
| 159 | /// `can_start`: whether a workspace may start an agent now, asked before | |
| 160 | /// anything is opened for it. Returns `Outcome<bool>`: a failure, with the | |
| 161 | /// reason to show, when it has no credit. | |
| 162 | #[derive(Debug, Serialize, Deserialize)] | |
| 163 | pub struct CanStartArgs { | |
| 164 | pub workspace: String, | |
| 165 | } | |
| 166 | ||
| 167 | /// `start_run`: asks whether a workspace may start an agent, and opens the | |
| 168 | /// run it will be charged for. Called by the runner service. Returns | |
| 169 | /// `Outcome<Option<RunTicket>>`: no ticket when billing is off, a failure | |
| 170 | /// when the workspace has no credit. | |
| 171 | #[derive(Debug, Serialize, Deserialize)] | |
| 172 | pub struct StartRunArgs { | |
| 173 | pub workspace: String, | |
| 174 | pub repo: RepoPath, | |
| 175 | pub number: u32, | |
| 176 | /// `implement`, `review` or `update`. | |
| 177 | pub task: String, | |
| 178 | /// The model, by its public name. | |
| 179 | pub model: String, | |
| Integrations: your own model provider, alerts that open issues, tickets agents read | 180 | /// `workspace` when the run uses the workspace's own model provider. |
| Models per workspace: several providers, routed by kind of work | 181 | /// The runner, which is TypeScript, sends it as `billedTo`. |
| 182 | #[serde(default = "g1t", alias = "billedTo")] | |
| Integrations: your own model provider, alerts that open issues, tickets agents read | 183 | pub billed_to: String, |
| Agents as a team: lifecycle, merge queue, billing and a new shell | 184 | } |
| 185 | ||
| 186 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 187 | #[serde(rename_all = "camelCase")] | |
| 188 | pub struct RunTicket { | |
| 189 | pub run_id: String, | |
| 190 | /// Lets the sandbox, and nothing else, report what this run cost. | |
| 191 | pub token: String, | |
| 192 | } | |
| 193 | ||
| 194 | /// `finish_run`: what a run cost, as its sandbox reports it. Charged once. | |
| 195 | /// Returns `Outcome<bool>`. | |
| 196 | #[derive(Debug, Serialize, Deserialize)] | |
| 197 | #[serde(rename_all = "camelCase")] | |
| 198 | pub struct FinishRunArgs { | |
| 199 | pub run_id: String, | |
| 200 | pub token: String, | |
| 201 | /// What the model provider charged, in US dollars. | |
| 202 | pub cost_usd: f64, | |
| 203 | #[serde(default)] | |
| 204 | pub turns: u32, | |
| 205 | } | |
| Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request | 206 | |
| 207 | ||
| 208 | /// `usage`: what a workspace's agents cost over a period, broken down. | |
| 209 | /// Members only. Returns `Outcome<Usage>`. | |
| 210 | #[derive(Debug, Serialize, Deserialize)] | |
| 211 | pub struct UsageArgs { | |
| 212 | pub workspace: String, | |
| 213 | pub viewer: Viewer, | |
| 214 | /// RFC 3339: the start of the period. The period runs to now. | |
| 215 | pub since: String, | |
| 216 | } | |
| 217 | ||
| 218 | /// One slice of usage: what it was for, what it cost, how many runs. | |
| 219 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 220 | #[serde(rename_all = "camelCase")] | |
| 221 | pub struct UsageSlice { | |
| 222 | pub key: String, | |
| 223 | pub micros: i64, | |
| 224 | pub runs: u32, | |
| 225 | } | |
| 226 | ||
| 227 | /// What a workspace's agents cost over a period. | |
| 228 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 229 | #[serde(rename_all = "camelCase")] | |
| 230 | pub struct Usage { | |
| 231 | pub since: String, | |
| 232 | /// Charged, including g1t's margin. | |
| 233 | pub spent_micros: i64, | |
| Integrations: your own model provider, alerts that open issues, tickets agents read | 234 | /// What g1t's model provider charged, before the margin. |
| Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request | 235 | pub cost_micros: i64, |
| Integrations: your own model provider, alerts that open issues, tickets agents read | 236 | /// What runs on the workspace's own provider cost there, as the harness |
| 237 | /// estimated it. Not charged by g1t. | |
| 238 | pub provider_micros: i64, | |
| Usage while free is shown at cost; agents get rustfmt and clippy | 239 | /// What the runs used, at cost: g1t's models and the workspace's own |
| 240 | /// provider together, whatever was charged for them. | |
| 241 | pub used_micros: i64, | |
| 242 | /// g1t charges nothing for now. The slices then measure usage at cost, | |
| 243 | /// since every charge is zero. | |
| 244 | pub free: bool, | |
| Usage, like a hosting provider's: what agents cost, per day, task, repository and pull request | 245 | pub runs: u32, |
| 246 | /// Spend per day (`YYYY-MM-DD`) and task, as `day/task` keys. | |
| 247 | pub by_day: Vec<UsageSlice>, | |
| 248 | /// Per task: implement, review, revise, update, plan. | |
| 249 | pub by_task: Vec<UsageSlice>, | |
| 250 | /// Per repository, `namespace/name`. | |
| 251 | pub by_repo: Vec<UsageSlice>, | |
| 252 | /// The pull requests that cost most, as `namespace/name#number`. | |
| 253 | pub by_pull: Vec<UsageSlice>, | |
| 254 | /// Per model, by its public name. | |
| 255 | pub by_model: Vec<UsageSlice>, | |
| 256 | /// Credit bought in the period. | |
| 257 | pub added_micros: i64, | |
| 258 | } | |
| Models per workspace: several providers, routed by kind of work | 259 | |
| Paid features: a workspace turns on Deployments with a monthly plan | 260 | /// A paid feature a workspace turns on with a monthly plan, the way |
| 261 | /// Cloudflare's Workers for Platforms or Vercel's Pro are bought. Never | |
| 262 | /// free: `FREE_WHILE_BUILDING` and the free model allowance do not cover | |
| 263 | /// it. | |
| 264 | #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] | |
| 265 | #[serde(rename_all = "snake_case")] | |
| 266 | pub enum Feature { | |
| 267 | /// Previews per pull request and production on g1t.page. | |
| 268 | Deployments, | |
| 269 | } | |
| 270 | ||
| 271 | impl Feature { | |
| 272 | pub const ALL: [Feature; 1] = [Feature::Deployments]; | |
| 273 | ||
| 274 | pub fn as_str(self) -> &'static str { | |
| 275 | match self { | |
| 276 | Feature::Deployments => "deployments", | |
| 277 | } | |
| 278 | } | |
| 279 | ||
| 280 | pub fn parse(name: &str) -> Option<Feature> { | |
| 281 | Feature::ALL.into_iter().find(|feature| feature.as_str() == name) | |
| 282 | } | |
| 283 | ||
| 284 | pub fn title(self) -> &'static str { | |
| 285 | match self { | |
| 286 | Feature::Deployments => "Deployments", | |
| 287 | } | |
| 288 | } | |
| 289 | } | |
| 290 | ||
| 291 | /// What the Deployments plan includes each month; usage past it is charged | |
| 292 | /// at cost plus the margin. The billing service describes the plan with | |
| 293 | /// these and the deployments service meters against them. | |
| 294 | pub mod deployments_allowance { | |
| 295 | /// Apps deployed at once: production and previews together. | |
| 296 | pub const APPS: u32 = 10; | |
| 297 | pub const REQUESTS: u64 = 1_000_000; | |
| 298 | pub const CPU_MS: u64 = 3_000_000; | |
| 299 | /// What Cloudflare charges g1t past that, in millionths of a dollar. | |
| 300 | pub const MICROS_PER_APP_MONTH: i64 = 20_000; | |
| 301 | pub const MICROS_PER_MILLION_REQUESTS: i64 = 300_000; | |
| 302 | pub const MICROS_PER_MILLION_CPU_MS: i64 = 20_000; | |
| Deployments: a preview for every pull request, production on g1t.page | 303 | /// What one second of a build's sandbox costs g1t (Cloudflare |
| 304 | /// Containers, standard-1: half a vCPU, 4 GiB, 8 GB disk), rounded up. | |
| 305 | /// Builds are not in the allowance: each is charged at this plus the | |
| 306 | /// margin. | |
| 307 | pub const MICROS_PER_BUILD_SECOND: i64 = 21; | |
| Paid features: a workspace turns on Deployments with a monthly plan | 308 | } |
| 309 | ||
| Every sandbox is metered by the second | 310 | /// Sandbox time: every sandbox g1t starts for a workspace (agents, |
| 311 | /// reviews, checks, the merge queue, workflow jobs) is metered by the | |
| 312 | /// second. Deploy builds are charged by the Deployments plan instead. | |
| 313 | pub mod sandbox_allowance { | |
| 314 | /// Free each calendar month (UTC): 500 minutes. | |
| 315 | pub const FREE_SECONDS: i64 = 30_000; | |
| 316 | /// What one second costs g1t (Cloudflare Containers, standard-1), | |
| 317 | /// rounded up. Recorded with every entry. | |
| 318 | pub const COST_MICROS_PER_SECOND: i64 = super::deployments_allowance::MICROS_PER_BUILD_SECOND; | |
| 319 | /// What one second past the free minutes is charged: $0.003 a minute. | |
| 320 | pub const MICROS_PER_SECOND: i64 = 50; | |
| 321 | } | |
| 322 | ||
| 323 | /// `record_sandbox`: how long one sandbox ran for a workspace, reported by | |
| 324 | /// the runner when it stops. Recorded once per `reference`, with what it | |
| 325 | /// cost g1t; seconds past the month's free minutes are charged at | |
| 326 | /// `sandbox_allowance::MICROS_PER_SECOND`, unless `FREE_WHILE_BUILDING`. | |
| 327 | /// Returns `Outcome<bool>`: false if that reference was recorded before. | |
| 328 | #[derive(Debug, Serialize, Deserialize)] | |
| 329 | #[serde(rename_all = "camelCase")] | |
| 330 | pub struct RecordSandboxArgs { | |
| 331 | pub workspace: String, | |
| 332 | pub seconds: u32, | |
| 333 | /// What ran, e.g. `Checks on acme/api#12`. | |
| 334 | pub description: String, | |
| 335 | /// `namespace/name`. | |
| 336 | pub repo: Option<String>, | |
| 337 | /// Unique to the run. | |
| 338 | pub reference: String, | |
| 339 | } | |
| 340 | ||
| Usage limits: unpaid usage can only go so far | 341 | /// How much a workspace has earned g1t's trust with money, which sets how |
| 342 | /// far its unpaid usage can go before its work stops. | |
| 343 | #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] | |
| 344 | #[serde(rename_all = "snake_case")] | |
| 345 | pub enum Trust { | |
| 346 | /// No live payment yet: only a little past the free allowances. | |
| 347 | New, | |
| 348 | /// Has paid g1t real money: the ceiling grows with what it has paid. | |
| 349 | Paid, | |
| 350 | /// A ceiling g1t set by hand, after talking to the workspace. | |
| 351 | Reviewed, | |
| 352 | /// g1t's own workspaces: no ceiling. | |
| 353 | Internal, | |
| 354 | } | |
| 355 | ||
| 356 | #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] | |
| 357 | #[serde(rename_all = "snake_case")] | |
| 358 | pub enum LimitState { | |
| 359 | Ok, | |
| 360 | /// Past 80% of the ceiling. | |
| 361 | Warning, | |
| 362 | /// At or past it: no new sandboxes, builds or app requests. | |
| 363 | Stopped, | |
| 364 | } | |
| 365 | ||
| 366 | /// How far a workspace's unpaid usage has gone this month, and where its | |
| 367 | /// work stops: like Fly's or Cloudflare's limits for new accounts, so no | |
| 368 | /// one runs up costs g1t cannot collect. Usage counts at what it cost g1t | |
| 369 | /// or what it is charged, whichever is more, so it counts while g1t is | |
| 370 | /// free too. | |
| 371 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 372 | #[serde(rename_all = "camelCase")] | |
| 373 | pub struct Limit { | |
| 374 | pub workspace: String, | |
| 375 | pub trust: Trust, | |
| 376 | /// Usage this month (UTC) less what was paid this month. | |
| 377 | pub exposure_micros: i64, | |
| 378 | /// Where work stops: the lower of g1t's ceiling and the owner's own | |
| 379 | /// spend limit. None for g1t's own workspaces. | |
| 380 | pub ceiling_micros: Option<i64>, | |
| 381 | /// The ceiling g1t sets from `trust`. | |
| 382 | pub trust_ceiling_micros: Option<i64>, | |
| 383 | /// The owner's own monthly limit, if they set one. | |
| 384 | pub spend_limit_micros: Option<i64>, | |
| 385 | pub state: LimitState, | |
| 386 | /// What to tell people when work is stopped or close to it. | |
| 387 | pub message: Option<String>, | |
| 388 | } | |
| 389 | ||
| 390 | /// `limit`: a workspace's limit, for its members. Returns `Outcome<Limit>`. | |
| 391 | #[derive(Debug, Serialize, Deserialize)] | |
| 392 | pub struct LimitArgs { | |
| 393 | pub workspace: String, | |
| 394 | pub viewer: Viewer, | |
| 395 | } | |
| 396 | ||
| 397 | /// `check_limit`: the same, for the services that enforce it. Returns | |
| 398 | /// `Outcome<Limit>`. | |
| 399 | #[derive(Debug, Serialize, Deserialize)] | |
| 400 | pub struct CheckLimitArgs { | |
| 401 | pub workspace: String, | |
| 402 | } | |
| 403 | ||
| 404 | /// `set_spend_limit`: the owner's own monthly ceiling, under g1t's; None | |
| 405 | /// removes it. Owners only. Returns `Outcome<Limit>`. | |
| 406 | #[derive(Debug, Serialize, Deserialize)] | |
| 407 | #[serde(rename_all = "camelCase")] | |
| 408 | pub struct SetSpendLimitArgs { | |
| 409 | pub actor: User, | |
| 410 | pub workspace: String, | |
| 411 | pub spend_limit_micros: Option<i64>, | |
| 412 | } | |
| 413 | ||
| Paid features: a workspace turns on Deployments with a monthly plan | 414 | /// What a feature's plan costs and includes. |
| 415 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 416 | #[serde(rename_all = "camelCase")] | |
| 417 | pub struct Plan { | |
| 418 | pub feature: Feature, | |
| 419 | pub title: String, | |
| 420 | /// Charged every month while the plan is on, in cents. | |
| 421 | pub monthly_cents: u32, | |
| 422 | /// What the monthly price includes, one line each, for people to read. | |
| 423 | pub includes: Vec<String>, | |
| 424 | /// How usage past the allowance is charged, for people to read. | |
| 425 | pub overage: String, | |
| 426 | } | |
| 427 | ||
| 428 | #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] | |
| 429 | #[serde(rename_all = "snake_case")] | |
| 430 | pub enum SubscriptionStatus { | |
| 431 | /// Paid up; the feature works. | |
| 432 | Active, | |
| 433 | /// Paid up to the end of the period, and ends then. | |
| 434 | Canceling, | |
| 435 | /// The last payment failed; the feature is off until it is paid. | |
| 436 | PastDue, | |
| 437 | /// Ended. | |
| 438 | Canceled, | |
| 439 | } | |
| 440 | ||
| 441 | impl SubscriptionStatus { | |
| 442 | /// Whether the feature works in this state. | |
| 443 | pub fn on(self) -> bool { | |
| 444 | matches!(self, SubscriptionStatus::Active | SubscriptionStatus::Canceling) | |
| 445 | } | |
| 446 | } | |
| 447 | ||
| 448 | /// A workspace's plan for one feature. | |
| 449 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 450 | #[serde(rename_all = "camelCase")] | |
| 451 | pub struct Subscription { | |
| 452 | pub feature: Feature, | |
| 453 | pub status: SubscriptionStatus, | |
| 454 | /// RFC 3339: when the period paid for ends, and the plan renews or | |
| 455 | /// ends. | |
| 456 | pub period_end: Option<String>, | |
| 457 | /// Username of whoever turned it on. | |
| 458 | pub started_by: String, | |
| 459 | /// RFC 3339. | |
| 460 | pub started_at: String, | |
| 461 | } | |
| 462 | ||
| 463 | /// A feature as a workspace sees it: what it costs, and its plan if it has | |
| 464 | /// one. | |
| 465 | #[derive(Clone, Debug, Serialize, Deserialize)] | |
| 466 | #[serde(rename_all = "camelCase")] | |
| 467 | pub struct FeatureState { | |
| 468 | pub plan: Plan, | |
| 469 | pub subscription: Option<Subscription>, | |
| 470 | /// Whether the feature works for the workspace now. | |
| 471 | pub on: bool, | |
| 472 | } | |
| 473 | ||
| 474 | /// `features`: every paid feature and the workspace's plan for each. | |
| 475 | /// Members only. Returns `Outcome<Vec<FeatureState>>`. | |
| 476 | #[derive(Debug, Serialize, Deserialize)] | |
| 477 | pub struct FeaturesArgs { | |
| 478 | pub workspace: String, | |
| 479 | pub viewer: Viewer, | |
| 480 | } | |
| 481 | ||
| 482 | /// `subscribe`: starts the card page for a feature's monthly plan. Owners | |
| 483 | /// only. Returns `Outcome<Checkout>`; the page's id comes back to | |
| 484 | /// `return_url` as `session`, for `confirm_subscription`. | |
| 485 | #[derive(Debug, Serialize, Deserialize)] | |
| 486 | #[serde(rename_all = "camelCase")] | |
| 487 | pub struct SubscribeArgs { | |
| 488 | pub actor: User, | |
| 489 | pub workspace: String, | |
| 490 | pub feature: Feature, | |
| 491 | pub return_url: String, | |
| 492 | } | |
| 493 | ||
| 494 | /// `confirm_subscription`: turns the feature on once the processor says | |
| 495 | /// the plan was paid for. Safe to call any number of times. Returns | |
| 496 | /// `Outcome<FeatureState>`. | |
| 497 | #[derive(Debug, Serialize, Deserialize)] | |
| 498 | pub struct ConfirmSubscriptionArgs { | |
| 499 | pub workspace: String, | |
| 500 | pub viewer: Viewer, | |
| 501 | pub session: String, | |
| 502 | } | |
| 503 | ||
| 504 | /// `cancel_subscription` (`resume` false) ends a plan at the end of the | |
| 505 | /// period paid for; with `resume` true, takes that back. Owners only. | |
| 506 | /// Returns `Outcome<FeatureState>`. | |
| 507 | #[derive(Debug, Serialize, Deserialize)] | |
| 508 | pub struct CancelSubscriptionArgs { | |
| 509 | pub actor: User, | |
| 510 | pub workspace: String, | |
| 511 | pub feature: Feature, | |
| 512 | #[serde(default)] | |
| 513 | pub resume: bool, | |
| 514 | } | |
| 515 | ||
| 516 | /// `has_feature`: whether a feature works for a workspace now, asked by the | |
| 517 | /// service that provides it before doing paid work. Returns | |
| 518 | /// `Outcome<bool>`: a failure, with the reason to show, when it does not. | |
| 519 | /// True everywhere when no card processor is configured. | |
| 520 | #[derive(Debug, Serialize, Deserialize)] | |
| 521 | pub struct HasFeatureArgs { | |
| 522 | pub workspace: String, | |
| 523 | pub feature: Feature, | |
| 524 | } | |
| 525 | ||
| 526 | /// `charge_feature`: usage of a feature past its plan's allowance, charged | |
| 527 | /// from the workspace's credit at cost plus the margin, whatever | |
| 528 | /// `FREE_WHILE_BUILDING` says. Called by the service that provides it. | |
| 529 | /// Charged once per `reference`. Returns `Outcome<bool>`: false if that | |
| 530 | /// reference was charged before. | |
| 531 | #[derive(Debug, Serialize, Deserialize)] | |
| 532 | #[serde(rename_all = "camelCase")] | |
| 533 | pub struct ChargeFeatureArgs { | |
| 534 | pub workspace: String, | |
| 535 | pub feature: Feature, | |
| 536 | /// What it cost g1t, in millionths of a dollar, before the margin. | |
| 537 | pub cost_micros: i64, | |
| 538 | pub description: String, | |
| 539 | /// `namespace/name`, when the usage was one repository's. | |
| 540 | pub repo: Option<String>, | |
| 541 | /// Unique to this charge, e.g. `deployments/acme/2026-10`. | |
| 542 | pub reference: String, | |
| 543 | } | |
| 544 | ||
| Models per workspace: several providers, routed by kind of work | 545 | #[cfg(test)] |
| 546 | mod tests { | |
| 547 | use super::*; | |
| 548 | ||
| 549 | #[test] | |
| Paid features: a workspace turns on Deployments with a monthly plan | 550 | fn features_are_named_as_the_site_sends_them() { |
| 551 | assert_eq!( | |
| 552 | serde_json::to_value(Feature::Deployments).unwrap(), | |
| 553 | serde_json::json!("deployments") | |
| 554 | ); | |
| 555 | assert_eq!(Feature::parse("deployments"), Some(Feature::Deployments)); | |
| 556 | assert!(SubscriptionStatus::Canceling.on()); | |
| 557 | assert!(!SubscriptionStatus::PastDue.on()); | |
| 558 | } | |
| 559 | ||
| 560 | #[test] | |
| Models per workspace: several providers, routed by kind of work | 561 | fn who_pays_is_read_as_the_runner_sends_it() { |
| 562 | let run: StartRunArgs = serde_json::from_value(serde_json::json!({ | |
| 563 | "workspace": "acme", | |
| 564 | "repo": { "namespace": "acme", "name": "web" }, | |
| 565 | "number": 7, | |
| 566 | "task": "implement", | |
| 567 | "model": "Claude Sonnet 5.5", | |
| 568 | "billedTo": "workspace", | |
| 569 | })) | |
| 570 | .unwrap(); | |
| 571 | assert_eq!(run.billed_to, "workspace"); | |
| 572 | } | |
| 573 | } |