Get-BT_Subscription

Syntax

Get-BT_Subscription -Ticket <Ticket> [-Environment <string>] [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-SystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-SubscriptionStartDate <string[]>] [-SortBy_SubscriptionStartDate_Ascending] [-SortBy_SubscriptionStartDate_Descending] [-SubscriptionEndDate <string[]>] [-SortBy_SubscriptionEndDate_Ascending] [-SortBy_SubscriptionEndDate_Descending] [-BillingStartDate <string[]>] [-SortBy_BillingStartDate_Ascending] [-SortBy_BillingStartDate_Descending] [-BillingEndDate <string[]>] [-SortBy_BillingEndDate_Ascending] [-SortBy_BillingEndDate_Descending] [-ProductSkuId <Object[]>] [-AgreementMonths <Object[]>] [-SortBy_AgreementMonths_Ascending] [-SortBy_AgreementMonths_Descending] [-SubscriptionProrationType <string[]>] [-BillingFrequencyMonths <Object[]>] [-SortBy_BillingFrequencyMonths_Ascending] [-SortBy_BillingFrequencyMonths_Descending] [-SubscriptionProcessState <string[]>] [-ErrorCode <string[]>] [-SubscriptionRenewalPolicy <string[]>] [-ReferenceEntityId <Object[]>] [-EntityReferenceId <Object[]>] [-ReferenceEntityType <string[]>] [-SubscriptionEntityReferenceType <string[]>] [<CommonParameters>]

Get-BT_Subscription -Ticket <Ticket> -EndpointUrl <string> [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-SystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-SubscriptionStartDate <string[]>] [-SortBy_SubscriptionStartDate_Ascending] [-SortBy_SubscriptionStartDate_Descending] [-SubscriptionEndDate <string[]>] [-SortBy_SubscriptionEndDate_Ascending] [-SortBy_SubscriptionEndDate_Descending] [-BillingStartDate <string[]>] [-SortBy_BillingStartDate_Ascending] [-SortBy_BillingStartDate_Descending] [-BillingEndDate <string[]>] [-SortBy_BillingEndDate_Ascending] [-SortBy_BillingEndDate_Descending] [-ProductSkuId <Object[]>] [-AgreementMonths <Object[]>] [-SortBy_AgreementMonths_Ascending] [-SortBy_AgreementMonths_Descending] [-SubscriptionProrationType <string[]>] [-BillingFrequencyMonths <Object[]>] [-SortBy_BillingFrequencyMonths_Ascending] [-SortBy_BillingFrequencyMonths_Descending] [-SubscriptionProcessState <string[]>] [-ErrorCode <string[]>] [-SubscriptionRenewalPolicy <string[]>] [-ReferenceEntityId <Object[]>] [-EntityReferenceId <Object[]>] [-ReferenceEntityType <string[]>] [-SubscriptionEntityReferenceType <string[]>] [<CommonParameters>]

Detailed Description

Get-BT_Subscription gets a(an) BT_Subscription. Subscription entity class for storing a single subscription. Used for reoccurring billing. A subscription represents a user subscription that is required to run MSPComplete services for this user.

Parameters

Total Parameters: 58

EndpointUrl

Paremeter specs:

Ticket

Paremeter specs:

AgreementMonths

Paremeter specs:

BillingEndDate

Paremeter specs:

BillingFrequencyMonths

Paremeter specs:

BillingStartDate

Paremeter specs:

Created

Paremeter specs:

Environment

Available values are listed below.

Paremeter specs:

ErrorCode

Paremeter specs:

Id

Paremeter specs:

IsDeleted

Paremeter specs:

PageOffset

Paremeter specs:

PageSize

Paremeter specs:

ProductSkuId

Paremeter specs:

ReferenceEntityId

Paremeter specs:

ReferenceEntityType

Paremeter specs:

RetrieveAll

Paremeter specs:

ShouldUnmaskProperties

Paremeter specs:

SortBy_AgreementMonths_Ascending

Paremeter specs:

SortBy_AgreementMonths_Descending

Paremeter specs:

SortBy_BillingEndDate_Ascending

Paremeter specs:

SortBy_BillingEndDate_Descending

Paremeter specs:

SortBy_BillingFrequencyMonths_Ascending

Paremeter specs:

SortBy_BillingFrequencyMonths_Descending

Paremeter specs:

SortBy_BillingStartDate_Ascending

Paremeter specs:

SortBy_BillingStartDate_Descending

Paremeter specs:

SortBy_Created_Ascending

Paremeter specs:

SortBy_Created_Descending

Paremeter specs:

SortBy_SubscriptionEndDate_Ascending

Paremeter specs:

SortBy_SubscriptionEndDate_Descending

Paremeter specs:

SortBy_SubscriptionStartDate_Ascending

Paremeter specs:

SortBy_SubscriptionStartDate_Descending

Paremeter specs:

SortBy_Updated_Ascending

Paremeter specs:

SortBy_Updated_Descending

Paremeter specs:

SortBy_Version_Ascending

Paremeter specs:

SortBy_Version_Descending

Paremeter specs:

SubscriptionEndDate

Paremeter specs:

SubscriptionProcessState

Paremeter specs:

SubscriptionProrationType

Paremeter specs:

SubscriptionRenewalPolicy

Paremeter specs:

SubscriptionStartDate

Paremeter specs:

SystemUserId

Paremeter specs:

Updated

Paremeter specs:

Version

Paremeter specs:

WorkgroupOrganizationId

Paremeter specs:

Outputs

System.Object

Notes

Workgroup scope

Subscriptions belong to workgroups, thus a ticket scoped to a workgroup will only return the subscriptions belonging to this workgroup.

Subscription process state

The subscription process state can be non-processed, successfully processed, failed to processed or revoked. It is automatically updated and can take a few dozens of seconds to be updated.

Examples

-------------------------- Example 1 -------------------------

$subscriptions = Get-BT_Subscription -Ticket $btTicket