G

Gws Reseller Streamlined

Comprehensive command designed for google, workspace, reseller, manage. Includes structured workflows, validation checks, and reusable patterns for google workspace.

CommandClipticsgoogle workspacev1.0.0MIT
0 views0 copies

GWS Reseller Streamlined

Streamlined command for Google Workspace Reseller API operations covering customer management, subscription lifecycle, seat changes, and billing plan updates through the GWS CLI.

When to Use This Command

Run this command when you need to manage Google Workspace customer accounts, subscriptions, or reseller operations through the CLI.

  • You need to create, update, or retrieve customer accounts in your reseller portal
  • You want to manage subscription plans including activation, suspension, and seat changes
  • You are automating reseller notification registration for webhook-based monitoring
  • You need to transition trial subscriptions to paid plans or change renewal settings

Use it also when:

  • You want to list all subscriptions with filtering by customer name prefix
  • You need to transfer or cancel subscriptions with proper confirmation

Quick Start

# .claude/commands/gws-reseller-streamlined.md name: gws-reseller-streamlined description: Streamlined Google Workspace Reseller operations arguments: operation: The reseller resource, method, and flags
# List all subscriptions for a customer claude gws-reseller-streamlined "subscriptions list --params '{\"customerId\": \"C03abc123\"}'"
Expected output:
{
  "subscriptions": [
    {
      "subscriptionId": "sub_123",
      "skuId": "Google-Apps-For-Business",
      "plan": { "planName": "ANNUAL_MONTHLY_PAY" },
      "seats": { "numberOfSeats": 50, "licensedNumberOfSeats": 50 }
    }
  ]
}

Core Concepts

ConceptDescription
CustomerAn organization account managed through your reseller relationship
SubscriptionA product license tied to a customer (e.g., Workspace Business)
PlanBilling arrangement: ANNUAL_MONTHLY_PAY, ANNUAL_YEARLY_PAY, or FLEXIBLE
SeatsNumber of user licenses within a subscription
Reseller NotifyWebhook registration for customer lifecycle events
Reseller Hierarchy:
  Reseller Account
       │
       ā”œā”€ā”€ Customer A ──> Subscription 1 (50 seats, Annual)
       │                  Subscription 2 (10 seats, Flexible)
       │
       └── Customer B ──> Subscription 1 (100 seats, Annual)

Configuration

ParameterDefaultDescription
customerIdrequiredThe customer account identifier (C0xxxxxxx)
subscriptionIdvariesSubscription ID for subscription-level operations
formatjsonOutput format: json, table, yaml, csv
page-allfalseAuto-paginate through all subscription results
dry-runfalseValidate without executing the operation

Best Practices

  1. Confirm before suspend or delete operations -- Subscription suspension and deletion are significant actions that affect the customer. Always verify the target subscription ID and use --dry-run first.

  2. Inspect schema before changePlan -- Plan changes have strict rules about valid transitions. Run gws schema reseller.subscriptions.changePlan to understand constraints.

  3. Use patch over update for partial changes -- The patch method only modifies specified fields while update replaces the entire resource. Prefer patch for targeted customer updates.

  4. Monitor seat utilization before changes -- Check current licensedNumberOfSeats versus numberOfSeats before adjusting seat counts to avoid disrupting active users.

  5. Register for reseller notifications -- Use resellernotify register to receive webhook events about customer changes, reducing the need for polling.

Common Issues

  1. Cannot reactivate externally suspended subscription -- The activate method only works for reseller-suspended subscriptions. Subscriptions suspended for abuse or ToS violations require Google support.

  2. Customer type cannot be changed via API -- The Reseller API does not support changing customerType. A "team" customer must verify their domain through the Google Admin console to become a "domain" customer.

  3. Plan change restrictions -- Not all plan transitions are valid. For example, you cannot downgrade an annual plan mid-term. Review the plan change matrix in the Reseller API documentation.

Community

Reviews

Write a review

No reviews yet. Be the first to review this template!

Similar Templates