Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

TM Forum

TM Forum billingAccount API

The billingAccount API from TM Forum — 2 operation(s) for billingaccount.

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum billingAccount API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include billingAccount. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

5 operations 2 paths 21 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/v5/
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

billingAccount 5
GET
/billingAccount
List or find BillingAccount objects
listBillingAccount 3 params → 200400401403404405409500
POST
/billingAccount
Creates a BillingAccount
createBillingAccount 1 param → 201400401403405409500
GET
/billingAccount/{id}
Retrieves a BillingAccount by ID
retrieveBillingAccount 2 params → 200400401403404405409500
PATCH
/billingAccount/{id}
Updates partially a BillingAccount
patchBillingAccount 2 params → 200400401403404405409500
DELETE
/billingAccount/{id}
Deletes a BillingAccount
deleteBillingAccount 1 param → 204400401403404405409500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BillingAccount (21 properties), BillingAccount_Create (19 properties), BillingAccount_Update (18 properties), BillingCycleSpecificationRefOrValue (18 properties). Each schema is shown below with its type and property counts.

BillingAccount_Create
object
A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specializ…
19 properties 2 required
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
AccountBalance
object
Balances linked to the account
6 properties 3 required
ContactMedium
object
Indicates the contact medium that could be used to contact the party.
7 properties
BillingAccount_Update
object
A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specializ…
18 properties 2 required
FinancialAccountRef
object
AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An accou…
8 properties 1 required
PaymentMethodRef
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
7 properties 1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
MediumCharacteristic
object
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
14 properties
BillFormatRefOrValue
object
An attachment by value or by reference.
9 properties 2 required
BillingCycleSpecificationRefOrValue
object
An attachment by value or by reference.
18 properties 2 required
PaymentPlan
object
Defines a plan for payment (when a party wants to spread his payments)
11 properties
BillPresentationMediaRefOrValue
object
An attachment by value or by reference.
9 properties 2 required
AccountTaxExemption
object
Proof of freedom from taxes imposed by a taxing jurisdiction
7 properties 2 required
Money
object
A base / value business entity used to represent money
2 properties
Contact
object
An individual or an organization used as a contact point for a given account and accessed via some contact medium.
9 properties 2 required
AccountRef
object
Account reference. A account may be a party account or a financial account.
8 properties 1 required
BillingAccount
object
A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specializ…
21 properties 2 required
BillStructure
object
The structure of the bill for party accounts (billing or settlement).
6 properties
AccountRelationship
object
Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.
6 properties 2 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-billingaccount-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreement API
AE Profile APIs.io
TM Forum agreementSpecification API
AE Profile APIs.io
TM Forum billFormat API
AE Profile APIs.io
TM Forum billingCycleSpecification API
AE Profile APIs.io
TM Forum billPresentationMedia API
AE Profile APIs.io
TM Forum cancelProductOrder API
AE Profile APIs.io
TM Forum cancelServiceOrder API
AE Profile APIs.io
TM Forum category API
AE Profile APIs.io
TM Forum customer API
AE Profile APIs.io
TM Forum events subscription API
AE Profile APIs.io
TM Forum exportJob API
AE Profile APIs.io
TM Forum financialAccount API
AE Profile APIs.io
#billingAccount
← Back to T APIs
API Details
ID
tm-forum:tm-forum-billingaccount-api
Server
https://serverRoot/productCatalogManagement/v5/
Docs
https://www.tmforum.org/resources/specification/tmf620-product-catalog-management-api-rest-specification-r17-5-0/
Provider
TM Forum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network