Get Plans

POST

/plans/search

Retrieve plans using optional filters. If no filters are provided, all plans available to the authenticated merchant will be returned.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🔴500ErrorResponse

Request Example

Shell

JavaScript

Java

Swift

cURL

Example 1Plan Change Options

curl --location 'https://api-sandbox.saaslogic.io/v1/plans/search' \
--header 'Authorization: Bearer ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "productIds": [
        "8edf1695-0bd1-45c5-9a55-2ce6b6fec9ef"
    ],
    "productNames": [
        "Subscription Management Platform"
    ],
    "statuses": [
        "Published",
        "Draft"
    ]
}'

Response Example

200 - Example 1

[
    {
        "planId": "plan-ref-0001",
        "planName": "Pro Plan",
        "description": "A short description",
        "currencyISOCode": "USD",
        "isPostPaid": false,
        "isUsageBased": false,
        "isVisibleToCustomer": false,
        "targetCustomerTypes": [
            "Business",
            "Individual",
            "Sub-Merchant"
        ],
        "isTrialEnabled": false,
        "serviceAddress": {
            "address": "100 W. Old Wilson Bridge Road, \nOhio 43085, USA",
            "countryCode": "USA",
            "stateCode": "OH",
            "city": "Worthington",
            "zip": "43085"
        },
        "sellingCountryIsoCodes": [
            "USA"
        ],
        "oneTimeCharges": [
            {
                "label": "Setup fee",
                "price": 99.00
            }
        ],
        "recurringCharges": [
            {
                "billingFrequency": "Monthly",
                "fixedCharges": [
                    {
                        "label": "Standard",
                        "price": 29.99
                    }
                ],
                "resourceBasedCharges": [
                    {
                        "resourceName": "API Calls",
                        "uomName": "Number",
                        "isPercentage": false,
                        "tiers": [
                            {
                                "rangeFrom": 0.0,
                                "rangeTo": 1000.0,
                                "price": 1.00
                            }
                        ]
                    }
                ]
            }
        ],
        "includedResources": [
            {
                "resourceName": "Storage",
                "uomName": "GB",
                "value": 10.0,
                "isPerUnit": true,
                "dependsOnResource": "API Calls"
            }
        ],
        "features": [
            "test management"
        ],
        "tierCalculationType": "Volume",
        "status": "Draft",
        "productName": "Subscription Management Platform",
        "shareType": "Direct"
    }
]

Get Plan

List all plans for a product