GET api/products/ptf-plans

This method will retrieve all system supported subscription plans that can be displayed to end users

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of

Collection of PtfProductBundlePlanModel
NameDescriptionTypeAdditional information
Name

string

None.
Tiers

Collection of PtfProductBundlePlanPriceTier

None.
Id

integer

None.
Description

string

None.
PreviewImageUrl

string

None.
StripePlanId

string

None.
Price

decimal number

None.
AnnualPrice

decimal number

None.
AdditionReportPrice

decimal number

None.
TrialDurationInDays

integer

None.
SetupFee

decimal number

None.
MaxAnalysisCount

integer

None.
MaxReportCount

integer

None.
UnlimitedAnalysisCount

boolean

None.
UnlimitedReportCount

boolean

None.
EmailMarketingSupport

boolean

None.
WhiteLabelingSupport

boolean

None.
AppealGiftingSupport

boolean

None.
AppealDiscountSupport

boolean

None.
AppealReferralFeeSupport

boolean

None.
DashboardAccessSupport

boolean

None.
ClosingReportSupport

boolean

None.
MultiPropertyAnalysisSupport

boolean

None.
WebIntegrationSupport

boolean

None.
ApiAccessSupport

boolean

None.
ProspectingSupport

boolean

None.
PaymentGatewayId

integer

None.
PriceTierTypeId

integer

None.
IsActive

boolean

None.
Scope

string

None.
IncludedItems

string

None.
DisplayOrder

integer

None.
PricePerProperty

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "name": "sample string 1",
    "tiers": [
      {
        "id": 1,
        "productBundlePlanId": 2,
        "startQuantity": 3,
        "endQuantity": 1,
        "unitPrice": 1.0,
        "packageUnitPrice": 1.0,
        "createdDate": "2025-05-20T17:00:51.401234-05:00"
      },
      {
        "id": 1,
        "productBundlePlanId": 2,
        "startQuantity": 3,
        "endQuantity": 1,
        "unitPrice": 1.0,
        "packageUnitPrice": 1.0,
        "createdDate": "2025-05-20T17:00:51.401234-05:00"
      }
    ],
    "id": 2,
    "description": "sample string 3",
    "previewImageUrl": "sample string 4",
    "stripePlanId": "sample string 5",
    "price": 6.0,
    "annualPrice": 7.0,
    "additionReportPrice": 8.0,
    "trialDurationInDays": 9,
    "setupFee": 10.0,
    "maxAnalysisCount": 11,
    "maxReportCount": 12,
    "unlimitedAnalysisCount": true,
    "unlimitedReportCount": true,
    "emailMarketingSupport": true,
    "whiteLabelingSupport": true,
    "appealGiftingSupport": true,
    "appealDiscountSupport": true,
    "appealReferralFeeSupport": true,
    "dashboardAccessSupport": true,
    "closingReportSupport": true,
    "multiPropertyAnalysisSupport": true,
    "webIntegrationSupport": true,
    "apiAccessSupport": true,
    "prospectingSupport": true,
    "paymentGatewayId": 26,
    "priceTierTypeId": 27,
    "isActive": true,
    "scope": "sample string 29",
    "includedItems": "sample string 30",
    "displayOrder": 31,
    "pricePerProperty": 32.0
  },
  {
    "name": "sample string 1",
    "tiers": [
      {
        "id": 1,
        "productBundlePlanId": 2,
        "startQuantity": 3,
        "endQuantity": 1,
        "unitPrice": 1.0,
        "packageUnitPrice": 1.0,
        "createdDate": "2025-05-20T17:00:51.401234-05:00"
      },
      {
        "id": 1,
        "productBundlePlanId": 2,
        "startQuantity": 3,
        "endQuantity": 1,
        "unitPrice": 1.0,
        "packageUnitPrice": 1.0,
        "createdDate": "2025-05-20T17:00:51.401234-05:00"
      }
    ],
    "id": 2,
    "description": "sample string 3",
    "previewImageUrl": "sample string 4",
    "stripePlanId": "sample string 5",
    "price": 6.0,
    "annualPrice": 7.0,
    "additionReportPrice": 8.0,
    "trialDurationInDays": 9,
    "setupFee": 10.0,
    "maxAnalysisCount": 11,
    "maxReportCount": 12,
    "unlimitedAnalysisCount": true,
    "unlimitedReportCount": true,
    "emailMarketingSupport": true,
    "whiteLabelingSupport": true,
    "appealGiftingSupport": true,
    "appealDiscountSupport": true,
    "appealReferralFeeSupport": true,
    "dashboardAccessSupport": true,
    "closingReportSupport": true,
    "multiPropertyAnalysisSupport": true,
    "webIntegrationSupport": true,
    "apiAccessSupport": true,
    "prospectingSupport": true,
    "paymentGatewayId": 26,
    "priceTierTypeId": 27,
    "isActive": true,
    "scope": "sample string 29",
    "includedItems": "sample string 30",
    "displayOrder": 31,
    "pricePerProperty": 32.0
  }
]

