-
Notifications
You must be signed in to change notification settings - Fork 10
Set GResellerSubscriptionPlan
Changes the plan of a subscription
Set-GResellerSubscriptionPlan [-CustomerId] <String> [-SubscriptionId] <String> [-PlanName] <PlanNameEnum>
[-NumberOfSeats] <Int32> [-MaximumNumberOfSeats] <Int32> [[-PurchaseOrderId] <String>]
[-LicensedNumberOfSeats] <Int32> [[-DealCode] <String>] [-StandardQueryParams <StandardQueryParameters>]
[-GAuthId <String>] [-WhatIf] [-Confirm]
Changes the plan of a subscription
PS C:\> Set-GResellerSubscriptionPlan -CustomerId $SomeCustomerIdString -SubscriptionId $SomeSubscriptionIdString -PlanName $SomePlanName -NumberOfSeats $SomeNumberOfSeatsInt -MaximumNumberOfSeats $SomeMaximumNumberOfSeatsInt -LicensedNumberOfSeats $SomeLicensedNumberOfSeatsInt
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: FalseId of the subscription, which is unique for a customer
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseName of the plan to change to.
Possible values: ANNUAL_MONTHLY_PAY, ANNUAL_YEARLY_PAY, FLEXIBLE, TRIAL
Type: PlanNameEnum
Parameter Sets: (All)
Aliases:
Accepted values: ANNUAL_MONTHLY_PAY, ANNUAL_YEARLY_PAY, FLEXIBLE, TRIAL
Required: True
Position: 2
Default value: ANNUAL_MONTHLY_PAY
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: 3
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: 4
Default value: 0
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: 5
Default value:
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: 6
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseExternal name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
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
Id of the subscription, which is unique for a customer
Name of the plan to change to.
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.
Purchase order id for your order tracking purposes.
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.
External name of the deal code applicable for the subscription. This field is optional. If missing, the deal price plan won't be used.
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