Partner Billing

Partner Billing API

Summary

• Billing
  • site
    • site billing config
    • site billing profile
  • subscription
    • subscription product relation
    • subscription pricing model
    • subscription feature limitation config
  • product
  • product feature point
    • feature point item
  • invoice bill to

Site

You need the Manage Site permission to manage sites.

• GET /api/billing/site/search - Get paged collection of sites
• GET /api/billing/sites - Get collection of sites
• GET /api/billing/sites/{id} - Get a site

Site Object JSON format

Site Object

Site definition.

Site Extra Info Object

SiteExtraInfo definition.

Site Activity Object

SiteActivity definition.

Site Billing Activity Object

SiteBillingActivity definition.

Site Registration Object

SiteRegistration definition.

Tag Object

Tag definition.

Agent Object

Agent definition.

Site Contract Object

SiteContract definition.

Site Contract Attachment Object

SiteContractAttachment definition.

Site Paged Model Object

SitePagedModel definition.

Site Agent Object

SiteAgent definition.

Site Endpoints

Get paged collection of sites

GET /api/billing/site/search

• Parameters

Query Parameters

• Response

  The response is paged collection of SitePagedModel objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/site/search \
-H 'Content-Type: application/json'  \
-X 'GET' \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "pageIndex": 1,
    "pageSize": 10,
    "pageCount": 7,
    "total": 67,
    "items": [
        {
            "siteId": 10000,
            "platformName": "internal",
            "registerDate": "2021-03-31T06:05:15.28Z",
            "lastActivityDate": "2022-04-07T08:58:28.9447384Z",
            "siteStatus": "open",
            "agent": [
                {
                    "siteId": 10000,
                    "agentId": "1ce38293-786b-4452-90a0-54adb3d31204",
                    "email": "test1@internal.com",
                    "displayName": "test1 internal",
                    "isAdmin": true
                }
            ],
            "billingPeriod": "annually",
            "billingStartDate": "2022-03-04T00:00:00Z",
            "nextBillingDate": "2023-03-04T00:00:00Z",
            "balance": 0.00,
            "purchasedAgents": 5,
            "activeAgents": 1,
            "subscription": [
                "Comm100 Omnichannel Business",
                "Comm100 Bot Enterprise"
            ],
            "profitCenterId": "02000000-0000-0000-0000-271000002710",
            "profitCenterName": "Vancouver ENT CS",
            "isActive": false,
            "buyingStage": "paying",
            "accountExecutiveId": "00000000-0000-0000-0000-000000000000",
            "accountExecutiveName": "No Account Executive",
            "company": "",
            "country": "Bosnia and Herzegovina",
            "ifHasSiteBillingProfile": 1
        }
    ]
}

Get collection of sites

GET /api/billing/sites

• Parameters

Query Parameters

• Response

  The response is collection of Site objects.

• Example

Using curl

curl  https://partner.comm100.io/api/billing/sites \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": 10000,
        "partnerId": 10000,
        "platformId": 100,
        "company": "",
        "companySize": "",
        "website": "",
        "phone": "",
        "fax": "",
        "countryOrRegion": "Bosnia and Herzegovina",
        "stateOrProvince": "",
        "city": "",
        "mailingAddress": "",
        "postalOrZipCode": "",
        "firstName": "test1",
        "lastName": "internal",
        "dateTimeFormat": "MM/DD/YYYY HH:mm:ss",
        "languageId": "en",
        "timeZone": "UTC-08",
        "status": "open",
        "subdomain": "",
        "customDomain": "",
        "industry": "Others",
        "otherIndustryDescription": "",
        "tagIds": [
            "fe53fe17-bd77-42c7-8cc0-278422bd89d6"
        ],
        "tags": [
            {
                "id": "fe53fe17-bd77-42c7-8cc0-278422bd89d6",
                "partnerId": 10000,
                "name": "Free Email Not Allowed"
            }          
        ],
        "siteAgents": [
            {
                "id": "1ce38293-786b-4452-90a0-54adb3d31204",
                "siteId": 10000,
                "email": "test1@internal.com",
                "displayName": "test1 internal",
                "firstName": "test1",
                "lastName": "internal",
                "isAdmin": true,
                "isActive": true,
                "createdTime": "2022-02-17T06:44:51.3966667Z"
            }
        ],
        "siteContracts": [
            {
                "id": "8d33378a-5a12-49f4-aa2a-bcb2fddf5ab6",
                "siteId": 100000001,
                "name": "re",
                "description": "1",
                "startDate": "2022-02-03T08:21:19Z",
                "endDate": "2022-02-16T08:21:20Z",
                "actionWhenContractEnds": "stopService",
                "siteContractAttachments": [
                    {
                        "id": "f7fe4f76-ecf9-4ed7-adb3-46187577744e",
                        "siteId": 100000001,
                        "sitecontractId": "8d33378a-5a12-49f4-aa2a-bcb2fddf5ab6",
                        "name": "desk.jpeg",
                        "attachment": "https://partner.comm100.io/api/billing/siteContractAttachments/f7fe4f76-ecf9-4ed7-adb3-46187577744e/attachment?siteId=10000&version=32b7b8b1af4bc663983f01100363da4a"
                    }
                ]
            }
        ],
        "siteExtraInfo": {
            "siteId": 10000,
            "profitCenterId": "02000000-0000-0000-0000-271000002710",
            "deploymentType": "Shared",
            "accountExecutive": "00000000-0000-0000-0000-000000000000",
            "accountManager": "00000000-0000-0000-0000-000000000000",
            "isSandboxSite": false,
            "isSpam": false
        },
        "siteActivity": {
            "siteId": 10000,
            "lastLoginTime": "2022-04-07T08:58:28.9447384Z",
            "isActive": false,
            "livechatCustomerLastWebPageVisitTime": null,
            "livechatCustomerLastWebPageUrl": ""
        },
        "siteBillingConfig": {
            "siteId": 10000,
            "billingPeriod": "annual",
            "billingStartDate": "2022-03-04T00:00:00Z",
            "nextBillingDate": "2023-03-04T00:00:00Z",
            "balance": 0.00,
            "currencyId": "USD",
            "isPricingVisible": false,
            "isSubscriptionChangeByCustomerAllowed": false,
            "isAgentsPurchasedInAdvance": true,
            "purchasedAgents": 5,
            "isInvoiceVisibleToCustomer": false,
            "isBillingEmailSentAutomatically": false,
            "isBillingPopupAutomatically": false,
            "paymentTerm": "net0",
            "paymentTermValue": 0,
            "currency": {
                "id": "USD",
                "symbol": "$",
                "description": ""
            }
        },
        "siteBillingActivity": {
            "siteId": 10000,
            "buyingStage": "paying"
        },
        "subscriptions": [
            {
                "id": "895a5d94-97e8-410f-8ff3-53d8038e908a",
                "planId": 211,
                "siteId": 10000,
                "name": "Comm100 Omnichannel Business",
                "isServicePlan": false,
                "canBeCancelledByCustomer": false,
                "createdTime": "2022-02-17T06:44:51.2766667Z",
                "subscriptionPricingModels": [
                    {
                        "id": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                        "siteId": 10000,
                        "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
                        "name": "Omnichannel business",
                        "pricingModel": "perAgent",
                        "freeQuantity": 0,
                        "maxQuantity": 500,
                        "unitType": "additionalTwitterAccount",
                        "volumeType": "botActionPerMonth",
                        "isServiceStoppedWhenBotActionsQuotaExceeded": false,
                        "purchasedQuantity": 0,
                        "purchasedOverageQuantity": 0,
                        "subscriptionPriceSegmentByAgents": [
                            {
                                "id": "e7796bab-7c5f-4ca7-a9b6-1ef97aeb6091",
                                "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                                "siteId": 10000,
                                "from": 1,
                                "to": 5,
                                "monthlyPrice": 89.00,
                                "quarterlyPrice": 267.00,
                                "semiAnnualPrice": 534.00,
                                "annualPrice": 979.00,
                                "monthlyPriceDiscount": 0.10,
                                "quarterlyPriceDiscount": 0.00,
                                "semiAnnualPriceDiscount": 0.00,
                                "annualPriceDiscount": 0.00
                            }
                        ],
                        "subscriptionPriceSegmentByVolumes": [
                            {
                                "id": "8a206344-4b07-4e3f-b736-aa6f1b922858",
                                "subscriptionPricingModelId": "add5cdab-9566-4140-f6c7-08da12bc6f77",
                                "siteId": 10000,
                                "quotaPerMonth": 10000,
                                "monthlyPrice": 0.00,
                                "quarterlyPrice": 0.00,
                                "semiAnnualPrice": 0.00,
                                "annualPrice": 0.00,
                                "isOverageQuotaAddedByCustomerAllowed": false,
                                "overageQuota": 2500,
                                "overageUnitPrice": 49.00,
                                "monthlyPriceDiscount": 0.00,
                                "quarterlyPriceDiscount": 0.00,
                                "semiAnnualPriceDiscount": 0.00,
                                "annualPriceDiscount": 0.00,
                                "overageUnitPriceDiscount": 0.00
                            }
                        ],
                        "subscriptionPriceWithFlatFee": {
                            "subscriptionPricingModelId": "68d961ca-865f-4557-f6c8-08da12bc6f77",
                            "siteId": 10000,
                            "monthlyPrice": 599.00,
                            "quarterlyPrice": 1198.00,
                            "semiAnnualPrice": 3594.00,
                            "annualPrice": 7188.00,
                            "monthlyPriceDiscount": 0.00,
                            "quarterlyPriceDiscount": 0.00,
                            "semiAnnualPriceDiscount": 0.00,
                            "annualPriceDiscount": 0.00
                        }
                    }
                ]
            }
        ],
        "siteRegistration": {
            "siteId": 10000,
            "registerEmail": "test1@internal.com",
            "registerTime": "2021-03-31T06:05:15.28Z"
        }
    }
]

