API

The Rise to SaaS module can be interacted with through API.

Below are available open endpoints:

You should replace ‘https://risetosaas.com with your Rise CRM installation URL.

List all plans

(GET) https://risetosaas.com/saas/api/plans

Returns list of all SaaS plans/packages (JSON string):

[
    {
        "id": "3",
        "name": "Basic Plan",
        "description": "Description",
        "slug": "basic-plan",
        "price": "30.00",
        "trial_period": "15",
        "is_default": "1",
        "is_private": "0",
        "db_scheme": "multitenancy",
        "status": "1",
        "modules": [
            "exports",
            "backup",
            "goals",
            "menu_setup",
            "page_builder",
            "surveys",
            "theme_style"
        ],
        "metadata": {
            "invoice": {
                "recurring": "1",
                "repeat_every_custom": "1",
                "repeat_type_custom": "day",
                "allowed_payment_modes": [
                    "1",
                    "authorize_acceptjs",
                    "paypal_checkout"
                ],
                "sale_agent": ""
            },
            "max_instance_limit": "1",
            "limitations": {
                "invoices": "50",
                "estimates": "-1",
                ...
                "items": "-1"
            },
            "enable_subdomain": "1",
            "enable_custom_domain": "1",
            "shared_settings": []
        }
    },
    {
        "id": "2",
        "name": "Standard Plan",
        "description": "Demoe description of standard plan",
        "slug": "standard-plan",
        "price": "69.99",
        "trial_period": "15",
        "is_default": "0",
        "is_private": "0",
        "db_scheme": "multitenancy",
        "status": "1",
        "modules": [
            "exports",
            "backup",
            "goals",
            "menu_setup",
            "surveys",
            "theme_style"
        ],
        "metadata": {
            "invoice": {
                "recurring": "1",
                "repeat_every_custom": "1",
                "repeat_type_custom": "day",
                "allowed_payment_modes": [
                    "1",
                    "authorize_acceptjs",
                    "paypal_checkout"
                ],
                "sale_agent": ""
            },
            "max_instance_limit": "2",
            "limitations": {
                "invoices": "50",
                "estimates": "-1",
                ...
                "items": "-1"
            },
            "enable_subdomain": "1",
            "enable_custom_domain": "1",
            "shared_settings": []
        }
    },
    ...
]

Get a single plan

(GET) https://risetosaas.com/saas/api/plans/{planid}

Returns a single plan only (JSON string): https://riseosaas.com/saas/api/plans/3

[
    {
        "id": "3",
        "name": "Basic Plan",
        "description": "Description",
        "slug": "basic-plan",
        "price": "30.00",
        "trial_period": "15",
        "is_default": "1",
        "is_private": "0",
        "db_scheme": "multitenancy",
        "status": "1",
        "modules": [
            "exports",
            "backup",
            "goals",
            "menu_setup",
            "page_builder",
            "surveys",
            "theme_style"
        ],
        "metadata": {
            "invoice": {
                "recurring": "1",
                "repeat_every_custom": "1",
                "repeat_type_custom": "day",
                "allowed_payment_modes": [
                    "1",
                    "authorize_acceptjs",
                    "paypal_checkout"
                ],
                "sale_agent": ""
            },
            "max_instance_limit": "1",
            "limitations": {
                "invoices": "50",
                "estimates": "-1",
                ...
                "items": "-1"
            },
            "enable_subdomain": "1",
            "enable_custom_domain": "1",
            "shared_settings": []
        }
    }
]

Tenant ID availability check

(GET) https://risetosaas.com/saas/api/is_slug_available/tenant1

The endpoint checks if the provided slug/subdomain id is available for use. Returns JSON string:

{
    "available": false
}

Custom domain availability check

(GET) https://risetosaas.com/saas/api/caddy_domain_check?domain=ulutfa.crm.com

Return only HTTP status code of 404 or 200:

The endpoint returns 404 if no match, 200 (OK) if same as base domain and 200(Matched) when a match found (subdomain or custom domain).