Pax8API

0.4

Public/Get-Pax8Subscriptions.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 function Get-Pax8Subscriptions {
  [CmdletBinding()]
  Param(
    [ValidateSet("quantity", "startDate", "endDate", "createdDate", "billingStart", "price")]    
    [string]$sort,
    [ValidateSet("Active", "Cancelled", "PendingManual", "PendingAutomated", "PendingCancel", "WaitingForDetails", "Trial", "Converted", "PendingActivation", "Activated")]  
    [string]$status,
    [ValidateSet("Monthly", "Annual", "2-Year", "3-Year", "One-Time", "Trial", "Activation")]    
    [string]$billingTerm,
    [string]$companyId,
    [string]$productId,
    [string]$subscriptionId
  )

  if ($subscriptionId) {
    $Subscriptions = Invoke-Pax8Request -method get -resource "subscriptions/$subscriptionId"
  } else {

    $resourcefilter = ''

    if ($sort) {
      $resourcefilter = "$($resourcefilter)&sort=$($sort)"
    }

    if ($status) {
      $resourcefilter = "$($resourcefilter)&status=$($status)"
    }

    if ($billingTerm) {
      $resourcefilter = "$($resourcefilter)&billingTerm=$($billingTerm)"
    }

    if ($companyId) {
      $resourcefilter = "$($resourcefilter)&companyId=$($companyId)"
    }

    if ($productId) {
      $resourcefilter = "$($resourcefilter)&productId=$($productId)"
    }

    $Subscriptions = Invoke-Pax8Request -method get -resource "subscriptions" -ResourceFilter $resourcefilter
  
  }
  return $Subscriptions

}