Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Subscriptions / Pause

  • Article
  • 3 minutes to read

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
Subscription ID subscriptionID string Supscription ID (This can be found in the URL of the record.) Yes None provided
Pause Option pauseOption string List of options to pause the subscription. Yes Immediately, End Of Term, Specific Date, Billing Cycles
Unbilled Charges unbilledCharges string This Field Lays Out What Action Should Be Taken On Outstanding Charges No No Action, Invoice
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
Skip Billing Cycles skipBillingCycles integer The number of subscription billing cycles that will be skipped. No None provided

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
Trial Start Date trialStart string Start Date Of Your Trial Subscription
Trial End Date trialEnd string End Date Of Your Trial Subscription
Next Billing Date nextBilling string Next Billing Date Of Your Subscription
Start Date startDate string Start Date Of Your Subscription
First Name firstName string Customer First Name
Last Name lastName string Customer Last Name
Email 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}}
In This Document