Skip to content

fix(billing): read the one-number usage shape (AIT-436) #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ord669 merged 2 commits into from
Aug 20, 2026
Merged

fix(billing): read the one-number usage shape (AIT-436) #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2f285a
fix(billing): read the one-number usage shape (AIT-436)
ord669 Aug 20, 2026
d782dfe
test(billing): fixtures carry usageUnit, matching the contract
ord669 Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 32 additions & 25 deletions src/__tests__/billing.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,18 @@ async function advanceUntilSettled(
}
}

function mockSubAndUsage(sub: any, usage: { totalMessages: number; limit: number; percentage: number }) {
// AIT-436: `usageUnit` is part of the /webhook/usage contract, so a fixture
// without it is a payload the backend never sends (CodeRabbit, PR #62). It
// defaults to the legacy meter, which is what every one of these cases is.
function mockSubAndUsage(
sub: any,
usage: { total: number; limit: number; percentage: number; usageUnit?: 'messages' | 'actions' },
) {
const withUnit = { usageUnit: 'messages' as const, ...usage };
mockedApiClient.mockImplementation(async (path: string) => {
if (path === '/workspaces') return WORKSPACES;
if (path === SUBSCRIPTION_PATH) return sub;
if (path === '/webhook/usage') return usage;
if (path === '/webhook/usage') return withUnit;
throw new Error(`unexpected path: ${path}`);
});
}
Expand Down Expand Up @@ -122,7 +129,7 @@ describe('billing commands', () => {

describe('billingStatus', () => {
it('calls apiClient with GET the org subscription route and /webhook/usage', async () => {
mockSubAndUsage(activeSub, { totalMessages: 100, limit: 1200, percentage: 8 });
mockSubAndUsage(activeSub, { total: 100, limit: 1200, percentage: 8 });

await billingStatus({ human: false });

Expand All @@ -135,7 +142,7 @@ describe('billing commands', () => {

describe('billingStatus json', () => {
it('emits structured { subscription, usage } when human=false', async () => {
const usage = { totalMessages: 100, limit: 1200, percentage: 8 };
const usage = { total: 100, limit: 1200, percentage: 8, usageUnit: 'messages' as const };
mockSubAndUsage(activeSub, usage);

await billingStatus({ human: false });
Expand All @@ -151,7 +158,7 @@ describe('billing commands', () => {

describe('billingStatus human', () => {
it('renders plan/status/interval/renews/messages with no nudge under 80%', async () => {
mockSubAndUsage(activeSub, { totalMessages: 600, limit: 1200, percentage: 50 });
mockSubAndUsage(activeSub, { total: 600, limit: 1200, percentage: 50 });

await billingStatus({ human: true });

Expand All @@ -168,7 +175,7 @@ describe('billing commands', () => {

describe('billingStatus human — free tier', () => {
it('renders interval/renews as "n/a" (not an em-dash) when the subscription has no billing fields', async () => {
mockSubAndUsage(freeSub, { totalMessages: 10, limit: 50, percentage: 20 });
mockSubAndUsage(freeSub, { total: 10, limit: 50, percentage: 20 });

await billingStatus({ human: true });

Expand All @@ -182,7 +189,7 @@ describe('billing commands', () => {
describe('billingStatus cancel warning', () => {
it('prints cancel warning when cancelAtPeriodEnd is true', async () => {
mockSubAndUsage({ ...activeSub, cancelAtPeriodEnd: true }, {
totalMessages: 100,
total: 100,
limit: 1200,
percentage: 8,
});
Expand All @@ -196,7 +203,7 @@ describe('billing commands', () => {

describe('billingStatus 80% nudge', () => {
it('prints yellow nudge with billing upgrade reference at 85%', async () => {
mockSubAndUsage(activeSub, { totalMessages: 1020, limit: 1200, percentage: 85 });
mockSubAndUsage(activeSub, { total: 1020, limit: 1200, percentage: 85 });

await billingStatus({ human: true });

Expand All @@ -208,7 +215,7 @@ describe('billing commands', () => {

describe('billingStatus 100% over limit', () => {
it('prints red exceeded line at 105%', async () => {
mockSubAndUsage(activeSub, { totalMessages: 1260, limit: 1200, percentage: 105 });
mockSubAndUsage(activeSub, { total: 1260, limit: 1200, percentage: 105 });

await billingStatus({ human: true });

Expand Down Expand Up @@ -239,7 +246,7 @@ describe('billing commands', () => {
unlimited: true,
trial: { status: 'not_started', endsAt: null, daysLeft: null },
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -260,7 +267,7 @@ describe('billing commands', () => {
unlimited: false,
trial: { status: 'active', endsAt: '2026-08-22T00:00:00.000Z', daysLeft: 4 },
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -283,7 +290,7 @@ describe('billing commands', () => {
actionsQuota: 0,
unlimited: false,
},
{ totalMessages: 1234, limit: 30000, percentage: 4 },
{ total: 1234, limit: 30000, percentage: 4 },
);

await billingStatus({ human: true });
Expand All @@ -307,7 +314,7 @@ describe('billing commands', () => {
trial: null,
cancelAtPeriodEnd: true,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -329,7 +336,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -350,7 +357,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ json: true });
Expand All @@ -371,7 +378,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -392,7 +399,7 @@ describe('billing commands', () => {
unlimited: false,
trial: { status: 'expired', endsAt: '2026-08-10T00:00:00.000Z', daysLeft: 0 },
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);
mockedGetBillingEligibility.mockResolvedValueOnce({
eligiblePlan: 'build',
Expand All @@ -419,7 +426,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -439,7 +446,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -460,7 +467,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -480,7 +487,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: true });
Expand All @@ -491,7 +498,7 @@ describe('billing commands', () => {
});

it('legacy org (no usageUnit) is untouched: no eligibility call, existing output shape', async () => {
mockSubAndUsage(activeSub, { totalMessages: 600, limit: 1200, percentage: 50 });
mockSubAndUsage(activeSub, { total: 600, limit: 1200, percentage: 50 });

await billingStatus({ human: true });

Expand All @@ -512,7 +519,7 @@ describe('billing commands', () => {
unlimited: false,
trial: null,
},
{ totalMessages: 0, limit: 0, percentage: 0 },
{ total: 0, limit: 0, percentage: 0 },
);

await billingStatus({ human: false });
Expand Down Expand Up @@ -958,7 +965,7 @@ describe('billing commands — npx prefix roll-out (cliCommandPrefix)', () => {
});

it('billingStatus 80% nudge prints "npx hookmyapp billing upgrade" under npm_command=exec', async () => {
mockSubAndUsage(activeSub, { totalMessages: 1020, limit: 1200, percentage: 85 });
mockSubAndUsage(activeSub, { total: 1020, limit: 1200, percentage: 85 });

await billingStatus({ human: true });

Expand All @@ -967,7 +974,7 @@ describe('billing commands — npx prefix roll-out (cliCommandPrefix)', () => {
});

it('billingStatus 100% over-limit prints "npx hookmyapp billing upgrade"', async () => {
mockSubAndUsage(activeSub, { totalMessages: 1260, limit: 1200, percentage: 105 });
mockSubAndUsage(activeSub, { total: 1260, limit: 1200, percentage: 105 });

await billingStatus({ human: true });

Expand Down
13 changes: 11 additions & 2 deletions src/commands/billing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,14 @@ export async function billingStatus(opts: { json?: boolean; human?: boolean } =
const [sub, usage] = (await Promise.all([
apiClient(`/organizations/${orgPublicId}/billing/subscription`),
apiClient('/webhook/usage', { workspaceId }),
])) as [BillingSubscription, { totalMessages: number; limit: number; percentage: number }];
// AIT-436: `/webhook/usage` reports ONE number, in `usageUnit`. The
// totalMessages/totalForwards aliases and the inbound/outbound split are
// gone -- they were three names for the same figure, two of them saying
// "messages" over an action count.
])) as [
BillingSubscription,
{ total: number; limit: number; percentage: number; usageUnit: 'messages' | 'actions' },
];

// Accept either `json: true` or `human: false` (back-compat with callers
// and tests that predate the phase-108 opts shape).
Expand Down Expand Up @@ -306,7 +313,9 @@ export async function billingStatus(opts: { json?: boolean; human?: boolean } =
const status = sub.status;
const interval = sub.billingInterval ?? 'n/a';
const renews = sub.currentPeriodEnd ?? 'n/a';
const messages = `${usage.totalMessages} / ${usage.limit} (${usage.percentage}%)`;
// This renderer is only reached for message-metered orgs (the actions
// branch returned above), so the label is literally true here.
const messages = `${usage.total} / ${usage.limit} (${usage.percentage}%)`;

output({ plan, status, interval, renews, messages }, { json: false, kind: 'read' });

Expand Down
Loading