text/html

Sample: 
[{"name":"sample string 1","tiers":[{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"packageUnitPrice":1.0,"createdDate":"2025-05-20T17:00:51.401234-05:00"},{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"packageUnitPrice":1.0,"createdDate":"2025-05-20T17:00:51.401234-05:00"}],"id":2,"description":"sample string 3","previewImageUrl":"sample string 4","stripePlanId":"sample string 5","price":6.0,"annualPrice":7.0,"additionReportPrice":8.0,"trialDurationInDays":9,"setupFee":10.0,"maxAnalysisCount":11,"maxReportCount":12,"unlimitedAnalysisCount":true,"unlimitedReportCount":true,"emailMarketingSupport":true,"whiteLabelingSupport":true,"appealGiftingSupport":true,"appealDiscountSupport":true,"appealReferralFeeSupport":true,"dashboardAccessSupport":true,"closingReportSupport":true,"multiPropertyAnalysisSupport":true,"webIntegrationSupport":true,"apiAccessSupport":true,"prospectingSupport":true,"paymentGatewayId":26,"priceTierTypeId":27,"isActive":true,"scope":"sample string 29","includedItems":"sample string 30","displayOrder":31,"pricePerProperty":32.0},{"name":"sample string 1","tiers":[{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"packageUnitPrice":1.0,"createdDate":"2025-05-20T17:00:51.401234-05:00"},{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"packageUnitPrice":1.0,"createdDate":"2025-05-20T17:00:51.401234-05:00"}],"id":2,"description":"sample string 3","previewImageUrl":"sample string 4","stripePlanId":"sample string 5","price":6.0,"annualPrice":7.0,"additionReportPrice":8.0,"trialDurationInDays":9,"setupFee":10.0,"maxAnalysisCount":11,"maxReportCount":12,"unlimitedAnalysisCount":true,"unlimitedReportCount":true,"emailMarketingSupport":true,"whiteLabelingSupport":true,"appealGiftingSupport":true,"appealDiscountSupport":true,"appealReferralFeeSupport":true,"dashboardAccessSupport":true,"closingReportSupport":true,"multiPropertyAnalysisSupport":true,"webIntegrationSupport":true,"apiAccessSupport":true,"prospectingSupport":true,"paymentGatewayId":26,"priceTierTypeId":27,"isActive":true,"scope":"sample string 29","includedItems":"sample string 30","displayOrder":31,"pricePerProperty":32.0}]

application/xml, text/xml

