-
Notifications
You must be signed in to change notification settings - Fork 10
New GResellerSubscription
Creates/Transfers a subscription for the customer.
New-GResellerSubscription [-TargetCustomerId] <String> [[-SubscriptionBody] <Subscription>]
[-BillingMethod] <String> [-CreationTime] <Int64> [-CustomerDomain] <String> [-CustomerId] <String>
[[-DealCode] <String>] [-PlanCommitmentIntervalEndTime] <Int64> [-PlanCommitmentIntervalStartTime] <Int64>
[-IsCommitmentPlan] <Boolean> [-PlanName] <String> [[-PurchaseOrderId] <String>] [-RenewalType] <String>
[-ResourceUiUrl] <String> [-NumberOfSeats] <Int32> [-MaximumNumberOfSeats] <Int32>
[-LicensedNumberOfSeats] <Int32> [-SkuId] <String> [[-Status] <StatusEnum>] [-SubscriptionId] <String>
[-MinimumTransferableSeats] <Int32> [-TransferabilityExpirationTime] <Int64> [-IsInTrial] <Boolean>
[-TrialEndTime] <Int64> [[-CustomerAuthToken] <String>] [-StandardQueryParams <StandardQueryParameters>]
[-GAuthId <String>] [-WhatIf] [-Confirm]
Creates/Transfers a subscription for the customer.
PS C:\> New-GResellerSubscription -CustomerId $SomeCustomerIdString -SubscriptionBody $SomeSubscriptionObj
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
Id of the Customer
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseJSON template for a subscription.
Type: Subscription
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseBilling method of this subscription.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseCreation time of this subscription in milliseconds since Unix epoch.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePrimary domain name of the customer
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe id of the customer to whom the subscription belongs.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseExternal name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseEnd time of the commitment interval in milliseconds since Unix epoch.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseStart time of the commitment interval in milliseconds since Unix epoch.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether the plan is a commitment plan or not.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe plan name of this subscription's plan.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePurchase order id for your order tracking purposes.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSubscription renewal type.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseUi url for subscription resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseNumber of seats to purchase. This is applicable only for a commitment plan.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 13
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 14
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseRead-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 15
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseName of the sku for which this subscription is purchased.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 16
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseStatus of the subscription.
Possible values: ACTIVE, BILLING_ACTIVATION_PENDING, CANCELLED, PENDING
Type: StatusEnum
Parameter Sets: (All)
Aliases:
Accepted values: ACTIVE, BILLING_ACTIVATION_PENDING, CANCELLED, PENDING
Required: False
Position: 17
Default value: ACTIVE
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe id of the subscription.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 18
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMinimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 19
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseTime when transfer token or intent to transfer will expire.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 20
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether the subscription is in trial.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: 21
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseEnd time of the trial in milliseconds since Unix epoch.
Type: Int64
Parameter Sets: (All)
Aliases:
Required: True
Position: 22
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseAn auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe GAuthId representing the gShell auth credentials this cmdlet should use to run.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseId of the Customer
JSON template for a subscription.
Billing method of this subscription.
Creation time of this subscription in milliseconds since Unix epoch.
Primary domain name of the customer
The id of the customer to whom the subscription belongs.
External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.
End time of the commitment interval in milliseconds since Unix epoch.
Start time of the commitment interval in milliseconds since Unix epoch.
Whether the plan is a commitment plan or not.
The plan name of this subscription's plan.
Purchase order id for your order tracking purposes.
Subscription renewal type.
Ui url for subscription resource.
Number of seats to purchase. This is applicable only for a commitment plan.
Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.
Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.
Name of the sku for which this subscription is purchased.
Status of the subscription.
The id of the subscription.
Minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
Time when transfer token or intent to transfer will expire.
Whether the subscription is in trial.
End time of the trial in milliseconds since Unix epoch.
An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.
Part of the gShell Project, relating to the Google Reseller API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads