feat(scloud): f49d30abe104d413ceef015232c159861f2912f3

Author: serverpod_cloud

ground_control_client/lib/src/protocol/client.dart

@@ -106,6 +106,24 @@ class EndpointAdminProcurement extends _i1.EndpointRef {
     {'userEmail': userEmail},
   );
 
+  /// Cancels the primary plan subscription of the user
+  /// at the end of its current term.
+  ///
+  /// If [terminateImmediately] is true, the subscription is terminated
+  /// immediately. If the user still has any active resource products,
+  /// a [ProcurementCancellationException] will be thrown.
+  ///
+  /// Throws a [NoSubscriptionException] if the user has no subscription.
+  /// Throws a [ProcurementCancellationException] if the subscription has
+  /// already been cancelled or ended.
+  _i2.Future<void> cancelPlan({
+    required String userEmail,
+    bool? terminateImmediately,
+  }) => caller.callServerEndpoint<void>('adminProcurement', 'cancelPlan', {
+    'userEmail': userEmail,
+    'terminateImmediately': terminateImmediately,
+  });
+
   @Deprecated(
     'This endpoint to migrate to hackathon plan is no longer supported.',
   )
@@ -665,7 +683,7 @@ class EndpointPlans extends _i1.EndpointRef {
   /// Cancels the primary plan subscription of the user.
   ///
   /// - Throws [ProcurementCancellationException] if the cancellation fails,
-  /// e.g. if the subscription still has active resources.
+  /// e.g. if the subscription still has active resources or is already cancelled.
   /// - Throws [NoSubscriptionException] if the user has no subscription.
   _i2.Future<void> cancelPlan() =>
       caller.callServerEndpoint<void>('plans', 'cancelPlan', {});

serverpod_cloud_cli/lib/command_runner/commands/admin/admin_product_commands.dart

@@ -14,6 +14,7 @@ class AdminProductCommand extends CloudCliCommand {
   AdminProductCommand({required super.logger}) {
     addSubcommand(AdminListProcuredCommand(logger: logger));
     addSubcommand(AdminProcurePlanCommand(logger: logger));
+    addSubcommand(AdminCancelPlanCommand(logger: logger));
   }
 }
 
@@ -136,3 +137,48 @@ class AdminProcurePlanCommand extends CloudCliCommand<AdminProcurePlanOption> {
     );
   }
 }
+
+enum AdminCancelPlanOption<V> implements OptionDefinition<V> {
+  user(UserEmailOption(argPos: 0, mandatory: true)),
+  terminateImmediately(
+    FlagOption(
+      argName: 'immediately',
+      helpText: 'Terminate the subscription immediately.',
+      negatable: false,
+      defaultsTo: false,
+    ),
+  );
+
+  const AdminCancelPlanOption(this.option);
+
+  @override
+  final ConfigOptionBase<V> option;
+}
+
+class AdminCancelPlanCommand extends CloudCliCommand<AdminCancelPlanOption> {
+  @override
+  final name = 'cancel-plan';
+
+  @override
+  final description = "Cancels a user's subscription.\n";
+
+  AdminCancelPlanCommand({required super.logger})
+    : super(options: AdminCancelPlanOption.values);
+
+  @override
+  Future<void> runWithConfig(
+    final Configuration<AdminCancelPlanOption> commandConfig,
+  ) async {
+    final userEmail = commandConfig.value(AdminCancelPlanOption.user);
+    final terminateImmediately = commandConfig.value(
+      AdminCancelPlanOption.terminateImmediately,
+    );
+
+    await ProductAdminCommands.cancelPlan(
+      runner.serviceProvider.cloudApiClient,
+      logger: logger,
+      userEmail: userEmail,
+      terminateImmediately: terminateImmediately,
+    );
+  }
+}

serverpod_cloud_cli/lib/command_runner/completion/completion_script_carapace.dart

@@ -114,6 +114,7 @@ commands:
       -c, --concurrency=: "Number of concurrent files processed when zipping the project."
       --dry-run: "Do not actually deploy, just print the deployment steps."
       --show-files: "Display the file tree that will be uploaded."
+      -o, --output=: "Save the deployment zip file to the specified path. Must end with .zip"
 
   - name: variable
 

serverpod_cloud_cli/lib/command_runner/completion/completion_script_completely.dart

@@ -869,7 +869,7 @@ _scloud_completions() {
       ;;
 
     'deploy'*)
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project -p --concurrency -c --dry-run --show-files")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_scloud_completions_filter "--quiet -q --verbose -v --analytics --no-analytics -a --version --token --project-dir -d --project-config-file --timeout --yes --project -p --concurrency -c --dry-run --show-files --output -o")" -- "$cur")
       ;;
 
     'secret'*)

serverpod_cloud_cli/lib/commands/admin/product_admin.dart

@@ -40,4 +40,18 @@ abstract class ProductAdminCommands {
       newParagraph: true,
     );
   }
+
+  static Future<void> cancelPlan(
+    final Client cloudApiClient, {
+    required final CommandLogger logger,
+    required final String userEmail,
+    final bool? terminateImmediately,
+  }) async {
+    await cloudApiClient.adminProcurement.cancelPlan(
+      userEmail: userEmail,
+      terminateImmediately: terminateImmediately,
+    );
+
+    logger.success("The user's plan has been cancelled.", newParagraph: true);
+  }
 }