Get a site

GET /api/billing/sites/{id}

• Parameters

Path Parameters

• Response

  The response is a Site object.

• Example

Using curl

curl  https://partner.comm100.io/api/billing/sites/10000 \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "id": 10000,
    "partnerId": 10000,
    "platformId": 100,
    "company": "",
    "companySize": "",
    "website": "",
    "phone": "",
    "fax": "",
    "countryOrRegion": "Bosnia and Herzegovina",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "",
    "postalOrZipCode": "",
    "firstName": "test1",
    "lastName": "internal",
    "dateTimeFormat": "MM/DD/YYYY HH:mm:ss",
    "languageId": "en",
    "timeZone": "UTC-08",
    "status": "open",
    "subdomain": "",
    "customDomain": "",
    "industry": "Others",
    "otherIndustryDescription": "",
    "tagIds": [
        "fe53fe17-bd77-42c7-8cc0-278422bd89d6"
    ],
    "tags": [
        {
            "id": "fe53fe17-bd77-42c7-8cc0-278422bd89d6",
            "partnerId": 10000,
            "name": "Free Email Not Allowed"
        }          
    ],
    "siteAgents": [
        {
            "id": "1ce38293-786b-4452-90a0-54adb3d31204",
            "siteId": 10000,
            "email": "test1@internal.com",
            "displayName": "test1 internal",
            "firstName": "test1",
            "lastName": "internal",
            "isAdmin": true,
            "isActive": true,
            "createdTime": "2022-02-17T06:44:51.3966667Z"
        }
    ],
    "siteContracts": [
        {
            "id": "8d33378a-5a12-49f4-aa2a-bcb2fddf5ab6",
            "siteId": 100000001,
            "name": "re",
            "description": "1",
            "startDate": "2022-02-03T08:21:19Z",
            "endDate": "2022-02-16T08:21:20Z",
            "actionWhenContractEnds": "stopService",
            "siteContractAttachments": [
                {
                    "id": "f7fe4f76-ecf9-4ed7-adb3-46187577744e",
                    "siteId": 100000001,
                    "sitecontractId": "8d33378a-5a12-49f4-aa2a-bcb2fddf5ab6",
                    "name": "desk.jpeg",
                    "attachment": "https://partner.comm100.io/api/billing/siteContractAttachments/f7fe4f76-ecf9-4ed7-adb3-46187577744e/attachment?siteId=10000&version=32b7b8b1af4bc663983f01100363da4a"
                }
            ]
        }
    ],
    "siteExtraInfo": {
        "siteId": 10000,
        "profitCenterId": "02000000-0000-0000-0000-271000002710",
        "deploymentType": "Shared",
        "accountExecutive": "00000000-0000-0000-0000-000000000000",
        "accountManager": "00000000-0000-0000-0000-000000000000",
        "isSandboxSite": false,
        "isSpam": false
    },
    "siteActivity": {
        "siteId": 10000,
        "lastLoginTime": "2022-04-07T08:58:28.9447384Z",
        "isActive": false,
        "livechatCustomerLastWebPageVisitTime": null,
        "livechatCustomerLastWebPageUrl": ""
    },
    "siteBillingConfig": {
        "siteId": 10000,
        "billingPeriod": "annual",
        "billingStartDate": "2022-03-04T00:00:00Z",
        "nextBillingDate": "2023-03-04T00:00:00Z",
        "balance": 0.00,
        "currencyId": "USD",
        "isPricingVisible": false,
        "isSubscriptionChangeByCustomerAllowed": false,
        "isAgentsPurchasedInAdvance": true,
        "purchasedAgents": 5,
        "isInvoiceVisibleToCustomer": false,
        "isBillingEmailSentAutomatically": false,
        "isBillingPopupAutomatically": false,
        "paymentTerm": "net0",
        "paymentTermValue": 0,
        "currency": {
            "id": "USD",
            "symbol": "$",
            "description": ""
        }
    },
    "siteBillingActivity": {
        "siteId": 10000,
        "buyingStage": "paying"
    },
    "subscriptions": [
        {
            "id": "895a5d94-97e8-410f-8ff3-53d8038e908a",
            "planId": 211,
            "siteId": 10000,
            "name": "Comm100 Omnichannel Business",
            "isServicePlan": false,
            "canBeCancelledByCustomer": false,
            "createdTime": "2022-02-17T06:44:51.2766667Z",
            "subscriptionPricingModels": [
                {
                    "id": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                    "siteId": 10000,
                    "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
                    "name": "Omnichannel business",
                    "pricingModel": "perAgent",
                    "freeQuantity": 0,
                    "maxQuantity": 500,
                    "unitType": "additionalTwitterAccount",
                    "volumeType": "botActionPerMonth",
                    "isServiceStoppedWhenBotActionsQuotaExceeded": false,
                    "purchasedQuantity": 0,
                    "purchasedOverageQuantity": 0,
                    "subscriptionPriceSegmentByAgents": [
                        {
                            "id": "e7796bab-7c5f-4ca7-a9b6-1ef97aeb6091",
                            "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                            "siteId": 10000,
                            "from": 1,
                            "to": 5,
                            "monthlyPrice": 89.00,
                            "quarterlyPrice": 267.00,
                            "semiAnnualPrice": 534.00,
                            "annualPrice": 979.00,
                            "monthlyPriceDiscount": 0.10,
                            "quarterlyPriceDiscount": 0.00,
                            "semiAnnualPriceDiscount": 0.00,
                            "annualPriceDiscount": 0.00
                        }
                    ],
                    "subscriptionPriceSegmentByVolumes": [
                        {
                            "id": "8a206344-4b07-4e3f-b736-aa6f1b922858",
                            "subscriptionPricingModelId": "add5cdab-9566-4140-f6c7-08da12bc6f77",
                            "siteId": 10000,
                            "quotaPerMonth": 10000,
                            "monthlyPrice": 0.00,
                            "quarterlyPrice": 0.00,
                            "semiAnnualPrice": 0.00,
                            "annualPrice": 0.00,
                            "isOverageQuotaAddedByCustomerAllowed": false,
                            "overageQuota": 2500,
                            "overageUnitPrice": 49.00,
                            "monthlyPriceDiscount": 0.00,
                            "quarterlyPriceDiscount": 0.00,
                            "semiAnnualPriceDiscount": 0.00,
                            "annualPriceDiscount": 0.00,
                            "overageUnitPriceDiscount": 0.00
                        }
                    ],
                    "subscriptionPriceWithFlatFee": {
                        "subscriptionPricingModelId": "68d961ca-865f-4557-f6c8-08da12bc6f77",
                        "siteId": 10000,
                        "monthlyPrice": 599.00,
                        "quarterlyPrice": 1198.00,
                        "semiAnnualPrice": 3594.00,
                        "annualPrice": 7188.00,
                        "monthlyPriceDiscount": 0.00,
                        "quarterlyPriceDiscount": 0.00,
                        "semiAnnualPriceDiscount": 0.00,
                        "annualPriceDiscount": 0.00
                    }
                }
            ]
        }
    ],
    "siteRegistration": {
        "siteId": 10000,
        "registerEmail": "test1@internal.com",
        "registerTime": "2021-03-31T06:05:15.28Z"
    }
}

Site Billing Config

You need the Manage Site permission to manage site billing config.

• GET /api/billing/siteBillingConfigs - Get the list of site billing configs
• GET /api/billing/siteBillingConfigs/{siteId} - Get billing config of a site
• POST /api/billing/siteBillingConfigs - Create billing config of a site
• PUT /api/billing/siteBillingConfigs/{siteId} - Update billing configs of a site

Site Billing Config Object JSON format

Site Billing Config Object

SiteBillingConfig definition.

Currency Object

Currency definition.

Site Endpoints

Get the list of site billing configs

GET /api/billing/siteBillingConfigs

• Parameters

  No parameters

• Response

  The response is collection of SiteBillingConfig objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingConfigs \
-H 'Content-Type: application/json' \
-X 'GET' \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "siteId": 10000,
        "billingPeriod": "annual",
        "billingStartDate": "2022-03-04T00:00:00Z",
        "nextBillingDate": "2023-03-04T00:00:00Z",
        "balance": 0.00,
        "currencyId": "USD",
        "isPricingVisible": false,
        "isSubscriptionChangeByCustomerAllowed": false,
        "isAgentsPurchasedInAdvance": true,
        "purchasedAgents": 5,
        "isInvoiceVisibleToCustomer": false,
        "isBillingEmailSentAutomatically": false,
        "isBillingPopupAutomatically": false,
        "paymentTerm": "net0",
        "paymentTermValue": 0,
        "currency": {
            "id": "USD",
            "symbol": "$",
            "description": ""
        }
    }
]

Get billing config of a site

GET /api/billing/siteBillingConfigs/{siteId}

• Parameters

Path Parameters

• Response

  The response is SiteBillingConfig object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingConfigs/10000 \
-H 'Content-Type: application/json' \
-X 'GET' \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "siteId": 10000,
    "billingPeriod": "annual",
    "billingStartDate": "2022-03-04T00:00:00Z",
    "nextBillingDate": "2023-03-04T00:00:00Z",
    "balance": 0.00,
    "currencyId": "USD",
    "isPricingVisible": false,
    "isSubscriptionChangeByCustomerAllowed": false,
    "isAgentsPurchasedInAdvance": true,
    "purchasedAgents": 5,
    "isInvoiceVisibleToCustomer": false,
    "isBillingEmailSentAutomatically": false,
    "isBillingPopupAutomatically": false,
    "paymentTerm": "net0",
    "paymentTermValue": 0,
    "currency": {
        "id": "USD",
        "symbol": "$",
        "description": ""
    }
}

Create billing config of a site

POST /api/billing/siteBillingConfigs

• Parameters

Request body

The request body contains data with the SiteBillingConfig structure.

• Response

  The response is the SiteBillingConfig Object.

• Example

Using curl

curl  https://partner.comm100.io/api/billing/siteBillingConfigs \
-H 'Content-Type: application/json' \
-X 'POST'  \
-D '{
    "siteId": 10000,
    "billingPeriod": "annual",
    "currencyId": "USD",
    "isPricingVisible": false,
    "isSubscriptionChangeByCustomerAllowed": false,
    "isAgentsPurchasedInAdvance": true,
    "isInvoiceVisibleToCustomer": false,
    "isBillingEmailSentAutomatically": false,
    "isBillingPopupAutomatically": false,
    "paymentTerm": "net0",
    "paymentTermValue": 0,
    ...,
}' 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "siteId": 10000,
    "billingPeriod": "annual",
    "billingStartDate": "2022-03-04T00:00:00Z",
    "nextBillingDate": "2023-03-04T00:00:00Z",
    "balance": 0.00,
    "currencyId": "USD",
    "isPricingVisible": false,
    "isSubscriptionChangeByCustomerAllowed": false,
    "isAgentsPurchasedInAdvance": true,
    "purchasedAgents": 5,
    "isInvoiceVisibleToCustomer": false,
    "isBillingEmailSentAutomatically": false,
    "isBillingPopupAutomatically": false,
    "paymentTerm": "net0",
    "paymentTermValue": 0,
    "currency": {
        "id": "USD",
        "symbol": "$",
        "description": ""
    }
}

Update billing config of a site

PUT /api/billing/siteBillingConfigs/{siteId}

• Parameters

Path Parameters

Request body

The request body contains data with the SiteBillingConfig structure.

• Response

  The response is the SiteBillingConfig Object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingConfigs/10000 \
-H 'Content-Type: application/json'  \
-X 'POST' \
-D '{
    "siteId": 10000,
    "billingPeriod": "annual",
    "currencyId": "USD",
    "isPricingVisible": false,
    "isSubscriptionChangeByCustomerAllowed": false,
    "isAgentsPurchasedInAdvance": true,
    "isInvoiceVisibleToCustomer": false,
    "isBillingEmailSentAutomatically": false,
    "isBillingPopupAutomatically": false,
    "paymentTerm": "net0",
    "paymentTermValue": 0,
    ...,
}' 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "siteId": 10000,
    "billingPeriod": "annual",
    "billingStartDate": "2022-03-04T00:00:00Z",
    "nextBillingDate": "2023-03-04T00:00:00Z",
    "balance": 0.00,
    "currencyId": "USD",
    "isPricingVisible": false,
    "isSubscriptionChangeByCustomerAllowed": false,
    "isAgentsPurchasedInAdvance": true,
    "purchasedAgents": 5,
    "isInvoiceVisibleToCustomer": false,
    "isBillingEmailSentAutomatically": false,
    "isBillingPopupAutomatically": false,
    "paymentTerm": "net0",
    "paymentTermValue": 0,
    "currency": {
        "id": "USD",
        "symbol": "$",
        "description": ""
    }
}

Site Billing Profile

You need the Manage Site permission to manage site billing profile.

• GET /api/billing/siteBillingProfiles - Get a list of site billing profiles
• GET /api/billing/siteBillingProfiles/{siteId} - Get billing profile of a site
• POST /api/billing/siteBillingProfiles - Create billing profile of a site
• PUT /api/billing/siteBillingProfiles/{siteId} - Update billing profile of a site

Site Billing Profile Object JSON format

Site Billing Profile Object

SiteBillingProfile definition.

Site Endpoints

Get sites' billing profiles

GET /api/billing/siteBillingProfiles

• Parameters

  No parameters

• Response

  The response is collection of SiteBillingProfile objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingProfiles \
