

Kazoo-ServicePlans

Service Plans#

Service Plans define costs associated with various services in the system. Services figure out how many devices, trunks, users and similar features are in use for an account. Those totals are applied to one or more service plans on the account and then passed to a bookkeeper to handle the actual billing functionality.

Use Case#

New guy just installed his cluster, wants to bill his clients

Configuring a Service Plan#

A service plan document defines services, such as DIDs or SIP devices, which have a cost. It also defines the name of the corresponding element that will be used in your given bookkeeper (i.e. you may call DIDs in Quickbooks Phone Numbers, and therefore you need to map our name to your name). Together, these two concepts make up a service plan. The service plan document(s) is located within a reseller's account. The master account on every system is automatically considered the default reseller.

Master / Default Service Plans#

Standard accounts are accounts which live underneath a reseller. By default, the master account is the first reseller in the system. For the purposes of this example, we'll assume you're creating your first account beneath your master/reseller account.

Find Your Master Account

You'll need the account-ID if you don't already know it.
Go into the master account's database via BigCouch's Futon interface
Create a new document
Add the field pvt_type with the value service_plan
Add a plan

{
    "devices": {
        "_all": {
            "as": "sip_devices",
            "cascade": "true",
            "name": "SIP Device",
            "rates": {
                "100": 149.95,
                "20": 24.95,
                "5": 0,
                "50": 49.95
            }
        }
    },
    "limits": {
        "inbound_trunks": {
            "name": "Inbound Trunk",
            "rate": 19.99
        },
        "twoway_trunks": {
            "name": "Two-Way Trunk",
            "rate": 29.99
        }
    },
    "number_services": {
        "cnam": {
            "activation_charge": 2,
            "name": "CNAM Update"
        },
        "e911": {
            "discounts": {
                "single": {
                    "rate": 5
                }
            },
            "name": "E911 Service",
            "rate": 5
        },
        "port": {
            "activation_charge": 5,
            "name": "Port Request"
        }
    },
    "phone_numbers": {
        "did_us": {
            "cascade": "false",
            "discounts": {
                "cumulative": {
                    "maximum": 2,
                    "rate": 0.5
                }
            },
            "name": "US DID",
            "rate": 1
        },
        "tollfree_us": {
            "cascade": "true",
            "minimum": 10,
            "name": "US Tollfree",
            "rate": 5
        }
    }
}

Reseller Service Plans

Service Plan Minimums

List Available Service Plans

curl -v -X GET     -H "X-Auth-Token: $AUTH_TOKEN"     "http://localhost:8000/v2/accounts/$ACCOUNT_ID/services/available" | jq

Retrive currently assigned service plan

curl -v -X GET  -H "X-Auth-Token: $AUTH_TOKEN"     "http://localhost:8000/v2/accounts/$ACCOUNT_ID/services" | jq

Service Plan Summary

curl -v -X GET -H "X-Auth-Token: $AUTH_TOKEN"     "http://localhost:8000/v2/accounts/$ACCOUNT_ID/services/summary" | jq

Assigning Service Plan to an Account

curl -v -X POST     -H "X-Auth-Token: $AUTH_TOKEN"  "http://localhost:8000/v2/accounts/$ACCOUNT_ID/services/$PLAN_ID" | jq

Remove Service Plan from Account

curl -v -X DELETE     -H "X-Auth-Token: $AUTH_TOKEN"  "http://localhost:8000/v2/accounts/$ACCOUNT_ID/services/$PLAN_ID" | jq

Promoting Account to Reseller Status

curl -s -X PUT -H "X-Auth-Token: {AUTH_TOKEN}" http://localhost:8000/v2/accounts/{ACCOUNT_ID}/reseller

Demote Account from Reseller Status

curl -s -X DELETE -H "X-Auth-Token: {AUTH_TOKEN}" http://localhost:8000/v2/accounts/{ACCOUNT_ID}/reseller

Setting the default / global service plan

Checking if someone is properly setup as a reseller?

APIs for any of the above (now or future)

What does default_service_plan do?

How to check that a bookkeeper is loaded/running? To check if braintree app is running

sup kapps_controller list_apps

Braintree app should be in this list.

What happens if a bookkeeper is not working/loaded/running?

Advanced Features#

It may be useful to have a reseller account with subaccounts, who in turn have their own subaccounts, all billing back to the reseller account. An account's reseller is determined by looking at each parent until the first account with a reseller flag is found. If no such account is found, the master account is used.

IMMEDIATE ACTION AFTER CHANGE:#

USER ADDS DEVICE

DEVICES ARE RE-COUNTED

SERVICES DATABASE IS UPDATED WITH LATEST COUNT

ACCOUNT IS MARKED AS DIRTY

PERIODIC MAINTENANCE:#

SCAN FOR DIRTY ACCOUNTS

APPLY SERVICE PLAN TO ACCOUNT SERVICES

PASS THE LIST OF BILLABLE ITEMS TO THE BOOKKEEPER

IF CUSTOMER IS PART OF A RESELLER, DIRTY THE RESELLER'S ACCOUNT

BOOKKEEPER:#

TAKE NORMALIZED LIST OF ITEMS

PASS TO BOOKKEEPER SPECIFIC LOGIC (Could be WHMCS, Braintree, Stripe, etc.)

RETURNS ACCOUNT STATUS (GOOD STANDING or ERROR)

KAZOO Support Channels