INDEX
Documentation Library
Search for information on Hornbill Documentation.
{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}
-
{{resultItem.title}}
{{resultItem.url}}
Have questions about this site?
What is this site?
- This website is Hornbill's new product documentation website and is currently under development.
- It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
- Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
- Please feel free to have a look around at any time.
Why has Hornbill created this site?
- Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
- Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
- We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
- We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
- We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.
What will this site be good for?
- Community contribution will be facilitated, encouraged, and most welcome.
- High quality documentation, will be kept up to date as rapidly as our products evolve.
- Real-time content search and discovery.
- Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
- Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
- Documentation available in browser as well as printable/viewable as PDF on demand.
- Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
- Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.
What is the timeline for this site?
- We have taken the decision to publish and make available early, there is very little content at this time.
- As and when we have completed/usable documentation, it will be published here.
- We have a host of additional features we wish to add over time, so please watch this space.
- We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
- The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
A function to pause Subscriptions from Chargebee.
This is a Premium Integration.
Authentication
This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Chargebee.
To create a key of this type:
- In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
- Click on the + Create New Key button;
- On the resulting Create New Key form, choose Chargebee in the Type pick list;
- Give the Chargebee KeySafe key a Title (this is the name / identifier for the Chargebee account as you will see it when using the cloud automation node in your workflows);
- Optionally populate the Description field;
- Populate the following fields accordingly, then click the Create Key button to create your new key:
Name | Type | Description |
---|---|---|
API Key | string |
API Key for authenticating API requests |
Endpoint | string |
API Endpoint |
Tip
The Endpoint field should be populated with the Chargebee subdomain that your account is assigned, and can be taken from the URL as so: https://[Endpoint].chargebee.com.
See the Chargebee website for details on creating API Keys.
Revoking Access
If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.
Warning
This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Chargebee account, so you will need to manage these workflows accordingly.
Input Parameters
Display Name | ID | Type | Description | Required | Supported Values |
---|---|---|---|---|---|
Customer ID | customerID |
string |
Customer ID (This can be found in the URL of the record.) | Yes | None provided |
Subscription Items | subscriptionItems |
array |
None provided | No | None provided |
Skip Billing Cycles | skipBillingCycles |
integer |
The number of subscription billing cycles that will be skipped. | No | None provided |
Pause Option | item |
string |
List of options to pause the subscription. | No | Immediately, End Of Term, Specific Date, Billing Cycles |
Invoice Dunning Handling | invoiceHandling |
string |
Handles dunning for invoices already in the dunning cycle when a subscription is paused. Applicable when ‘pause_option’ is set as immediately. | No | Continue, Stop |
Output Parameters
Display Name | ID | Type | Description |
---|---|---|---|
Error Message | error |
string |
Any errors returned by the Freshstatus API |
Status Code | status |
string |
The status of the operation: ok / failed |
Subscription Id | id |
string |
Subscription ID Which Can Be Found In The URL Of The Record |
Billing Period | billingPeriod |
string |
None provided |
Billing Frequency | billingPeriodUnit |
string |
The Time Between Subscription Payments Being Made |
Automatic Collection | autoCollection |
string |
Automatic Subscription Payments |
Subscription Status | subscriptionStatus |
string |
Subscription Status |
First Name | firstName |
string |
Customer First Name |
Last Name | lastName |
string |
Customer Last Name |
email |
string |
Customer Listed Email Address | |
Phone | phone |
string |
Customer Primary Phone Number |
Company | company |
string |
Customer Company |
Taxibility | taxability |
string |
Is The Customer Taxible |
Allow Direct Debits | allowDirectDebits |
string |
Customer Has Direct Debits Enabled |
Pii Cleared | piiCleared |
string |
Customer Is Pii Cleared |
Refundable Credits | refundableCredits |
number |
Number Of Refundable Credits Owned By The Customer |
Excess Payments | excessPayments |
number |
Excess Payments Against The Customers Account |
Unbilled Charges | unbilledCharges |
number |
Outstanding Charges Against The Customers Account |
Currency Code | currencyCode |
string |
The Customers Preffered Currency |
Payment Method | paymentMethod |
string |
The Preffered Payment Method Selected By The Customer |
Billing Address Line 1 | billingAddressL1 |
string |
None provided |
Billing Address Line 2 | billingAddressL2 |
string |
None provided |
Billing Address Line 3 | billingAddressL3 |
string |
Establishes If A Customer Will Pay Via Direct Debit |
Billing Address City | city |
string |
None provided |
Billing Address Postcode | postcode |
string |
None provided |
Billing Address Country | country |
string |
A Two Character Countru Format For Example ‘United Kingdom’ Would Be ‘GB’ |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}