-H 'Content-Type: application/json'  \
-X 'GET' \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "siteId": 10000,
        "firstName": "1",
        "lastName": "1",
        "companyName": "1",
        "email": "1@1.com",
        "phone": "13111111111",
        "fax": "",
        "countryOrRegion": "Afghanistan",
        "stateOrProvince": "",
        "city": "",
        "mailingAddress": "1",
        "postalOrZipCode": "",
        "jobTitle": "",
        "billTo": "1",
        "isChargedAutomatically": true,
        "isEPayment": true,
        "primaryPaymentTypeId": "Amex",
        "primaryPayPalBillingAgreementId": "",
        "primaryPayPalEmail": "",
        "nameOnPrimaryCard": "1",
        "primaryCardNumber": "2222222222222",
        "primaryCardCSCOrCVD": "123",
        "primaryCardExpirationDate": "2024-12-01T00:00:00Z",
        "secondaryPaymentTypeId": "Amex",
        "secondaryPayPalBillingAgreementId": "",
        "secondaryPayPalEmail": "",
        "nameOnSecondaryCard": "2",
        "secondaryCardNumber": "2222222222222",
        "secondaryCardCSCOrCVD": "123",
        "secondaryCardExpirationDate": "2024-12-01T00:00:00Z",
        "nonEPaymentTypeId": "Undefine"
    }
]

Get billing profile of a site

GET /api/billing/siteBillingProfiles/{siteId}

• Parameters

Path Parameters

• Response

  The response is SiteBillingProfile object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingProfiles/10000
-H 'Content-Type: application/json'
-X 'GET'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "siteId": 10000,
    "firstName": "1",
    "lastName": "1",
    "companyName": "1",
    "email": "1@1.com",
    "phone": "13111111111",
    "fax": "",
    "countryOrRegion": "Afghanistan",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "1",
    "postalOrZipCode": "",
    "jobTitle": "",
    "billTo": "1",
    "isChargedAutomatically": true,
    "isEPayment": true,
    "primaryPaymentTypeId": "Amex",
    "primaryPayPalBillingAgreementId": "",
    "primaryPayPalEmail": "",
    "nameOnPrimaryCard": "1",
    "primaryCardNumber": "2222222222222",
    "primaryCardCSCOrCVD": "123",
    "primaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "secondaryPaymentTypeId": "Amex",
    "secondaryPayPalBillingAgreementId": "",
    "secondaryPayPalEmail": "",
    "nameOnSecondaryCard": "2",
    "secondaryCardNumber": "2222222222222",
    "secondaryCardCSCOrCVD": "123",
    "secondaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "nonEPaymentTypeId": "Undefine"
}

Create billing profile of a site

POST /api/billing/siteBillingProfiles

• Parameters

Request body

The request body contains data with the SiteBillingProfile structure.

• Response

  The response is the SiteBillingProfile Object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingProfiles \
-H 'Content-Type: application/json'  \
-X 'POST' \
-D '{
    "siteId": 10000,
    "firstName": "1",
    "lastName": "1",
    "companyName": "1",
    "email": "1@1.com",
    "phone": "13111111111",
    "fax": "",
    "countryOrRegion": "Afghanistan",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "1",
    "postalOrZipCode": "",
    "jobTitle": "",
    "billTo": "1",
    "isChargedAutomatically": true,
    "isEPayment": true,
    "primaryPaymentTypeId": "Amex",
    "primaryPayPalBillingAgreementId": "",
    "primaryPayPalEmail": "",
    "nameOnPrimaryCard": "1",
    "primaryCardNumber": "2222222222222",
    "primaryCardCSCOrCVD": "123",
    "primaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "secondaryPaymentTypeId": "Amex",
    "secondaryPayPalBillingAgreementId": "",
    "secondaryPayPalEmail": "",
    "nameOnSecondaryCard": "2",
    "secondaryCardNumber": "2222222222222",
    "secondaryCardCSCOrCVD": "123",
    "secondaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "nonEPaymentTypeId": "Undefine"
    ...,
}'  

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "siteId": 10000,
    "firstName": "1",
    "lastName": "1",
    "companyName": "1",
    "email": "1@1.com",
    "phone": "13111111111",
    "fax": "",
    "countryOrRegion": "Afghanistan",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "1",
    "postalOrZipCode": "",
    "jobTitle": "",
    "billTo": "1",
    "isChargedAutomatically": true,
    "isEPayment": true,
    "primaryPaymentTypeId": "Amex",
    "primaryPayPalBillingAgreementId": "",
    "primaryPayPalEmail": "",
    "nameOnPrimaryCard": "1",
    "primaryCardNumber": "2222222222222",
    "primaryCardCSCOrCVD": "123",
    "primaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "secondaryPaymentTypeId": "Amex",
    "secondaryPayPalBillingAgreementId": "",
    "secondaryPayPalEmail": "",
    "nameOnSecondaryCard": "2",
    "secondaryCardNumber": "2222222222222",
    "secondaryCardCSCOrCVD": "123",
    "secondaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "nonEPaymentTypeId": "Undefine"
}

Update billing profile of a site

PUT /api/billing/siteBillingProfiles/{siteId}

• Parameters

Path Parameters

Request body

The request body contains data with the SiteBillingProfile structure.

• Response

  The response is the SiteBillingProfile Object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/siteBillingProfiles/10000 \
-H "Content-Type: application/json"  \
-X 'POST' \
-D '{
    "siteId": 10000,
    "firstName": "1",
    "lastName": "1",
    "companyName": "1",
    "email": "1@1.com",
    "phone": "13111111111",
    "fax": "",
    "countryOrRegion": "Afghanistan",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "1",
    "postalOrZipCode": "",
    "jobTitle": "",
    "billTo": "1",
    "isChargedAutomatically": true,
    "isEPayment": true,
    "primaryPaymentTypeId": "Amex",
    "primaryPayPalBillingAgreementId": "",
    "primaryPayPalEmail": "",
    "nameOnPrimaryCard": "1",
    "primaryCardNumber": "2222222222222",
    "primaryCardCSCOrCVD": "123",
    "primaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "secondaryPaymentTypeId": "Amex",
    "secondaryPayPalBillingAgreementId": "",
    "secondaryPayPalEmail": "",
    "nameOnSecondaryCard": "2",
    "secondaryCardNumber": "2222222222222",
    "secondaryCardCSCOrCVD": "123",
    "secondaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "nonEPaymentTypeId": "Undefine"
    ...,
}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "siteId": 10000,
    "firstName": "1",
    "lastName": "1",
    "companyName": "1",
    "email": "1@1.com",
    "phone": "13111111111",
    "fax": "",
    "countryOrRegion": "Afghanistan",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "1",
    "postalOrZipCode": "",
    "jobTitle": "",
    "billTo": "1",
    "isChargedAutomatically": true,
    "isEPayment": true,
    "primaryPaymentTypeId": "Amex",
    "primaryPayPalBillingAgreementId": "",
    "primaryPayPalEmail": "",
    "nameOnPrimaryCard": "1",
    "primaryCardNumber": "2222222222222",
    "primaryCardCSCOrCVD": "123",
    "primaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "secondaryPaymentTypeId": "Amex",
    "secondaryPayPalBillingAgreementId": "",
    "secondaryPayPalEmail": "",
    "nameOnSecondaryCard": "2",
    "secondaryCardNumber": "2222222222222",
    "secondaryCardCSCOrCVD": "123",
    "secondaryCardExpirationDate": "2024-12-01T00:00:00Z",
    "nonEPaymentTypeId": "Undefine"
}

Subscription

You need the Manage Site permission to manage Site's subscriptions.

• GET /api/billing/subscriptions - Get collection of subscriptions
• GET /api/billing/subscriptions/{id} - Get a subscription
• GET /api/billing/subscriptions/{id} - Update a subscription
• POST /api/billing/subscriptions:new - Add a subscription
• POST /api/billing/subscriptions:calculateNew - Preview adding a subscription
• POST /api/billing/subscriptions:changes - Change subscriptions
• POST /api/billing/subscriptions/{id}:cancel - Cancel a subscriptions
• POST /api/billing/subscriptions/{id}:calculateCancel - Preview cancelling a subscriptions
• POST /api/billing/subscriptions/{id}:switchPlan - Switch a subscription plan
• POST /api/billing/subscriptions/{id}:calculateSwitchPlan - Preview switching a subscription plan
• POST /api/billing/subscriptions/{id}/productFeaturePoints - Add product feature points to a subscription

