TMF666 v5 Account Management API

The Billing Account Management API (TMF666) provides a standardized mechanism for billing account management, such as creation, update, retrieval, and deletion of billing accounts.

TMF666 v5 currently supports the billingAccount resource. Billing accounts map to the Salesforce BillingAccount object.

Using this API you can perform the following operations on billing accounts.

Retrieve the list of billing accounts from the system
Get billing account details based on conditions or an ID parameter
Create a billing account
Update an existing billing account
Delete an existing billing account

For TMF Open API release and specification version, see Industry API Version.

Note

Access Methods

Access TMF666 v5 API using Direct Access Connect/Apex REST endpoints.

See TMF666 v5 Use Cases for sample URLs and payloads.
See TMF666 v5 Resource Mappings for parameter descriptions.

Starting from the Winter ’27 release, only the Direct Access option is supported for this API.

Important

Available In

This API is available in the Salesforce platform.

Prerequisites

Required: CommsCloudTMFAPI or the CommsCloud platform license.
The org must have the CMERLMB2BAddon or CMERLMB2CAddon license enabled.
Optional: CommunicationsCloudTMFAPIAddOn-1 add-on license.
Access check: IndustriesComms.orgHasCommsTMFAPIAccess.
Minimum API version: 264.
If you implement Apex extensibility hooks, annotate the custom Apex class with @PermGuard('IndustriesComms.orgHasCommsTMFAPIAccess').

Extensibility

For extensibility features, see Extensibility for TMF666 v5 Account Management.

Sample Apex URL (Direct Access Method)

TMF666 v5 API uses the following URL format:

{https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/accountmanagement/v5/billingAccount.

Use TMF666 v5 API

To access and use the TMF666 v5 API:

Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
Trigger the API call. Refer to the preceding section for sample URL.
Use the TMF666 v5 API resources and endpoints.
- See TMF666 v5 Use Cases for sample URLs and payloads.
- See TMF666 v5 Resource Mappings for parameter descriptions.
Based on the requirements, extend TMF666 v5 API. See Extensibility for TMF666 v5 Account Management.