GET api/products/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 ProductBundlePlanModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| Name | string |
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. |
|
| MaxAppealCount | integer |
None. |
|
| MaxPropertyCount | integer |
None. |
|
| MaxExemptionCount | integer |
None. |
|
| AdvertisementSupport | boolean |
None. |
|
| CustomPropertySearchToolSupport | boolean |
None. |
|
| AutoDocGenerationSupport | boolean |
None. |
|
| WhiteLabelingSupport | boolean |
None. |
|
| MultiPropertyComparisonSupport | boolean |
None. |
|
| LackOfUniformityReportSupport | boolean |
None. |
|
| OvervaluationReportSupport | boolean |
None. |
|
| FullPropertyProfileReportSupport | boolean |
None. |
|
| MultiPropertyComparisonReportSupport | boolean |
None. |
|
| PropertyTaxGuideReportSupport | boolean |
None. |
|
| SellerTaxAnalysisReportSupport | boolean |
None. |
|
| BuyerTaxAnalysisReportSupport | boolean |
None. |
|
| EmbeddingSupport | boolean |
None. |
|
| BatchImportSupport | boolean |
None. |
|
| LeadGenerationSupport | boolean |
None. |
|
| CsvExport | boolean |
None. |
|
| IsProfessional | boolean |
None. |
|
| AffiliateMarketingSupport | boolean |
None. |
|
| ApiAccessSupport | boolean |
None. |
|
| CreatedDate | date |
None. |
|
| DeletedDate | date |
None. |
|
| PaymentGatewayId | integer |
None. |
|
| PriceTierTypeId | integer |
None. |
|
| IsActive | boolean |
None. |
|
| PricingPageVisible | boolean |
None. |
|
| Tiers | Collection of ProductBundlePlanPriceTier |
None. |
|
| AppealRolloverSupport | boolean |
None. |
|
| AppealManagementSupport | boolean |
None. |
|
| Scope | string |
None. |
|
| IncludedItems | string |
None. |
|
| DisplayOrder | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"name": "sample string 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,
"maxAppealCount": 11,
"maxPropertyCount": 12,
"maxExemptionCount": 13,
"advertisementSupport": true,
"customPropertySearchToolSupport": true,
"autoDocGenerationSupport": true,
"whiteLabelingSupport": true,
"multiPropertyComparisonSupport": true,
"lackOfUniformityReportSupport": true,
"overvaluationReportSupport": true,
"fullPropertyProfileReportSupport": true,
"multiPropertyComparisonReportSupport": true,
"propertyTaxGuideReportSupport": true,
"sellerTaxAnalysisReportSupport": true,
"buyerTaxAnalysisReportSupport": true,
"embeddingSupport": true,
"batchImportSupport": true,
"leadGenerationSupport": true,
"csvExport": true,
"isProfessional": true,
"affiliateMarketingSupport": true,
"apiAccessSupport": true,
"createdDate": "2025-11-01T05:57:45.7192255-05:00",
"deletedDate": "2025-11-01T05:57:45.7192255-05:00",
"paymentGatewayId": 35,
"priceTierTypeId": 36,
"isActive": true,
"pricingPageVisible": true,
"tiers": [
{
"id": 1,
"productBundlePlanId": 2,
"startQuantity": 3,
"endQuantity": 1,
"unitPrice": 1.0,
"appealPackageUnitPrice": 1.0,
"createdDate": "2025-11-01T05:57:45.7212592-05:00"
},
{
"id": 1,
"productBundlePlanId": 2,
"startQuantity": 3,
"endQuantity": 1,
"unitPrice": 1.0,
"appealPackageUnitPrice": 1.0,
"createdDate": "2025-11-01T05:57:45.7212592-05:00"
}
],
"appealRolloverSupport": true,
"appealManagementSupport": true,
"scope": "sample string 41",
"includedItems": "sample string 42",
"displayOrder": 43
},
{
"id": 1,
"name": "sample string 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,
"maxAppealCount": 11,
"maxPropertyCount": 12,
"maxExemptionCount": 13,
"advertisementSupport": true,
"customPropertySearchToolSupport": true,
"autoDocGenerationSupport": true,
"whiteLabelingSupport": true,
"multiPropertyComparisonSupport": true,
"lackOfUniformityReportSupport": true,
"overvaluationReportSupport": true,
"fullPropertyProfileReportSupport": true,
"multiPropertyComparisonReportSupport": true,
"propertyTaxGuideReportSupport": true,
"sellerTaxAnalysisReportSupport": true,
"buyerTaxAnalysisReportSupport": true,
"embeddingSupport": true,
"batchImportSupport": true,
"leadGenerationSupport": true,
"csvExport": true,
"isProfessional": true,
"affiliateMarketingSupport": true,
"apiAccessSupport": true,
"createdDate": "2025-11-01T05:57:45.7192255-05:00",
"deletedDate": "2025-11-01T05:57:45.7192255-05:00",
"paymentGatewayId": 35,
"priceTierTypeId": 36,
"isActive": true,
"pricingPageVisible": true,
"tiers": [
{
"id": 1,
"productBundlePlanId": 2,
"startQuantity": 3,
"endQuantity": 1,
"unitPrice": 1.0,
"appealPackageUnitPrice": 1.0,
"createdDate": "2025-11-01T05:57:45.7212592-05:00"
},
{
"id": 1,
"productBundlePlanId": 2,
"startQuantity": 3,
"endQuantity": 1,
"unitPrice": 1.0,
"appealPackageUnitPrice": 1.0,
"createdDate": "2025-11-01T05:57:45.7212592-05:00"
}
],
"appealRolloverSupport": true,
"appealManagementSupport": true,
"scope": "sample string 41",
"includedItems": "sample string 42",
"displayOrder": 43
}
]
text/html
Sample:
[{"id":1,"name":"sample string 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,"maxAppealCount":11,"maxPropertyCount":12,"maxExemptionCount":13,"advertisementSupport":true,"customPropertySearchToolSupport":true,"autoDocGenerationSupport":true,"whiteLabelingSupport":true,"multiPropertyComparisonSupport":true,"lackOfUniformityReportSupport":true,"overvaluationReportSupport":true,"fullPropertyProfileReportSupport":true,"multiPropertyComparisonReportSupport":true,"propertyTaxGuideReportSupport":true,"sellerTaxAnalysisReportSupport":true,"buyerTaxAnalysisReportSupport":true,"embeddingSupport":true,"batchImportSupport":true,"leadGenerationSupport":true,"csvExport":true,"isProfessional":true,"affiliateMarketingSupport":true,"apiAccessSupport":true,"createdDate":"2025-11-01T05:57:45.7192255-05:00","deletedDate":"2025-11-01T05:57:45.7192255-05:00","paymentGatewayId":35,"priceTierTypeId":36,"isActive":true,"pricingPageVisible":true,"tiers":[{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"appealPackageUnitPrice":1.0,"createdDate":"2025-11-01T05:57:45.7212592-05:00"},{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"appealPackageUnitPrice":1.0,"createdDate":"2025-11-01T05:57:45.7212592-05:00"}],"appealRolloverSupport":true,"appealManagementSupport":true,"scope":"sample string 41","includedItems":"sample string 42","displayOrder":43},{"id":1,"name":"sample string 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,"maxAppealCount":11,"maxPropertyCount":12,"maxExemptionCount":13,"advertisementSupport":true,"customPropertySearchToolSupport":true,"autoDocGenerationSupport":true,"whiteLabelingSupport":true,"multiPropertyComparisonSupport":true,"lackOfUniformityReportSupport":true,"overvaluationReportSupport":true,"fullPropertyProfileReportSupport":true,"multiPropertyComparisonReportSupport":true,"propertyTaxGuideReportSupport":true,"sellerTaxAnalysisReportSupport":true,"buyerTaxAnalysisReportSupport":true,"embeddingSupport":true,"batchImportSupport":true,"leadGenerationSupport":true,"csvExport":true,"isProfessional":true,"affiliateMarketingSupport":true,"apiAccessSupport":true,"createdDate":"2025-11-01T05:57:45.7192255-05:00","deletedDate":"2025-11-01T05:57:45.7192255-05:00","paymentGatewayId":35,"priceTierTypeId":36,"isActive":true,"pricingPageVisible":true,"tiers":[{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"appealPackageUnitPrice":1.0,"createdDate":"2025-11-01T05:57:45.7212592-05:00"},{"id":1,"productBundlePlanId":2,"startQuantity":3,"endQuantity":1,"unitPrice":1.0,"appealPackageUnitPrice":1.0,"createdDate":"2025-11-01T05:57:45.7212592-05:00"}],"appealRolloverSupport":true,"appealManagementSupport":true,"scope":"sample string 41","includedItems":"sample string 42","displayOrder":43}]
application/xml, text/xml
Sample:
<ArrayOfProductBundlePlanModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
<ProductBundlePlanModel>
<AdditionReportPrice>8</AdditionReportPrice>
<AdvertisementSupport>true</AdvertisementSupport>
<AffiliateMarketingSupport>true</AffiliateMarketingSupport>
<AnnualPrice>7</AnnualPrice>
<ApiAccessSupport>true</ApiAccessSupport>
<AppealManagementSupport>true</AppealManagementSupport>
<AppealRolloverSupport>true</AppealRolloverSupport>
<AutoDocGenerationSupport>true</AutoDocGenerationSupport>
<BatchImportSupport>true</BatchImportSupport>
<BuyerTaxAnalysisReportSupport>true</BuyerTaxAnalysisReportSupport>
<CreatedDate>2025-11-01T05:57:45.7192255-05:00</CreatedDate>
<CsvExport>true</CsvExport>
<CustomPropertySearchToolSupport>true</CustomPropertySearchToolSupport>
<DeletedDate>2025-11-01T05:57:45.7192255-05:00</DeletedDate>
<Description>sample string 3</Description>
<DisplayOrder>43</DisplayOrder>
<EmbeddingSupport>true</EmbeddingSupport>
<FullPropertyProfileReportSupport>true</FullPropertyProfileReportSupport>
<Id>1</Id>
<IncludedItems>sample string 42</IncludedItems>
<IsActive>true</IsActive>
<IsProfessional>true</IsProfessional>
<LackOfUniformityReportSupport>true</LackOfUniformityReportSupport>
<LeadGenerationSupport>true</LeadGenerationSupport>
<MaxAppealCount>11</MaxAppealCount>
<MaxExemptionCount>13</MaxExemptionCount>
<MaxPropertyCount>12</MaxPropertyCount>
<MultiPropertyComparisonReportSupport>true</MultiPropertyComparisonReportSupport>
<MultiPropertyComparisonSupport>true</MultiPropertyComparisonSupport>
<Name>sample string 2</Name>
<OvervaluationReportSupport>true</OvervaluationReportSupport>
<PaymentGatewayId>35</PaymentGatewayId>
<PreviewImageUrl>sample string 4</PreviewImageUrl>
<Price>6</Price>
<PriceTierTypeId>36</PriceTierTypeId>
<PricingPageVisible>true</PricingPageVisible>
<PropertyTaxGuideReportSupport>true</PropertyTaxGuideReportSupport>
<Scope>sample string 41</Scope>
<SellerTaxAnalysisReportSupport>true</SellerTaxAnalysisReportSupport>
<SetupFee>10</SetupFee>
<StripePlanId>sample string 5</StripePlanId>
<Tiers xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities">
<d3p1:ProductBundlePlanPriceTier>
<Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
<d3p1:AppealPackageUnitPrice>1</d3p1:AppealPackageUnitPrice>
<d3p1:CreatedDate>2025-11-01T05:57:45.7212592-05:00</d3p1:CreatedDate>
<d3p1:EndQuantity>1</d3p1:EndQuantity>
<d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
<d3p1:StartQuantity>3</d3p1:StartQuantity>
<d3p1:UnitPrice>1</d3p1:UnitPrice>
</d3p1:ProductBundlePlanPriceTier>
<d3p1:ProductBundlePlanPriceTier>
<Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
<d3p1:AppealPackageUnitPrice>1</d3p1:AppealPackageUnitPrice>
<d3p1:CreatedDate>2025-11-01T05:57:45.7212592-05:00</d3p1:CreatedDate>
<d3p1:EndQuantity>1</d3p1:EndQuantity>
<d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
<d3p1:StartQuantity>3</d3p1:StartQuantity>
<d3p1:UnitPrice>1</d3p1:UnitPrice>
</d3p1:ProductBundlePlanPriceTier>
</Tiers>
<TrialDurationInDays>9</TrialDurationInDays>
<WhiteLabelingSupport>true</WhiteLabelingSupport>
</ProductBundlePlanModel>
<ProductBundlePlanModel>
<AdditionReportPrice>8</AdditionReportPrice>
<AdvertisementSupport>true</AdvertisementSupport>
<AffiliateMarketingSupport>true</AffiliateMarketingSupport>
<AnnualPrice>7</AnnualPrice>
<ApiAccessSupport>true</ApiAccessSupport>
<AppealManagementSupport>true</AppealManagementSupport>
<AppealRolloverSupport>true</AppealRolloverSupport>
<AutoDocGenerationSupport>true</AutoDocGenerationSupport>
<BatchImportSupport>true</BatchImportSupport>
<BuyerTaxAnalysisReportSupport>true</BuyerTaxAnalysisReportSupport>
<CreatedDate>2025-11-01T05:57:45.7192255-05:00</CreatedDate>
<CsvExport>true</CsvExport>
<CustomPropertySearchToolSupport>true</CustomPropertySearchToolSupport>
<DeletedDate>2025-11-01T05:57:45.7192255-05:00</DeletedDate>
<Description>sample string 3</Description>
<DisplayOrder>43</DisplayOrder>
<EmbeddingSupport>true</EmbeddingSupport>
<FullPropertyProfileReportSupport>true</FullPropertyProfileReportSupport>
<Id>1</Id>
<IncludedItems>sample string 42</IncludedItems>
<IsActive>true</IsActive>
<IsProfessional>true</IsProfessional>
<LackOfUniformityReportSupport>true</LackOfUniformityReportSupport>
<LeadGenerationSupport>true</LeadGenerationSupport>
<MaxAppealCount>11</MaxAppealCount>
<MaxExemptionCount>13</MaxExemptionCount>
<MaxPropertyCount>12</MaxPropertyCount>
<MultiPropertyComparisonReportSupport>true</MultiPropertyComparisonReportSupport>
<MultiPropertyComparisonSupport>true</MultiPropertyComparisonSupport>
<Name>sample string 2</Name>
<OvervaluationReportSupport>true</OvervaluationReportSupport>
<PaymentGatewayId>35</PaymentGatewayId>
<PreviewImageUrl>sample string 4</PreviewImageUrl>
<Price>6</Price>
<PriceTierTypeId>36</PriceTierTypeId>
<PricingPageVisible>true</PricingPageVisible>
<PropertyTaxGuideReportSupport>true</PropertyTaxGuideReportSupport>
<Scope>sample string 41</Scope>
<SellerTaxAnalysisReportSupport>true</SellerTaxAnalysisReportSupport>
<SetupFee>10</SetupFee>
<StripePlanId>sample string 5</StripePlanId>
<Tiers xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities">
<d3p1:ProductBundlePlanPriceTier>
<Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
<d3p1:AppealPackageUnitPrice>1</d3p1:AppealPackageUnitPrice>
<d3p1:CreatedDate>2025-11-01T05:57:45.7212592-05:00</d3p1:CreatedDate>
<d3p1:EndQuantity>1</d3p1:EndQuantity>
<d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
<d3p1:StartQuantity>3</d3p1:StartQuantity>
<d3p1:UnitPrice>1</d3p1:UnitPrice>
</d3p1:ProductBundlePlanPriceTier>
<d3p1:ProductBundlePlanPriceTier>
<Id xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Entities.Core">1</Id>
<d3p1:AppealPackageUnitPrice>1</d3p1:AppealPackageUnitPrice>
<d3p1:CreatedDate>2025-11-01T05:57:45.7212592-05:00</d3p1:CreatedDate>
<d3p1:EndQuantity>1</d3p1:EndQuantity>
<d3p1:ProductBundlePlanId>2</d3p1:ProductBundlePlanId>
<d3p1:StartQuantity>3</d3p1:StartQuantity>
<d3p1:UnitPrice>1</d3p1:UnitPrice>
</d3p1:ProductBundlePlanPriceTier>
</Tiers>
<TrialDurationInDays>9</TrialDurationInDays>
<WhiteLabelingSupport>true</WhiteLabelingSupport>
</ProductBundlePlanModel>
</ArrayOfProductBundlePlanModel>