Subscription Object JSON format

Subscription Object

Subscription definition.

Subscription Output Object

SubscriptionOutput definition.

Subscription Change Dto Object

SubscriptionChangeDto definition.

Subscription Dto Object

SubscriptionDto definition.

Subscription Pricing Model Dto Object

SubscriptionPricingModelDto definition.

Subscription Price Segment By Agent Dto Object

SubscriptionPriceSegmentByAgentDto definition.

Subscription Price Segment By Volume Dto Object

SubscriptionPriceSegmentByVolumnDto definition.

Subscription Price By Unit Dto Object

SubscriptionPriceByUnitDto definition.

Subscription Price With Flat Fee Dto Object

SubscriptionPriceWithFlatFeeDto definition.

Subscriptions Change Output Object

SubscriptionsChangeOutput definition.

Invoice Line Item Object

InvoiceLineItem definition

Subscription Endpoints

Get collection of subscriptions

GET /api/billing/subscriptions

• Parameters

Query Parameters

• Response

  The response is collection of Subscription objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": "895a5d94-97e8-410f-8ff3-53d8038e908a",
        "planId": 211,
        "siteId": 10000,
        "name": "Comm100 Omnichannel Business",
        "isServicePlan": false,
        "canBeCancelledByCustomer": false,
        "createdTime": "2022-02-17T06:44:51.2766667Z",,
        "isShowUpgrade": false,
        "isOneTimeFeePlan": false,
        "isShowCancel": false
        "subscriptionPricingModels": [
            {
                "id": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                "siteId": 10000,
                "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
                "name": "Omnichannel business",
                "pricingModel": "perAgent",
                "freeQuantity": 0,
                "maxQuantity": 500,
                "unitType": "additionalTwitterAccount",
                "volumeType": "botActionPerMonth",
                "isServiceStoppedWhenBotActionsQuotaExceeded": false,
                "purchasedQuantity": 0,
                "purchasedOverageQuantity": 0,
                "subscriptionPriceSegmentByAgents": [
                    {
                        "id": "e7796bab-7c5f-4ca7-a9b6-1ef97aeb6091",
                        "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                        "siteId": 10000,
                        "from": 1,
                        "to": 5,
                        "monthlyPrice": 89.00,
                        "quarterlyPrice": 267.00,
                        "semiAnnualPrice": 534.00,
                        "annualPrice": 979.00,
                        "monthlyPriceDiscount": 0.10,
                        "quarterlyPriceDiscount": 0.00,
                        "semiAnnualPriceDiscount": 0.00,
                        "annualPriceDiscount": 0.00
                    }
                ],
                "subscriptionPriceSegmentByVolumes": [
                    {
                        "id": "8a206344-4b07-4e3f-b736-aa6f1b922858",
                        "subscriptionPricingModelId": "add5cdab-9566-4140-f6c7-08da12bc6f77",
                        "siteId": 10000,
                        "quotaPerMonth": 10000,
                        "monthlyPrice": 0.00,
                        "quarterlyPrice": 0.00,
                        "semiAnnualPrice": 0.00,
                        "annualPrice": 0.00,
                        "isOverageQuotaAddedByCustomerAllowed": false,
                        "overageQuota": 2500,
                        "overageUnitPrice": 49.00,
                        "monthlyPriceDiscount": 0.00,
                        "quarterlyPriceDiscount": 0.00,
                        "semiAnnualPriceDiscount": 0.00,
                        "annualPriceDiscount": 0.00,
                        "overageUnitPriceDiscount": 0.00,
                        "isSelected": true
                    }
                ],
                "subscriptionPriceWithFlatFee": {
                    "subscriptionPricingModelId": "68d961ca-865f-4557-f6c8-08da12bc6f77",
                    "siteId": 10000,
                    "monthlyPrice": 599.00,
                    "quarterlyPrice": 1198.00,
                    "semiAnnualPrice": 3594.00,
                    "annualPrice": 7188.00,
                    "monthlyPriceDiscount": 0.00,
                    "quarterlyPriceDiscount": 0.00,
                    "semiAnnualPriceDiscount": 0.00,
                    "annualPriceDiscount": 0.00
                }
            }
        ],
        "lineItems": [
            {
                "id": "00000000-0000-0000-0000-000000000000",
                "invoiceId": "00000000-0000-0000-0000-000000000000",
                "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                "profitCenterId": "02000000-0000-0000-0000-271000002710",
                "siteId": 0,
                "name": "Comm100 Omnichannel Business - Omnichannel business",
                "unitPrice": 979.00,
                "unitPriceToRound": "979.00",
                "unitPriceToRoundWithUnit": "979.00/Year",
                "unit": "Year",
                "quantity": 5,
                "discount": 0.0000,
                "discountToRound": "0.00",
                "discountRate": "",
                "serviceStartDate": "2022-04-15T00:00:00Z",
                "serviceEndDate": "2023-04-14T00:00:00Z",
                "months": "12 Months",
                "licenseTerm": "12 Months<br><span>(2022/04/15-2023/04/14)</span>",
                "order": 0,
                "type": "changeSiteBillingPeriod",
                "isDeleted": false,
                "invoiceLineItemTaxs": [],
                "amount": 4895.0000,
                "amountToRound": "4,895.00",
                "taxTotal": 0.0,
                "tax": 0.0,
                "taxToRound": "0.00",
                "lineTotal": 4895.0000,
                "lineTotalToRound": "4,895.00",
                "lineTotalWithDiscountToRound": "4,895.00",
                "cancelledInvoiceLineItemId": "00000000-0000-0000-0000-000000000000",
                "paidAmount": 0.0,
                "amountUsdToPay": 0.0,
                "amountUsdToRefund": 0.0,
                "serviceDays": 365
            }
        ]
    }
]

Get a subscription

GET /api/billing/subscriptions/{id}

• Parameters

Path Parameters

