Quick Start Guide

API Basics

API Resources

API: Subscriptions

Subscriptions contain details about the backup plan.

  • Partners have access to all Subscriptions associated with any Company account that signed up for CleverFox Backup using a special Partner Plan link.

Attributes

All of the attribute fields are returned from GET (read) operations. Only those attributes not marked as read only may be set via POST (create) or PUT (update) operations.

Name Type Notes
SubscriptionId Integer Read Only
CompanyId Integer Required on POST, otherwise Read Only
Company Object See API Companies
PlanId Integer Required on POST, otherwise Read Only
Plan Object See API Plans
ApplicationId String 25 Special code assigned to every Partner account. You should consult with CleverFox Backup Support before changing this value.
ExternalId String 100 Unique identifier for Partners to identify this Subscription.
IsInactive Boolean Read Only
BillingId Integer Read Ony
Status String 15 Read Only
PeriodStart DateTime UTC Read Only
PeriodEnd DateTime UTC Read Only
AdditionalDevice Integer Read Only
DownloadLimitExpireOn DateTime UTC Read Only
SendNotificationTo String Required if the SendNotificationOnStorageLimit is true. Accepts multiple email addresses if separated by a colon, a semi-colon, or "\r\n".
SendNotificationBcc String Accepts multiple email addresses if separated by a colon, a semi-colon, or "\r\n".
SendNotificationCc String Accepts multiple email addresses if separated by a colon, a semi-colon, or "\r\n".
SendNotificationOnStorageLimit Boolean
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only
Token String 50 See API Duplication Prevention

List (GET)

Returns an array of Subscriptions in descending order.

URL
https://cleverfoxbackup.com/api/subscriptions
Optional Parameters
  • PageNo: the page number to return, defaults to 1.
  • PageSize: the maximum number of records per page, defaults to 25.
Response Codes
  • 200 OK
Sample JSON 
{
  "data": [
    {
      "SubscriptionId": 1,
      "CompanyId": 1,
      "Company": {
        "CompanyId": 1,
        "PartnerId": 1,
        "Partner": null,
        "PlanTypeId": 1,
        "PlanType": null,
        "Name": "ABC Company, Inc.",
        "AddressLine1": "1000 Main St",
        "AddressLine2": null,
        "CityMunicipality": "Anytown",
        "StateProvidence": "MI",
        "PostalCode": "12345",
        "Country": null,
        "Phone": null,
        "ExternalId": null,
        "IsInactive": false,
        "AddedOn": "2015-01-01T00:00:00.000",
        "UpdatedOn": null,
        "Token": null
      },
      "PlanId": 1,
      "Plan": {
        "PlanId": 1,
        "PlanTypeId": 1,
        "Name": "Small Plan",
        "Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
        "IsInactive": false,
        "DeviceLimit": 1,
        "StorageLimit": 25,
        "DownloadLimit": true
      },
      "ApplicationId": null,
      "ExternalId": null,
      "IsInactive": false,
      "BillingId": 12345678,
      "Status": "Active",
      "PeriodStart": "2015-01-01T00:00:00.000",
      "PeriodEnd": "2015-02-01T12:00:00.000",
      "AdditionalDevice": "0",
      "DownloadLimitExpireOn": null,
      "SendNotificationTo": "johnsmith@abccompany.com",
      "SendNotificationBcc": null,
      "SendNotificationCc": null,
      "SendNotificationOnStorageLimit": true,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Read (GET)

Returns a single Subscription.

URL
https://cleverfoxbackup.com/api/subscriptions/{SubscriptionId}
Required Parameters
  • SubscriptionId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "SubscriptionId": 1,
    "CompanyId": 1,
    "Company": {
      "CompanyId": 1,
      "PartnerId": 1,
      "Partner": null,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "ABC Company, Inc.",
      "AddressLine1": "1000 Main St",
      "AddressLine2": null,
      "CityMunicipality": "Anytown",
      "StateProvidence": "MI",
      "PostalCode": "12345",
      "Country": null,
      "Phone": null,
      "ExternalId": null,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    },
    "PlanId": 1,
    "Plan": {
      "PlanId": 1,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "Small Plan",
      "Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
      "IsInactive": false,
      "DeviceLimit": 1,
      "StorageLimit": 25,
      "DownloadLimit": true
    },
    "ApplicationId": null,
    "ExternalId": null,
    "IsInactive": false,
    "BillingId": 12345678,
    "Status": "Active",
    "PeriodStart": "2015-01-01T00:00:00.000",
    "PeriodEnd": "2015-02-01T00:00:00.000",
    "AdditionalDevice": "0",
    "DownloadLimitExpireOn": null,
    "SendNotificationTo": "johnsmith@abccompany.com",
    "SendNotificationBcc": null,
    "SendNotificationCc": null,
    "SendNotificationOnStorageLimit": true,
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null,
    "Token": null
  }
}

Lookup (GET)

Returns a single Subscription.

URL
https://cleverfoxbackup.com/api/subscriptions/lookup?ExternalId={ExternalId}
Required Parameters
  • ExternalId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "SubscriptionId": 1,
    "CompanyId": 1,
    "Company": {
      "CompanyId": 1,
      "PartnerId": 1,
      "Partner": null,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "ABC Company, Inc.",
      "AddressLine1": "1000 Main St",
      "AddressLine2": null,
      "CityMunicipality": "Anytown",
      "StateProvidence": "MI",
      "PostalCode": "12345",
      "Country": null,
      "Phone": null,
      "ExternalId": null,
      "IsInactive": false,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null,
      "Token": null
    },
    "PlanId": 1,
    "Plan": {
      "PlanId": 1,
      "PlanTypeId": 1,
      "PlanType": null,
      "Name": "Small Plan",
      "Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
      "IsInactive": false,
      "DeviceLimit": 1,
      "StorageLimit": 25,
      "DownloadLimit": true
    },
    "ApplicationId": null,
    "ExternalId": null,
    "IsInactive": false,
    "BillingId": 12345678,
    "Status": "Active",
    "PeriodStart": "2015-01-01T00:00:00.000",
    "PeriodEnd": "2015-02-01T00:00:00.000",
    "AdditionalDevice": "0",
    "DownloadLimitExpireOn": null,
    "SendNotificationTo": "johnsmith@abccompany.com",
    "SendNotificationBcc": null,
    "SendNotificationCc": null,
    "SendNotificationOnStorageLimit": true,
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null,
    "Token": null
  }
}

Create (POST)


Update (PUT)

Updates a Subscription and returns the updated data.

URL
https://cleverfoxbackup.com/api/subscriptions/{SubscriptionId}
Required Parameters
  • SubscriptionId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "ApplicationId": null,
    "ExternalId": null,
    "SendNotificationTo": "johnsmith@abccompany.com",
    "SendNotificationBcc": null,
    "SendNotificationCc": null,
    "SendNotificationOnStorageLimit": true,
    "Token": null
  }
}

Delete (DELETE)