Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to create a charge for a customer. It is useful for automating billing processes by programmatically adding charges with detailed attributes such as start date, quantity, pricing, tax, and descriptions. For example, it can be used to create one-time or recurring charges for customers in a billing system, including specifying charge frequency, status, and additional metadata.

Use Case Examples

  1. Creating a single charge for a customer with a specified start date and quantity.
  2. Creating a recurring charge with detailed billing frequency and pro-rata start date.
  3. Adding a charge with custom descriptions, pricing, and tax rates for invoicing purposes.

Properties

Name Meaning
Customer Id Unique identifier of the customer for whom the charge is created.
Start At Date when the charge first starts.
Quantity Quantity of the charge.
Additional Body Fields Optional additional fields to customize the charge, including id, status, type, frequency, created date, pro-rata start date, end date, last and next charge dates, description, details, display options, metadata, accounting code, sort priority, visibility of charge period, tax inclusion, sell and buy prices, tax rate, caller line identifiers, product, supplier, category, cost centre, and service file identifiers.

Output

JSON

  • data - Response data from the Billing Booth One API representing the created charge.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Common issues include missing or invalid API credentials, resulting in authentication errors.
  • Incorrect or missing required parameters such as customerId, start_at, or quantity may cause request failures.
  • Network or API endpoint errors can occur if the base URL is incorrect or the API service is down.
  • Error messages from the API are propagated and should be checked for details on invalid fields or permissions.

Links

Discussion