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...

Item Price / Update

  • Article
  • 3 minutes to read

Operation Information

A function to Update Item Price within 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
Item Price ID id string Item Price Custom ID No None provided
Item Name name string The updated name for the item Yes None provided
Item ID itemID string Item Custom ID No None provided
Description description string Any further information about the item price No None provided
Invoice Notes invoiceNotes string A customer-facing note added to all invoices associated with this API resource. No None provided
External Name externalName string A unique display name for the item. No None provided
Currency Code currencyCode string Currency Code For Example: GBP No None provided
Taxible Item isTaxible string A true or false statement on if the item is taxible No false, true
Pricing Model pricingModel string Currency Code For Example: GBP No Flat Fee, Per Unit, Tiered, Volume, Stairstep
Item Price price string The Value Is Measured In The Minor Unit Of The Currency Selected No None provided
Period Unit periodUnit string The time frame item payments can be made at No Day, Week, Month, Year
Period period integer The number of days, weeks, months, or years an items billing period is No None provided

Output Parameters

Display Name ID Type Description
Status status string The status of the run operation
Errors error string The errors generated from the operation will be logged here
Item ID id string Item ID
Item Name name string Item Name
Item Type type string Item Type
Item Status itemStatus string The new status of the updated item
Enabled For Checkout enabledForCheckout string A true or false statement about if the item is enabled for checkout
Enabled In Portal enabledInPortal string A true or false statement on if the item is available in the portal
Is Giftable isGiftable string A true or flase statement on if the item is giftable
Is Shippable isShippable string A true or false statement on if the item is shippable
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document