Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API
Join our community

Actions476

Overview

This node interacts with the Billing Booth One API to manage payment plans under the Payments resource, specifically supporting the 'Take Payment Plan' operation. It allows users to create a payment plan for a customer by specifying details such as customer ID, description, amount, frequency, number of installments, first collection date, and payment provider settings. This node is useful for automating payment collection processes, managing installment plans, and integrating payment workflows within automation scenarios.

Use Case Examples

  1. Creating a weekly payment plan for a customer to collect payments in installments.
  2. Setting up a monthly payment plan with a specific first collection date and optional invoice association.

Properties

Name Meaning
Customer Id Unique identifier of the customer for whom the payment plan is created.
Description Description of the payment plan as it appears on the payment provider.
Amount The amount to be collected in each installment.
Frequency Frequency of the payment collection, either weekly or monthly.
Installments Number of installments for the payment plan; must be at least 2.
First Collection Date Date when the first payment collection will occur.
Payment Provider Settings Id Identifier for the payment provider settings to be used for this payment plan.
Additional Body Fields Optional additional fields to customize the payment plan, including first installment amount, collection day for monthly plans, and associated invoice ID.

Output

JSON

  • json - Response data from the Billing Booth One API representing the created payment plan or error information.

Dependencies

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

Troubleshooting

  • Common issues include missing or invalid API credentials, incorrect customer ID, or invalid input values such as installments less than 2.
  • Error messages may indicate missing routing information for the selected resource and operation, or missing binary property if binary data is expected.
  • To resolve errors, ensure all required parameters are provided and valid, API credentials are correctly configured, and the node is properly authorized to access the Billing Booth One API.

Discussion