Skip to content

Get GResellerSubscription

Spencer Varney edited this page Dec 27, 2016 · 4 revisions

Get-GResellerSubscription

SYNOPSIS

Gets a subscription of the customer.

SYNTAX

one (Default)

Get-GResellerSubscription [-CustomerId] <String> [-SubscriptionId] <String>
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

all

Get-GResellerSubscription [[-CustomerAuthToken] <String>] [[-CustomerId] <String>]
 [[-CustomerNamePrefix] <String>] [[-MaxResults] <Int32>] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Gets a subscription of the customer.

EXAMPLES

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

PS C:\> Get-GResellerSubscription -CustomerId $SomeCustomerIdString -SubscriptionId $SomeSubscriptionIdString

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.

---------- EXAMPLE 2 ----------

PS C:\> Get-GResellerSubscription -CustomerAuthToken $SomeCustomerAuthTokenString

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

-CustomerAuthToken

An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.

Type: String
Parameter Sets: all
Aliases: 

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

-CustomerId

Id of the Customer

Type: String
Parameter Sets: one
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: String
Parameter Sets: all
Aliases: 

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

-SubscriptionId

Id of the subscription, which is unique for a customer

Type: String
Parameter Sets: one
Aliases: 

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

-CustomerNamePrefix

Prefix of the customer's domain name by which the subscriptions should be filtered. Optional

Type: String
Parameter Sets: all
Aliases: 

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

-MaxResults

Maximum number of results to return

Type: Int32
Parameter Sets: all
Aliases: 

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

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The 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: False

INPUTS

System.String

An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional.

System.String

Id of the Customer

System.String

Id of the subscription, which is unique for a customer

System.String

Prefix of the customer's domain name by which the subscriptions should be filtered. Optional

System.Int32

Maximum number of results to return

OUTPUTS

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