Skip to main content

@swamp/gcp/reseller

v2026.04.23.1

Google Cloud reseller infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudresellercloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/reseller

@swamp/gcp/reseller/customersv2026.04.23.1customers.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
alternateEmail?stringLike the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer\
customerDomain?stringThe customer's primary domain name string. `customerDomain` is required when creating a new customer. Do not include the `www` prefix in the domain when adding a customer.
customerDomainVerified?booleanWhether the customer's primary domain has been verified.
customerId?stringThis property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
customerType?enumIdentifies the type of the customer. Acceptable values include: * `domain`: Implies a domain-verified customer (default). * `team`: Implies an email-verified customer. For more information, see [managed teams](https://support.google.com/a/users/answer/9939479).
phoneNumber?stringCustomer contact phone number. Must start with "+" followed by the country code. The rest of the number can be contiguous numbers or respect the phone local format conventions, but it must be a real phone number and not, for example, "123". This field is silently ignored if invalid.
postalAddress?objectJSON template for address of a customer.
primaryAdmin?objectJSON template for primary admin in case of TEAM customers
resourceUiUrl?stringURL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.
customerAuthToken?stringThe `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
createCreate a customers
getGet a customers
ArgumentTypeDescription
identifierstringThe name of the customers
updateUpdate customers attributes
syncSync customers state from GCP

Resources

state(infinite)— When a Google customer's account is registered with a reseller, the customer'...
@swamp/gcp/reseller/subscriptionsv2026.04.23.1subscriptions.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
billingMethod?stringRead-only field that returns the current billing method for a subscription.
creationTime?stringThe `creationTime` property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
customerDomain?stringPrimary domain name of the customer
customerId?stringThis property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.
dealCode?stringGoogle-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in `insert` requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.
plan?objectThe `plan` property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts.
purchaseOrderId?stringThis is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a `purchaseOrderId` value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.
renewalSettings?objectJSON template for a subscription renewal settings.
resourceUiUrl?stringURL to customer's Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.
seats?objectJSON template for subscription seats.
skuId?stringA required property. The `skuId` is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.
skuName?stringRead-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
status?stringThis is an optional property.
subscriptionId?stringThe `subscriptionId` is the subscription identifier and is unique for each customer. This is a required property. Since a `subscriptionId` changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the `subscriptionId` as described in retrieve all reseller subscriptions.
suspensionReasons?arrayRead-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's `STATUS` is `SUSPENDED` until all pending suspensions are removed. Possible options include: - `PENDING_TOS_ACCEPTANCE` - The customer has not logged in and accepted the G Suite Resold Terms of Services. - `RENEWAL_WITH_TYPE_CANCEL` - The customer's commitment ended and their service was canc
transferInfo?objectRead-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
trialSettings?objectThe G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.
action?stringThe intented insert action. Advised to set this when the customer already has a subscription for a different SKU in the same product.
customerAuthToken?stringThe `customerAuthToken` query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.
sourceSkuId?stringThe sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH.
createCreate a subscriptions
getGet a subscriptions
ArgumentTypeDescription
identifierstringThe name of the subscriptions
deleteDelete the subscriptions
ArgumentTypeDescription
identifierstringThe name of the subscriptions
syncSync subscriptions state from GCP
activateactivate
change_planchange plan
ArgumentTypeDescription
dealCode?any
kind?any
planName?any
purchaseOrderId?any
seats?any
change_renewal_settingschange renewal settings
ArgumentTypeDescription
kind?any
renewalType?any
change_seatschange seats
ArgumentTypeDescription
kind?any
licensedNumberOfSeats?any
maximumNumberOfSeats?any
numberOfSeats?any
start_paid_servicestart paid service
suspendsuspend

Resources

state(infinite)— JSON template for a subscription.