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 / Create

  • Article
  • 3 minutes to read

Operation Information

A function to Create Item Prices 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 Yes None provided
Item Name name string The name of the item that the price will be assigned to Yes None provided
Item ID itemID string Item Custom ID Yes None provided
Item Family ID itemFamilyID string The id of the Item family that the item belongs to. Is mandatory when Product Families have been enabled. No None provided
Description description string Any further informaion of item price that will be created 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 Is the item price being created tax exempt or not 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
Price In Decimal priceInDecimal string This is only applicable when multi-decimal pricing is enabled 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 returned status from the operation
Errors error string The errors generated by 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 status of the item created
Enabled For Checkout enabledForCheckout string A true or false statement highlighting if the item is enabled for checkout
Enabled In Portal enabledInPortal string A true or false statement showcasing if the item is enabled to be seen in the portal
Is Giftable isGiftable string A true or fasle statement showcasing if an item can be gifted
Is Shippable isShippable string A true or false statement showcasing if the created item can be shipped
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document