Saaslogic
  1. Plans
Saaslogic
  • Introduction
  • Authentication
  • Enum Reference
  • Authentication
    • saaslogic token
      • Get the saaslogic access token
    • login Url
      • Gives the login URL
    • logout Url
      • Gives the logout URL
  • Countries
    • Get list of countries
  • Plans
    • List all plans for a product
      GET
  • Subscriptions
    • Create a product subscription
    • Retrieve a subscription
    • Create Customer and Subscription
    • Subscription with details permissions, menus and features
    • The Saaslogic URL for creating subscription
  • Usage Reporting
    • Report the resource usages in subscription for invoicing
    • Retrieves the resource usages of a subscription in the current billing cycle
  • Customers
    • addresses
      • Create an address
      • List all addresses
      • Update an address
      • Retrieve an address
      • Delete an address
    • contacts
      • Create a contact
      • List all contacts
      • Update a contact
      • Retrieve a contact
      • Delete a contact
    • Create a customer
    • List all customers
    • Update a customer
    • Retrieve a customer
    • Delete a customer
  • Vendors
    • vendor addresses
      • Create a vendor address.
      • List all vendor addresses.
      • Update a vendor address.
      • Retrieve a vendor address..
      • Delete a vendor address.
    • vendor contacts
      • Create a vendor contact.
      • List all vendor contacts.
      • Update a vendor contact.
      • Retrieve a vendor contact.
      • Delete a vendor contact.
    • vendor bills
      • Create a vendor bill
      • Cancel a vendor bill.
    • vendor bills payout
      • Update payment details to vendor bills.
    • Create a vendor
    • Update a vendor.
    • Activate a vendor.
    • Dectivate a vendor.
  • Attributes
    • Create a organization attribute and set the value
    • Retrieve a organization attribute
    • Create a user attribute
    • Update a user attribute
    • Get a user attribute
  • Invoices
    • subscriptions
      • Get the invoices
      • Get the invoices by subscription
    • payments
      • Mark the invoice payment status
    • Get the invoice details .
    • cancel the invoices
    • Send invoice as pdf with payment link.
    • Create an on-demand invoice
  1. Plans

List all plans for a product

GET
/products/{productId}/plans
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 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 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
productId
string 
required
(Required) The ID of the product.
Example:
h564y2b9-349d-4498-a70d-5baaa88e567v
Query Params
countryISOCode
enum<string> 
required
The ISO code of the country.
Allowed values:
USAINDAUSCHNCHLKHMCANGBRKENBRAMWIVNMARETURESPPHLPERPAKNGANZLNLDMEXJORJPNIDNDEUETHDNKCUBCRIBOLBELARGBGDAUT
Example:
USA
includeAdminPlans
boolean 
required
Filter to include admin-specific plans.
Example:
true
Header Params
Accept
string 
required
Example:
application/json
Authorization
string 
required
Saaslogic authorization token
Default:
Bearer {{bearerToken}}
Content-Type
string 
optional
Default:
application/json

Responses

🟢200A list of plans
application/json
Body
productId
string 
required
The ID of the product
productName
string 
required
Name of the product
plans
array [object {21}] 
required
List of plans associated with the product
name
string 
required
Name of the plan
planId
string 
required
The ID of the plan
billingFrequencyId
string 
required
The ID of the billing frequency
billingFrequencyName
string 
required
Name of the billing frequency
planType
string 
required
Type of the plan
pricingModel
string 
required
Pricing model of the plan
isBilledAfterService
boolean 
required
Indicates whether billing occurs after service usage
currencySymbol
string 
required
Symbol of the currency used for billing
currencyISOCode
string 
required
ISO code of the currency
tierCalculationType
string 
required
Type of tier calculation used
trialDays
integer 
required
Number of trial days available for the plan
isTrialAllowed
boolean 
required
Indicates whether a trial is allowed for this plan
trialButtonText
string 
required
Text for the trial button
subscribeButtonText
string 
required
Text for the subscribe button
isFeatured
boolean 
required
Indicates whether this plan is featured
targetCustomerTypes
array[string]
required
List of target customer types
Allowed values:
BUSINESSINDIVIDUAL
pricing
array [object {2}] 
required
Pricing details of the plan
pricingTiers
array [object {8}] 
required
Tier-based pricing structure
features
array [object {3}] 
required
List of features included in the plan
resources
array [object {4}] 
required
List of resources included in the plan
countries
array [object {2}] 
required
List of countries where the plan is available
🔴500ErrorResponse
Previous
Get list of countries
Next
Create a product subscription
Built with