• Response

  The response is Subscription object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions/895a5d94-97e8-410f-8ff3-53d8038e908a \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "id": "895a5d94-97e8-410f-8ff3-53d8038e908a",
    "planId": 211,
    "siteId": 10000,
    "name": "Comm100 Omnichannel Business",
    "isServicePlan": false,
    "canBeCancelledByCustomer": false,
    "createdTime": "2022-02-17T06:44:51.2766667Z",,
    "isShowUpgrade": false,
    "isOneTimeFeePlan": false,
    "isShowCancel": false
    "subscriptionPricingModels": [
        {
            "id": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
            "siteId": 10000,
            "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
            "name": "Omnichannel business",
            "pricingModel": "perAgent",
            "freeQuantity": 0,
            "maxQuantity": 500,
            "unitType": "additionalTwitterAccount",
            "volumeType": "botActionPerMonth",
            "isServiceStoppedWhenBotActionsQuotaExceeded": false,
            "purchasedQuantity": 0,
            "purchasedOverageQuantity": 0,
            "subscriptionPriceSegmentByAgents": [
                {
                    "id": "e7796bab-7c5f-4ca7-a9b6-1ef97aeb6091",
                    "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                    "siteId": 10000,
                    "from": 1,
                    "to": 5,
                    "monthlyPrice": 89.00,
                    "quarterlyPrice": 267.00,
                    "semiAnnualPrice": 534.00,
                    "annualPrice": 979.00,
                    "monthlyPriceDiscount": 0.10,
                    "quarterlyPriceDiscount": 0.00,
                    "semiAnnualPriceDiscount": 0.00,
                    "annualPriceDiscount": 0.00
                }
            ],
            "subscriptionPriceSegmentByVolumes": [
                {
                    "id": "8a206344-4b07-4e3f-b736-aa6f1b922858",
                    "subscriptionPricingModelId": "add5cdab-9566-4140-f6c7-08da12bc6f77",
                    "siteId": 10000,
                    "quotaPerMonth": 10000,
                    "monthlyPrice": 0.00,
                    "quarterlyPrice": 0.00,
                    "semiAnnualPrice": 0.00,
                    "annualPrice": 0.00,
                    "isOverageQuotaAddedByCustomerAllowed": false,
                    "overageQuota": 2500,
                    "overageUnitPrice": 49.00,
                    "monthlyPriceDiscount": 0.00,
                    "quarterlyPriceDiscount": 0.00,
                    "semiAnnualPriceDiscount": 0.00,
                    "annualPriceDiscount": 0.00,
                    "overageUnitPriceDiscount": 0.00,
                    "isSelected": true
                }
            ],
            "subscriptionPriceWithFlatFee": {
                "subscriptionPricingModelId": "68d961ca-865f-4557-f6c8-08da12bc6f77",
                "siteId": 10000,
                "monthlyPrice": 599.00,
                "quarterlyPrice": 1198.00,
                "semiAnnualPrice": 3594.00,
                "annualPrice": 7188.00,
                "monthlyPriceDiscount": 0.00,
                "quarterlyPriceDiscount": 0.00,
                "semiAnnualPriceDiscount": 0.00,
                "annualPriceDiscount": 0.00
            }
        }
    ],
    "lineItems": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "invoiceId": "00000000-0000-0000-0000-000000000000",
            "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
            "profitCenterId": "02000000-0000-0000-0000-271000002710",
            "siteId": 0,
            "name": "Comm100 Omnichannel Business - Omnichannel business",
            "unitPrice": 979.00,
            "unitPriceToRound": "979.00",
            "unitPriceToRoundWithUnit": "979.00/Year",
            "unit": "Year",
            "quantity": 5,
            "discount": 0.0000,
            "discountToRound": "0.00",
            "discountRate": "",
            "serviceStartDate": "2022-04-15T00:00:00Z",
            "serviceEndDate": "2023-04-14T00:00:00Z",
            "months": "12 Months",
            "licenseTerm": "12 Months<br><span>(2022/04/15-2023/04/14)</span>",
            "order": 0,
            "type": "changeSiteBillingPeriod",
            "isDeleted": false,
            "invoiceLineItemTaxs": [],
            "amount": 4895.0000,
            "amountToRound": "4,895.00",
            "taxTotal": 0.0,
            "tax": 0.0,
            "taxToRound": "0.00",
            "lineTotal": 4895.0000,
            "lineTotalToRound": "4,895.00",
            "lineTotalWithDiscountToRound": "4,895.00",
            "cancelledInvoiceLineItemId": "00000000-0000-0000-0000-000000000000",
            "paidAmount": 0.0,
            "amountUsdToPay": 0.0,
            "amountUsdToRefund": 0.0,
            "serviceDays": 365
        }
    ]
}

Update a subscription

PUT /api/billing/subscriptions/{id}

• Parameters

Path Parameters

Request body

The request body contains data with the Subscription structure.

• Response

  The response is Subscription object.

• Example

Using curl

curl  https://partner.comm100.io/api/billing/subscriptions/895a5d94-97e8-410f-8ff3-53d8038e908a \
-H 'Content-Type: application/json'  \
-X 'PUT'  \
-D '{    
  "name": "Comm100 Omnichannel Business",
  "isServicePlan": false,
  "canBeCancelledByCustomer": false,
  "isShowUpgrade": false,
  "isOneTimeFeePlan": false,
  "isShowCancel": false,
  ...
}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "id": "895a5d94-97e8-410f-8ff3-53d8038e908a",
    "planId": 211,
    "siteId": 10000,
    "name": "Comm100 Omnichannel Business",
    "isServicePlan": false,
    "canBeCancelledByCustomer": false,
    "createdTime": "2022-02-17T06:44:51.2766667Z",
    "isShowUpgrade": false,
    "isOneTimeFeePlan": false,
    "isShowCancel": false
    "subscriptionPricingModels": [
        {
            "id": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
            "siteId": 10000,
            "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
            "name": "Omnichannel business",
            "pricingModel": "perAgent",
            "freeQuantity": 0,
            "maxQuantity": 500,
            "unitType": "additionalTwitterAccount",
            "volumeType": "botActionPerMonth",
            "isServiceStoppedWhenBotActionsQuotaExceeded": false,
            "purchasedQuantity": 0,
            "purchasedOverageQuantity": 0,
            "subscriptionPriceSegmentByAgents": [
                {
                    "id": "e7796bab-7c5f-4ca7-a9b6-1ef97aeb6091",
                    "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
                    "siteId": 10000,
                    "from": 1,
                    "to": 5,
                    "monthlyPrice": 89.00,
                    "quarterlyPrice": 267.00,
                    "semiAnnualPrice": 534.00,
                    "annualPrice": 979.00,
                    "monthlyPriceDiscount": 0.10,
                    "quarterlyPriceDiscount": 0.00,
                    "semiAnnualPriceDiscount": 0.00,
                    "annualPriceDiscount": 0.00
                }
            ],
            "subscriptionPriceSegmentByVolumes": [
                {
                    "id": "8a206344-4b07-4e3f-b736-aa6f1b922858",
                    "subscriptionPricingModelId": "add5cdab-9566-4140-f6c7-08da12bc6f77",
                    "siteId": 10000,
                    "quotaPerMonth": 10000,
                    "monthlyPrice": 0.00,
                    "quarterlyPrice": 0.00,
                    "semiAnnualPrice": 0.00,
                    "annualPrice": 0.00,
                    "isOverageQuotaAddedByCustomerAllowed": false,
                    "overageQuota": 2500,
                    "overageUnitPrice": 49.00,
                    "monthlyPriceDiscount": 0.00,
                    "quarterlyPriceDiscount": 0.00,
                    "semiAnnualPriceDiscount": 0.00,
                    "annualPriceDiscount": 0.00,
                    "overageUnitPriceDiscount": 0.00,
                    "isSelected": true
                }
            ],
            "subscriptionPriceWithFlatFee": {
                "subscriptionPricingModelId": "68d961ca-865f-4557-f6c8-08da12bc6f77",
                "siteId": 10000,
                "monthlyPrice": 599.00,
                "quarterlyPrice": 1198.00,
                "semiAnnualPrice": 3594.00,
                "annualPrice": 7188.00,
                "monthlyPriceDiscount": 0.00,
                "quarterlyPriceDiscount": 0.00,
                "semiAnnualPriceDiscount": 0.00,
                "annualPriceDiscount": 0.00
            }
        }
    ],
    "lineItems": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "invoiceId": "00000000-0000-0000-0000-000000000000",
            "subscriptionPricingModelId": "35ed9d79-1a5c-418b-b8c1-77c63e7083d7",
            "profitCenterId": "02000000-0000-0000-0000-271000002710",
            "siteId": 0,
            "name": "Comm100 Omnichannel Business - Omnichannel business",
            "unitPrice": 979.00,
            "unitPriceToRound": "979.00",
            "unitPriceToRoundWithUnit": "979.00/Year",
            "unit": "Year",
            "quantity": 5,
            "discount": 0.0000,
            "discountToRound": "0.00",
            "discountRate": "",
            "serviceStartDate": "2022-04-15T00:00:00Z",
            "serviceEndDate": "2023-04-14T00:00:00Z",
            "months": "12 Months",
            "licenseTerm": "12 Months<br><span>(2022/04/15-2023/04/14)</span>",
            "order": 0,
            "type": "changeSiteBillingPeriod",
            "isDeleted": false,
            "invoiceLineItemTaxs": [],
            "amount": 4895.0000,
            "amountToRound": "4,895.00",
            "taxTotal": 0.0,
            "tax": 0.0,
            "taxToRound": "0.00",
            "lineTotal": 4895.0000,
            "lineTotalToRound": "4,895.00",
            "lineTotalWithDiscountToRound": "4,895.00",
            "cancelledInvoiceLineItemId": "00000000-0000-0000-0000-000000000000",
            "paidAmount": 0.0,
            "amountUsdToPay": 0.0,
            "amountUsdToRefund": 0.0,
            "serviceDays": 365
        }
    ]
}

