Skip to main content
PATCH
Update a billing group

Overview

Update a billing group’s settings, add or remove subscriptions, or change the billing day. Use this to manage consolidated B2B billing as customer needs change.

Updatable Fields

Example: Add Subscription to Group

The rentalIds array replaces the existing subscriptions. Include all subscriptions you want in the group, not just new ones.

Example: Change Billing Day

Example: Rename Group

Common Operations

Add New Subscription

Remove Subscription

Deactivate Group

Error Handling

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

billingGroupId
string
required

The billing group ID

Body

application/json
groupName
string
Minimum string length: 1
billingDay
integer
Required range: 1 <= x <= 28
rentalIds
string[]
notes
string
status
enum<string>
Available options:
active,
inactive

Response

Billing group updated

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