feat: add requireInGoodStanding meta property (#44)

Co-authored-by: Jared Lunde <98760247+jared-paperspace@users.noreply.github.com>

Author: ps-kwang

api/billing.ts

@@ -0,0 +1,5 @@
+import { client } from "./client.ts";
+
+export const billingAccountStanding = {
+  get: client("/billing/account-standing").get,
+};

commands/autoscaling-group/create/mod.ts

@@ -56,6 +56,7 @@ export const create = command("create", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ flags }) {

commands/autoscaling-group/update/mod.ts

@@ -63,6 +63,7 @@ export const update = command("update", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ args, flags }) {

commands/deployment/up/mod.ts

@@ -41,6 +41,7 @@ export const up = command("up", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(async function* ({ flags, ctx }) {
   for await (const line of runUp({ flags, ctx })) {

commands/machine/create/mod.ts

@@ -96,6 +96,7 @@ export const create = command("create", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ flags }) {

commands/machine/start/mod.ts

@@ -30,6 +30,7 @@ export const start = command("start", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ args, flags }) {

commands/machine/update/mod.ts

@@ -79,6 +79,7 @@ export const update = command("update", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ args, flags }) {

commands/mod.ts

@@ -28,6 +28,8 @@ import { snapshot } from "./snapshot/mod.ts";
 import { template } from "./template/mod.ts";
 import { startupScript } from "./startup-script/mod.ts";
 import { autoscalingGroup } from "./autoscaling-group/mod.ts";
+import { billingAccountStanding } from "../api/billing.ts";
+import { asserts } from "../lib/asserts.ts";
 
 /**
  * This variable is automatically generated by `zcli add`. Do not remove this
@@ -107,9 +109,13 @@ export const root = app
       }
     }
 
+    // requireInGoodStanding implies requireApiKey.
+    const requireApiKey = ctx.cmd.meta.requireApiKey ||
+      ctx.cmd.meta.requireInGoodStanding;
+
     // Check to see if this command requires an API key. If it does, we'll
     // check to see if one is set. If not, we'll throw an error.
-    if (ctx.cmd.meta.requireApiKey && !env.get("PAPERSPACE_API_KEY")) {
+    if (requireApiKey && !env.get("PAPERSPACE_API_KEY")) {
       const availableTeams = Object.keys(await credentials.get("keys"));
       const hasTeams = availableTeams.length > 0;
       const loginHelper = !hasTeams
@@ -130,6 +136,26 @@ export const root = app
 
       throw new AppError({ message: `${selectMessage}\n${loginHelper}` });
     }
+
+    if (ctx.cmd.meta.requireInGoodStanding) {
+      const accountStanding = await billingAccountStanding.get(null);
+      asserts(accountStanding.ok, accountStanding);
+
+      if (!accountStanding.data.isInGoodStanding) {
+        const team = await appConfig.get("team");
+
+        asserts(team, "Log in to continue.");
+
+        const billingUrl = new URL(
+          `/${team}/settings/billing`,
+          env.get("PAPERSPACE_CONSOLE_URL"),
+        );
+
+        throw new AppError({
+          message: `Add a credit card to continue\n\n${billingUrl}`,
+        });
+      }
+    }
   })
   // This function runs after every command.
   .persistentPostRun(async function* ({ flags, ctx }) {

commands/private-network/create/mod.ts

@@ -34,6 +34,7 @@ export const create = command("create", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ flags }) {

commands/public-ip/claim/mod.ts

@@ -32,6 +32,7 @@ export const claim = command("claim", {
   // set. If not, we'll throw an error.
   meta: {
     requireApiKey: true,
+    requireInGoodStanding: true,
   },
 }).run(
   async function* ({ flags }) {