Add a subscription

POST /api/billing/subscriptions:new

• Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions:new  \
-H 'Content-Type: application/json' \
-X 'POST'  \
-D '{"billingPeriod": 0, "planId": 10, "overageQuota": 1, "overageQuotaUnit": 1, "purchasedQuantityByUnit": 1, "selectedVolumeId": "895a5d94-97e8-410f-8ff3-53d8038e908a", "name": "name"}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "srcAmount": 211.11,
    "srcTax": 1.00,
    "newAmount": 3.33,
    "newTax": 1.00,
    "chargeResult": true
}

Preview adding a subscription

POST /api/billing/subscriptions:calculateNew

• Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions:calculateNew \
-H 'Content-Type: application/json'  \
-X 'POST' \
-D '{"billingPeriod": 0, "planId": 10, "overageQuota": 1, "overageQuotaUnit": 1, "purchasedQuantityByUnit": 1, "selectedVolumeId": "895a5d94-97e8-410f-8ff3-53d8038e908a", "name": "name"}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "srcAmount": 211.11,
    "srcTax": 1.00,
    "newAmount": 3.33,
    "newTax": 1.00,
    "chargeResult": true
}

Change subscriptions

POST /api/billing/subscriptions:changes

• Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionsChangeOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions:new \
-H 'Content-Type: application/json'  \
-X 'POST'  \
-D '{"ifCreateInvoice": true, "isDraft": false, "purchasedAgents": 1, "subscriptionChangeDtos": []}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "amount": 211.11,
    "tax": 1.00,
    "invoiceId": "d95a5d94-97e8-410f-8ff3-53d8038e908a"
}

Preview changing subscriptions

POST /api/billing/subscriptions:calculateChanges

• Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionsChangeOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions:calculateNew
-H 'Content-Type: application/json' 
-X 'POST'  
-D '{"ifCreateInvoice": false, "isDraft": false, "purchasedAgents": 1, "subscriptionChangeDtos": []}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "amount": 211.11,
    "tax": 1.00,
    "invoiceId": "00000000-0000-0000-0000-000000000000"
}

Cancel a subscription

POST /api/billing/subscriptions:calculateChanges

• Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions/895a5d94-97e8-410f-8ff3-53d8038e908a:cancel \
-H 'Content-Type: application/json' \ 
-X 'POST' \  
-D '{"ifCreateInvoice": false, "isDraft": false, "purchasedAgents": 1, "subscriptionChangeDtos": []}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "amount": 211.11,
    "tax": 1.00,
    "invoiceId": "00000000-0000-0000-0000-000000000000"
}

Preview cancelling a subscription

POST /api/billing/subscriptions/{id}:calculateCancel

• Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions/895a5d94-97e8-410f-8ff3-53d8038e908a:calculateCancel \
-H 'Content-Type: application/json' \
-X 'POST' \  
-D '{"cancelReason": "reason", "comment": "comment"}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "srcAmount": 211.11,
    "srcTax": 1.00,
    "newAmount": 3.33,
    "newTax": 1.00,
    "chargeResult": true
}

Switch a subscription plan

POST /api/billing/subscriptions/{id}:switchPlan

• Parameters

Path Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionOutput object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptions/{id}:switchPlan  \
-H 'Content-Type: application/json'  \
-X 'POST'  \
-D '{"billingPeriod": 0, "planId": 10, "overageQuota": 1, "overageQuotaUnit": 1, "purchasedQuantityByUnit": 1, "selectedVolumeId": "895a5d94-97e8-410f-8ff3-53d8038e908a", "name": "name"}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "srcAmount": 211.11,
    "srcTax": 1.00,
    "newAmount": 3.33,
    "newTax": 1.00,
    "chargeResult": true
}

Preview switching a subscription plan

POST /api/billing/subscriptions/{id}:calculateSwitchPlan

• Parameters

Path Parameters

Query Parameters

Body Parameters

• Response

  The response is SubscriptionOutput object.

• Example

Using curl

curl -H "Content-Type: application/json" -X POST https://partner.comm100.io/api/billing/subscriptions/895a5d94-97e8-410f-8ff3-53d8038e908a:calculateSwitchPlan -D '{"billingPeriod": 0, "planId": 10, "overageQuota": 1, "overageQuotaUnit": 1, "purchasedQuantityByUnit": 1, "selectedVolumeId": "895a5d94-97e8-410f-8ff3-53d8038e908a", "name": "name"}'

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "srcAmount": 211.11,
    "srcTax": 1.00,
    "newAmount": 3.33,
    "newTax": 1.00,
    "chargeResult": true
}

Add product feature points to a subscription

POST /api/billing/subscriptions/{id}/productFeaturePoints

• Parameters

Path Parameters

Query Parameters

Body Parameters

• Response

  No response.

• Example

Using curl

curl -H "Content-Type: application/json" -X POST https://partner.comm100.io/api/billing/subscriptions/895a5d94-97e8-410f-8ff3-53d8038e908a/productFeaturePoints -D '{"productId": "AdditionalTwitterAccount", "featurePointItems": ["AgentAssist"]}'

Response

HTTP/1.1 200 OK

Subscription Product Relation

You need the Manage Feature permission to manage subscription product relation.

• GET /api/billing/subscriptionProductRelations - Get collection of subscription product relations

Subscription Product Relation Object JSON format

Subscription Product Relation Object

SubscriptionProductRelation definition.

Subscription Product Feature Point Relation Object

SubscriptionProductFeaturePointRelation definition.

Subscription Product Relation Endpoints

Get collection of product feature points

GET /api/billing/subscriptionProductRelations

• Parameters

  No parameters

• Response

  The response is collection of SubscriptionProductRelation objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptionProductRelations \
-H 'Content-Type: application/json'  \
-X 'GET' \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": "3fb06039-d671-4c5c-9414-2ca085efb6f8",
        "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
        "productId": "LiveChat",
        "siteId": 10000,
        "subscriptionProductFeaturePointRelations": [
            {
                "id": "b14bfbd0-9c78-4130-bc00-04260bcd4df1",
                "subscriptionProductRelationId": "3fb06039-d671-4c5c-9414-2ca085efb6f8",
                "featurePointItemId": "Integrations",
                "siteId": 10000
            }
        ]
    }
]

Subscription Pricing Model

You need the Manage Feature permission to manage subscription product relation.

• GET /api/billing/subscriptionPricingModels

Subscription Pricing Model Object JSON format

Subscription Pricing Model Object

SubscriptionPricingModel definition.

Subscription Price Segment By Agent Object

SubscriptionPriceSegmentByAgent definition.

Subscription Price Segment By Volume Object

SubscriptionPriceSegmentByVolumn definition.

Subscription Price With Flat Fee Object

SubscriptionPriceWithFlatFee definition.

Subscription Pricing Model Endpoints

Get collection of subscription pricing models

GET /api/billing/subscriptionPricingModels

• Parameters

  No parameters

• Response

  The response is collection of SubscriptionPricingModel objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptionPricingModels \
-H 'Content-Type: application/json'   \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": "3fb06039-d671-4c5c-9414-2ca085efb6f8",
        "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
        "productId": "LiveChat",
        "siteId": 10000,
        "subscriptionProductFeaturePointRelations": [
            {
                "id": "b14bfbd0-9c78-4130-bc00-04260bcd4df1",
                "subscriptionProductRelationId": "3fb06039-d671-4c5c-9414-2ca085efb6f8",
                "featurePointItemId": "Integrations",
                "siteId": 10000
            }
        ]
    }
]

Subscription Feature Limitation Config

You need the Manage Feature permission to manage subscription feature limitation config.

• GET /api/billing/subscriptionFeatureLimitationConfigs - Get collection of subscription feature limitation configs
• GET /api/billing/subscriptionFeatureLimitationConfigs/{subscriptionId} - Get collection of subscription feature limitation configs

