Skip to content

New GResellerSubscriptionObj

Spencer Varney edited this page Dec 14, 2016 · 3 revisions

New-GResellerSubscriptionObj

SYNOPSIS

Creates a new Reseller API Subscription object.

SYNTAX

New-GResellerSubscriptionObj [[-BillingMethod] <String>] [[-CreationTime] <Int64>] [[-CustomerDomain] <String>]
 [[-CustomerId] <String>] [[-DealCode] <String>] [[-Plan] <PlanData>] [[-PurchaseOrderId] <String>]
 [[-RenewalSettings] <RenewalSettings>] [[-ResourceUiUrl] <String>] [[-Seats] <Seats>] [[-SkuId] <String>]
 [[-Status] <String>] [[-SubscriptionId] <String>] [[-SuspensionReasons] <String[]>]
 [[-TransferInfo] <TransferInfoData>] [[-TrialSettings] <TrialSettingsData>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a Subscription object which may be required as a parameter for some other Cmdlets in the Reseller API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.Reseller.v1.Data.Subscription

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> New-GResellerSubscriptionObj

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.

PARAMETERS

-BillingMethod

Billing method of this subscription.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CreationTime

Creation time of this subscription in milliseconds since Unix epoch.

Type: Int64
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CustomerDomain

Primary domain name of the customer

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CustomerId

The id of the customer to whom the subscription belongs.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DealCode

External 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: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Plan

Plan details of the subscription

Type: PlanData
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PurchaseOrderId

Purchase order id for your order tracking purposes.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RenewalSettings

Renewal settings of the subscription.

Type: RenewalSettings
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceUiUrl

Ui url for subscription resource.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 8
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Seats

Number/Limit of seats in the new plan.

Type: Seats
Parameter Sets: (All)
Aliases: 

Required: False
Position: 9
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SkuId

Name of the sku for which this subscription is purchased.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 10
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Status

Status of the subscription.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 11
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SubscriptionId

The id of the subscription.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 12
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SuspensionReasons

Read-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 Google Apps Resold Terms of Services.- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.- RESELLER_INITIATED - A manual suspension invoked by a Reseller.- TRIAL_ENDED - The customer's trial expired without a plan selected.- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 13
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TransferInfo

Transfer related information for the subscription.

Type: TransferInfoData
Parameter Sets: (All)
Aliases: 

Required: False
Position: 14
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TrialSettings

Trial Settings of the subscription.

Type: TrialSettingsData
Parameter Sets: (All)
Aliases: 

Required: False
Position: 15
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.String

Billing method of this subscription.

System.Int64

Creation time of this subscription in milliseconds since Unix epoch.

System.String

Primary domain name of the customer

System.String

The id of the customer to whom the subscription belongs.

System.String

External name of the deal, if this subscription was provisioned under one. Otherwise this field will be empty.

Google.Apis.Reseller.v1.Data.Subscription+PlanData

Plan details of the subscription

System.String

Purchase order id for your order tracking purposes.

Google.Apis.Reseller.v1.Data.RenewalSettings

Renewal settings of the subscription.

System.String

Ui url for subscription resource.

Google.Apis.Reseller.v1.Data.Seats

Number/Limit of seats in the new plan.

System.String

Name of the sku for which this subscription is purchased.

System.String

Status of the subscription.

System.String

The id of the subscription.

System.String[]

Read-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 Google Apps Resold Terms of Services.- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term.- RESELLER_INITIATED - A manual suspension invoked by a Reseller.- TRIAL_ENDED - The customer's trial expired without a plan selected.- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).

Google.Apis.Reseller.v1.Data.Subscription+TransferInfoData

Transfer related information for the subscription.

Google.Apis.Reseller.v1.Data.Subscription+TrialSettingsData

Trial Settings of the subscription.

OUTPUTS

Google.Apis.Reseller.v1.Data.Subscription

NOTES

Part of the gShell Project, relating to the Google Reseller API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally