List all plans for a product

GET

/products/{productId}/plans

Here, you can list the plans for a product. This can be done either for a specific country or for all countries. Also, you can filter the admin-specific plans. These plans are used only by the merchants and are not meant for customers.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-sandbox.saaslogic.io/v1/products/h564y2b9-349d-4498-a70d-5baaa88e567v/plans?countryISOCode=USA&includeAdminPlans=true' \
--header 'Accept: application/json' \
--header 'Accept;' \
--header 'Authorization;' \
--header 'Content-Type: application/json'

Response Example

200 - A list of plans

{
  "productId": "h564y2b9-349d-4498-a70d-5baaa88e567v",
  "productName": "Konnectware",
  "plans": [
    {
      "name": "Tiered [Volume]- Professional",
      "planId": "e8b4b2b9-349d-4498-a70d-5baaa89e567b",
      "billingFrequencyId": "6efa1fccfda8469e8f6197a10b9cdd79",
      "billingFrequencyName": "Monthly",
      "planType": "Standard",
      "pricingModel": "Tiered",
      "isBilledAfterService": false,
      "currencySymbol": "$",
      "currencyISOCode": "USD",
      "tierCalculationType": "Volume",
      "trialDays": 30,
      "isTrialAllowed": true,
      "trialButtonText": "Start Free Trial",
      "subscribeButtonText": "Subscribe Now",
      "isFeatured": true,
      "targetCustomerTypes": [
        "INDIVIDUAL",
        "BUSINESS"
      ],
      "pricing": [
        {
          "displayName": "Subscription charge",
          "price": 100
        },
        {
          "displayName": "Subscription charge",
          "price": 100
        }
      ],
      "pricingTiers": [
        {
          "resourceId": "8c979d26726c4c91a791764712534791",
          "resourceName": "Licenses",
          "rangeFrom": 0,
          "rangeTo": 10,
          "price": 5.75,
          "setSize": 2,
          "uomName": "Number",
          "priceCalculationType": "Fixed"
        },
        {
          "resourceId": "8c979d26726c4c91a791764712534791",
          "resourceName": "Licenses",
          "rangeFrom": 0,
          "rangeTo": 10,
          "price": 5.75,
          "setSize": 2,
          "uomName": "Number",
          "priceCalculationType": "Fixed"
        }
      ],
      "features": [
        {
          "featureId": "30ea5777-3c2a-4dd1-b673-dba82c2a346d",
          "featureName": "Feature 1",
          "description": "Feature 1"
        },
        {
          "featureId": "30ea5777-3c2a-4dd1-b673-dba82c2a346d",
          "featureName": "Feature 1",
          "description": "Feature 1"
        }
      ],
      "resources": [
        {
          "resourceId": "77ea5788-3c2a-4dd1-b673-dba82c2a344f",
          "displayName": "API Calls",
          "value": 100,
          "uomName": "Number"
        },
        {
          "resourceId": "77ea5788-3c2a-4dd1-b673-dba82c2a344f",
          "displayName": "API Calls",
          "value": 100,
          "uomName": "Number"
        }
      ],
      "countries": [
        {
          "countryISOCode": "USA",
          "countryName": "United States"
        },
        {
          "countryISOCode": "USA",
          "countryName": "United States"
        }
      ]
    },
    {
      "name": "Tiered [Volume]- Professional",
      "planId": "e8b4b2b9-349d-4498-a70d-5baaa89e567b",
      "billingFrequencyId": "6efa1fccfda8469e8f6197a10b9cdd79",
      "billingFrequencyName": "Monthly",
      "planType": "Standard",
      "pricingModel": "Tiered",
      "isBilledAfterService": false,
      "currencySymbol": "$",
      "currencyISOCode": "USD",
      "tierCalculationType": "Volume",
      "trialDays": 30,
      "isTrialAllowed": true,
      "trialButtonText": "Start Free Trial",
      "subscribeButtonText": "Subscribe Now",
      "isFeatured": true,
      "targetCustomerTypes": [
        "INDIVIDUAL",
        "BUSINESS"
      ],
      "pricing": [
        {
          "displayName": "Subscription charge",
          "price": 100
        },
        {
          "displayName": "Subscription charge",
          "price": 100
        }
      ],
      "pricingTiers": [
        {
          "resourceId": "8c979d26726c4c91a791764712534791",
          "resourceName": "Licenses",
          "rangeFrom": 0,
          "rangeTo": 10,
          "price": 5.75,
          "setSize": 2,
          "uomName": "Number",
          "priceCalculationType": "Fixed"
        },
        {
          "resourceId": "8c979d26726c4c91a791764712534791",
          "resourceName": "Licenses",
          "rangeFrom": 0,
          "rangeTo": 10,
          "price": 5.75,
          "setSize": 2,
          "uomName": "Number",
          "priceCalculationType": "Fixed"
        }
      ],
      "features": [
        {
          "featureId": "30ea5777-3c2a-4dd1-b673-dba82c2a346d",
          "featureName": "Feature 1",
          "description": "Feature 1"
        },
        {
          "featureId": "30ea5777-3c2a-4dd1-b673-dba82c2a346d",
          "featureName": "Feature 1",
          "description": "Feature 1"
        }
      ],
      "resources": [
        {
          "resourceId": "77ea5788-3c2a-4dd1-b673-dba82c2a344f",
          "displayName": "API Calls",
          "value": 100,
          "uomName": "Number"
        },
        {
          "resourceId": "77ea5788-3c2a-4dd1-b673-dba82c2a344f",
          "displayName": "API Calls",
          "value": 100,
          "uomName": "Number"
        }
      ],
      "countries": [
        {
          "countryISOCode": "USA",
          "countryName": "United States"
        },
        {
          "countryISOCode": "USA",
          "countryName": "United States"
        }
      ]
    }
  ]
}

Request

Path Params

Query Params

Header Params

Responses

🟢200A list of plans

application/json

Body

🔴500ErrorResponse

Get list of countries

Create a product subscription