Skip to main content
POST
Create a billing group

Overview

Create a billing group to consolidate multiple subscriptions into a single monthly invoice. This is ideal for B2B customers with multiple devices who prefer simplified billing.
Billing groups are typically used for business customers. Individual customers usually have separate billing per subscription.

Request Fields

Example Request

What Happens

When you create a billing group:
  1. Group created with specified subscriptions
  2. Subscriptions linked to the billing group
  3. Future payments consolidated to billing day
  4. Monthly total calculated automatically

Billing Day Selection

Choose a billing day that works for the customer:
Use 28 or lower for billing day to ensure it exists in all months. Days 29-31 may cause issues in shorter months.

Example: Create Group for New Business Customer

Error Handling

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Body

application/json
customerId
string
required
Minimum string length: 1
groupName
string
required
Minimum string length: 1
billingDay
integer
required
Required range: 1 <= x <= 28
rentalIds
string[]
required
Minimum array length: 1
notes
string

Response

Billing group created

success
enum<boolean>
required
Available options:
true
message
string
required
billingGroup
object
required