Sample: 
<ArrayOfPtfProductBundlePlanModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <PtfProductBundlePlanModel>
    <AdditionReportPrice>8</AdditionReportPrice>
    <AnnualPrice>7</AnnualPrice>
    <ApiAccessSupport>true</ApiAccessSupport>
    <AppealDiscountSupport>true</AppealDiscountSupport>
    <AppealGiftingSupport>true</AppealGiftingSupport>
    <AppealReferralFeeSupport>true</AppealReferralFeeSupport>
    <ClosingReportSupport>true</ClosingReportSupport>
    <DashboardAccessSupport>true</DashboardAccessSupport>
    <Description>sample string 3</Description>
    <DisplayOrder>31</DisplayOrder>
    <EmailMarketingSupport>true</EmailMarketingSupport>
    <Id>2</Id>
    <IncludedItems>sample string 30</IncludedItems>
    <IsActive>true</IsActive>
    <MaxAnalysisCount>11</MaxAnalysisCount>
    <MaxReportCount>12</MaxReportCount>
    <MultiPropertyAnalysisSupport>true</MultiPropertyAnalysisSupport>
    <Name>sample string 1</Name>
    <PaymentGatewayId>26</PaymentGatewayId>
    <PreviewImageUrl>sample string 4</PreviewImageUrl>
    <Price>6</Price>
    <PricePerProperty>32</PricePerProperty>
    <PriceTierTypeId>27</PriceTierTypeId>
    <ProspectingSupport>true</ProspectingSupport>
    <Scope>sample string 29</Scope>
    <SetupFee>10</SetupFee>
    <StripePlanId>sample string 5</StripePlanId>
    <Tiers xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities">
      <d3p1:PtfProductBundlePlanPriceTier>
        <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
        <d3p1:CreatedDate>2025-05-20T17:00:51.401234-05:00</d3p1:CreatedDate>
        <d3p1:EndQuantity>1</d3p1:EndQuantity>
        <d3p1:PackageUnitPrice>1</d3p1:PackageUnitPrice>
        <d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
        <d3p1:StartQuantity>3</d3p1:StartQuantity>
        <d3p1:UnitPrice>1</d3p1:UnitPrice>
      </d3p1:PtfProductBundlePlanPriceTier>
      <d3p1:PtfProductBundlePlanPriceTier>
        <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
        <d3p1:CreatedDate>2025-05-20T17:00:51.401234-05:00</d3p1:CreatedDate>
        <d3p1:EndQuantity>1</d3p1:EndQuantity>
        <d3p1:PackageUnitPrice>1</d3p1:PackageUnitPrice>
        <d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
        <d3p1:StartQuantity>3</d3p1:StartQuantity>
        <d3p1:UnitPrice>1</d3p1:UnitPrice>
      </d3p1:PtfProductBundlePlanPriceTier>
    </Tiers>
    <TrialDurationInDays>9</TrialDurationInDays>
    <UnlimitedAnalysisCount>true</UnlimitedAnalysisCount>
    <UnlimitedReportCount>true</UnlimitedReportCount>
    <WebIntegrationSupport>true</WebIntegrationSupport>
    <WhiteLabelingSupport>true</WhiteLabelingSupport>
  </PtfProductBundlePlanModel>
  <PtfProductBundlePlanModel>
    <AdditionReportPrice>8</AdditionReportPrice>
    <AnnualPrice>7</AnnualPrice>
    <ApiAccessSupport>true</ApiAccessSupport>
    <AppealDiscountSupport>true</AppealDiscountSupport>
    <AppealGiftingSupport>true</AppealGiftingSupport>
    <AppealReferralFeeSupport>true</AppealReferralFeeSupport>
    <ClosingReportSupport>true</ClosingReportSupport>
    <DashboardAccessSupport>true</DashboardAccessSupport>
    <Description>sample string 3</Description>
    <DisplayOrder>31</DisplayOrder>
    <EmailMarketingSupport>true</EmailMarketingSupport>
    <Id>2</Id>
    <IncludedItems>sample string 30</IncludedItems>
    <IsActive>true</IsActive>
    <MaxAnalysisCount>11</MaxAnalysisCount>
    <MaxReportCount>12</MaxReportCount>
    <MultiPropertyAnalysisSupport>true</MultiPropertyAnalysisSupport>
    <Name>sample string 1</Name>
    <PaymentGatewayId>26</PaymentGatewayId>
    <PreviewImageUrl>sample string 4</PreviewImageUrl>
    <Price>6</Price>
    <PricePerProperty>32</PricePerProperty>
    <PriceTierTypeId>27</PriceTierTypeId>
    <ProspectingSupport>true</ProspectingSupport>
    <Scope>sample string 29</Scope>
    <SetupFee>10</SetupFee>
    <StripePlanId>sample string 5</StripePlanId>
    <Tiers xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities">
      <d3p1:PtfProductBundlePlanPriceTier>
        <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
        <d3p1:CreatedDate>2025-05-20T17:00:51.401234-05:00</d3p1:CreatedDate>
        <d3p1:EndQuantity>1</d3p1:EndQuantity>
        <d3p1:PackageUnitPrice>1</d3p1:PackageUnitPrice>
        <d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
        <d3p1:StartQuantity>3</d3p1:StartQuantity>
        <d3p1:UnitPrice>1</d3p1:UnitPrice>
      </d3p1:PtfProductBundlePlanPriceTier>
      <d3p1:PtfProductBundlePlanPriceTier>
        <Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
        <d3p1:CreatedDate>2025-05-20T17:00:51.401234-05:00</d3p1:CreatedDate>
        <d3p1:EndQuantity>1</d3p1:EndQuantity>
        <d3p1:PackageUnitPrice>1</d3p1:PackageUnitPrice>
        <d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
        <d3p1:StartQuantity>3</d3p1:StartQuantity>
        <d3p1:UnitPrice>1</d3p1:UnitPrice>
      </d3p1:PtfProductBundlePlanPriceTier>
    </Tiers>
    <TrialDurationInDays>9</TrialDurationInDays>
    <UnlimitedAnalysisCount>true</UnlimitedAnalysisCount>
    <UnlimitedReportCount>true</UnlimitedReportCount>
    <WebIntegrationSupport>true</WebIntegrationSupport>
    <WhiteLabelingSupport>true</WhiteLabelingSupport>
  </PtfProductBundlePlanModel>
</ArrayOfPtfProductBundlePlanModel>