Subscription Feature Limitation Config Object JSON format

Subscription Feature Limitation Config Object

SubscriptionFeatureLimitationConfig definition.

Subscription Feature Limitation Config Endpoints

Get collection of subscription feature limitation configs

GET /api/billing/subscriptionFeatureLimitationConfigs

• Parameters

Query Parameters

• Response

  The response is collection of SubscriptionFeatureLimitationConfig objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptionFeatureLimitationConfigs \
-H 'Content-Type: application/json' \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
        "siteId": 10000,
        "monthsOfHistoryCanBeAccessed": 0,
        "monthsOfHistoryCanBeAccessedBeyondFreemium": 0,
        "monthsOfHistoryBeingStored": 0,
        "monthsOfHistoryBeingStoredBeyondFreemium": 0
    }
]

Get a subscription feature limitation config

GET /api/billing/subscriptionFeatureLimitationConfigs/{subscriptionId}

• Parameters

Path Parameters

• Response

  The response is a SubscriptionFeatureLimitationConfig object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/subscriptionFeatureLimitationConfigs/895a5d94-97e8-410f-8ff3-53d8038e908a \
-H 'Content-Type: application/json' \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "subscriptionId": "895a5d94-97e8-410f-8ff3-53d8038e908a",
    "siteId": 10000,
    "monthsOfHistoryCanBeAccessed": 0,
    "monthsOfHistoryCanBeAccessedBeyondFreemium": 0,
    "monthsOfHistoryBeingStored": 0,
    "monthsOfHistoryBeingStoredBeyondFreemium": 0
}

Product

You need the Manage Product permission to manage product.

• GET /api/billing/products - Get collection of products
• GET /api/billing/products/{id} - Get a product

Product Object JSON format

Product Object

Product definition.

Product Endpoints

Get collection of products

GET /api/billing/products

• Parameters

Query Parameters

• Response

  The response is collection of Product objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/products \
-H 'Content-Type: application/json'  \
-X 'GET' \ 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": "AdditionalTwitterAccount",
        "moduleId": "Ticketing",
        "name": "Additional Twitter Account",
        "description": ""
    }
]

Get a product

GET /api/billing/products/{id}

• Parameters

Path Parameters

• Response

  The response is a Product object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/products/AdditionalTwitterAccount \
-H 'Content-Type: application/json' \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "id": "AdditionalTwitterAccount",
    "moduleId": "Ticketing",
    "name": "Additional Twitter Account",
    "description": ""
}

Product

You need the Manage Product permission to manage product.

• GET /api/billing/products - Get collection of products
• GET /api/billing/products/{id} - Get a product

Product Object JSON format

Product Object

Product definition.

Product Endpoints

Get collection of products

GET /api/billing/products

• Parameters

Query Parameters

• Response

  The response is collection of Product objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/products  \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": "AdditionalTwitterAccount",
        "moduleId": "Ticketing",
        "name": "Additional Twitter Account",
        "description": ""
    }
]

Get a product

GET /api/billing/products/{id}

• Parameters

Path Parameters

• Response

  The response is a Product object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/products/AdditionalTwitterAccount \
-H 'Content-Type: application/json' \
-X 'GET' \ 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "id": "AdditionalTwitterAccount",
    "moduleId": "Ticketing",
    "name": "Additional Twitter Account",
    "description": ""
}

Product Feature Point

You need the Manage Feature permission to manage product feature point.

• GET /api/global/productFeaturePoint - Get collection of product feature points

Product Feature Point Object JSON format

Product Feature Point Object

ProductFeaturePoint definition.

Product Feature Point Endpoints

Get collection of product feature points

GET /api/global/productFeaturePoint

• Parameters

  No parameters

• Response

  The response is collection of ProductFeaturePoint objects.

• Example

Using curl

curl https://partner.comm100.io/api/global/productFeaturePoint \
-H 'Content-Type: application/json'  \
-X 'GET' \ 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "errorCode": 0,
    "errorMessage": "",
    "data":[
        {
            "id": "Chatbot",
            "moduleId": "Bot",
            "name": "Chatbot",
            "description": "",
            "featurePointItems": [
                {
                    "id": "ChatBot",
                    "productId": "Chatbot",
                    "name": "Chatbot",
                    "description": "",
                    "parentId": "",
                    "category": "default",
                    "chatbotEngineId": "00000000-0000-0000-0000-000000000000"
                }
            ]
        }
    ]
}

Feature Point Item

You need the Manage Feature permission to manage feature point item.

• GET /api/global/featurePointItems - Get a list of site billing profiles
• GET /api/billing/featurePointItems/{siteId} - Get billing profile of a site

Feature Point Item Object JSON format

Feature Point Item Object

FeaturePointItem definition.

Feature Point Item Endpoints

Get collection of feature point items

GET /api/global/featurePointItems

• Parameters

  No parameters

• Response

  The response is collection of FeaturePointItem objects.

• Example

Using curl

curl https://partner.comm100.io/api/global/featurePointItems \
-H 'Content-Type: application/json'  \
-X 'GET' 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
[
    {
        "id": "Mention",
        "productId": "Ticketing",
        "name": "@mention",
        "description": "",
        "parentId": "",
        "category": "default",
        "chatbotEngineId": "00000000-0000-0000-0000-000000000000"
    }
]

Get a feature point item

GET /api/global/featurePointItems/{id}

• Parameters

Path Parameters

• Response

  The response is FeaturePointItem object.

• Example

Using curl

curl https://partner.comm100.io/api/global/featurePointItems/Mention  \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "id": "Mention",
    "productId": "Ticketing",
    "name": "@mention",
    "description": "",
    "parentId": "",
    "category": "default",
    "chatbotEngineId": "00000000-0000-0000-0000-000000000000"
}

Invoice Bill To

You need the Manage Invoice permission to manage invoice bill to.

• GET /api/billing/invoiceBillTos - Get paged collection of invoice bill tos
• GET /api/billing/invoiceBillTos/{invoiceId} - Get a invoice bill to

Invoice Bill To Object JSON format

Invoice Bill To Object

InvoiceBillTo definition.

Invoice Bill To Endpoints

Get paged collection of invoice bill tos

GET /api/billing/invoiceBillTos

• Parameters

Query Parameters

• Response

  The response is paged collection of InvoiceBillTo objects.

• Example

Using curl

curl https://partner.comm100.io/api/billing/invoiceBillTos
-H 'Content-Type: application/json' 
-X 'GET' 

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "invoiceBillTos": [
        {
            "invoiceId": "27493bc9-9eb5-4bb3-2b95-08d9fc1fda3a",
            "siteId": 10000,
            "firstName": "1",
            "lastName": "1",
            "companyName": "1",
            "email": "1@1.com",
            "phone": "13111111111",
            "countryOrRegion": "Afghanistan",
            "stateOrProvince": "",
            "city": "",
            "mailingAddress": "1",
            "jobTitle": "",
            "billTo": "1"
        }
    ],
    "nextPage": null,
    "previousPage": null,
    "total": 4
}

Get a invoice bill to

GET /api/billing/invoiceBillTos/{invoiceId}

• Parameters

Path Parameters

• Response

  The response a InvoiceBillTo object.

• Example

Using curl

curl https://partner.comm100.io/api/billing/invoiceBillTos/27493bc9-9eb5-4bb3-2b95-08d9fc1fda3a  \
-H 'Content-Type: application/json'  \
-X 'GET'  \

Response

HTTP/1.1 200 OK
Content-Type:  application/json
{
    "invoiceId": "27493bc9-9eb5-4bb3-2b95-08d9fc1fda3a",
    "siteId": 10000,
    "firstName": "1",
    "lastName": "1",
    "companyName": "1",
    "email": "1@1.com",
    "phone": "13111111111",
    "countryOrRegion": "Afghanistan",
    "stateOrProvince": "",
    "city": "",
    "mailingAddress": "1",
    "jobTitle": "",
    "billTo": "1"
}