Skip to content

API Reference (1.0)

Billing Platform API

Download OpenAPI description
schema_10_05_2025.json
schema_10_05_2025.yaml
Overview
URL

http://support.billingplatform.com

API Support

support@billingplatform.com

License

Apache 2.0

Languages
Servers
Mock server

https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/

https://my.billingplatform.com/demogm/

CONTRACT

Contracts add a level of pricing control after the provisioned products and provisioned package products.

Operations

CONTRACT_RATE

A contract rate contains the rating method and pricing records under a contract for a given account and product.

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP

Used for creating international rates and associating the pricing to provisioned products/packages and rate classes.

Operations

DESTINATION_COUNTRY_CODE

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE

Operations

PACKAGE

Packages, also known as "Bundles" are used to price and provision a specified set of Products.

Operations

PACKAGE_CURRENCY

This object is used to define a currency for a given package. It is a junction between the Package and Currency objects.

Operations

PACKAGE_PRODUCT

Package Products are the products that belong to a package or bundle.

Operations

PARENT_PACKAGE_PRODUCT

Operations

PRICING

Pricing records are used for pricing on Contracts, Rate Classes, Account Products and Account Package Products.

Operations

PRODUCT

The foundation of BillingPlatform is the product. It offers a way to structure your pricing information.

Operations

RATE_CLASS

A rate class is used to house product pricing that can be centrally managed and assigned to Account Contracts.

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

A Rating Method is used to define a Product's rating behavior. Examples of rating method types are Usage and Subscription.

Operations

ACCOUNT

An account in BillingPlatform is a customer account with the billing profile that consolidates all customer information.

Operations

ACCOUNT_PACKAGE

Account packages are collections of bundled products that are provisioned to the customer.

Operations

ACCOUNT_PRODUCT

An Account Product is used to provision services to an account such as subscriptions and discounts that generate charges.

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

Identifies the billing and invoicing attributes for a given element of the hierarchy

Operations

CONTRACT

Contracts add a level of pricing control after the provisioned products and provisioned package products.

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

A contract rate contains the rating method and pricing records under a contract for a given account and product.

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

Used for creating international rates and associating the pricing to provisioned products/packages and rate classes.

Operations

CURRENCY

CURRENCY API Reference

Operations

PRICING

Pricing records are used for pricing on Contracts, Rate Classes, Account Products and Account Package Products.

Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations

TIME_ZONE

TIME_ZONE API Reference

Operations

ACTIVITY

The Activity Object, also known as "Invoice Detail", contains all of the rated charges in the system for any given product.

Operations

ACTIVITY_COLLECTOR

Also known as a Usage Collector, the Activity Collector is the primary object used for mediation.

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

Also Known as Usage Data, Collector Fields is used to define the fild mappings for Usage Data files.

Operations

CREDIT

The credit object is used to provide a credit to an Account or Billing Profile.

Operations

CREDIT_ALLOCATION

Used to allocate a Credit to an invoice. Can only allocate as much of the unallocated credit amount that's available at creation

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

INVOICE

Contain charges (Activity) associated with an account. Invoices aggregate service charges, Payments Allocations, etc.

Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations

PAYMENT

The Payment table is a crucial component of our database that records all transactions related to payments.

Operations

REFUND

A Refund is used to refund credit card payments.

Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT

The Account Contact entity represents the person who the bills are addressed to. This name typically appears on invoices.

Operations

CONTACT_TYPE

The types an Account Contact can be. This contact receives the Action Items of a Collection Strategy.

Operations

Retrieve By Id Contact Categories

Request

Get Contact Categories By Id

Security
JWT
Path
idanyrequired

Id of the record

Headers
sessionIdstringrequired
curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/rest/2.0/CONTACT_TYPE/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "ConfigurationId": null,
    "Created": null,
    "CreatedUserId": null,
    "Description": null,
    "Id": null,
    "Name": null,
    "Updated": null,
    "UpdatedUserId": null
  }
}

Retrieve Filtered Contact Categories

Request

Get record(s) using filters

Security
JWT
Query
queryAnsiSqlstringrequired

SQL Where part

Headers
sessionIdstringrequired
curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/rest/2.0/CONTACT_TYPE?queryAnsiSql=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "ConfigurationId": null,
    "Created": null,
    "CreatedUserId": null,
    "Description": null,
    "Id": null,
    "Name": null,
    "Updated": null,
    "UpdatedUserId": null
  }
}

Update Contact Categories

Request

Update Contact Categories

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/rest/2.0/CONTACT_TYPE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ConfigurationId": null,
      "Created": null,
      "CreatedUserId": null,
      "Description": null,
      "Id": null,
      "Name": null,
      "Updated": null,
      "UpdatedUserId": null
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
updateResponseArray of objects
Response
application/json
{
  "updateResponse": [
    { … }
  ]
}

CS_ACCOUNT_ACTION

The collections Action associated with an account that is in collections. Such as emails, phone calls, termination of service.

Operations

CS_ACTION

Collection Actions are activities that are done whenever a workflow rule is evaluated as true

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

Used to define a named strategy and the filter or selection criteria that identifies what accounts to apply this strategy.

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

This object is used to allocate a Payments to an invoice.

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

The ability to report journal entries to the General Ledger system is an essential element of the sub ledger system.

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

BillingPlatform provides Revenue Recognition Contracts to facilitate key steps to ensure seamless compliance of ASC 606/IFRS 15.

Operations

ENTITY

Represent an object or table in the system. Entities are metadata and contains information used by the application.

Operations

ENTITY_FIELD

Entity Fields are the fields defined for an entity. Entity Fields can be of various types like a number, date or text

Operations

ENTITY_FIELD_ROLE

This Object is used to define the access for a given role to a given Entity.

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations

QUOTE

QUOTE API Reference

Operations

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

CONTRACT

Contracts add a level of pricing control after the provisioned products and provisioned package products.

Operations

CONTRACT_RATE

A contract rate contains the rating method and pricing records under a contract for a given account and product.

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP

Used for creating international rates and associating the pricing to provisioned products/packages and rate classes.

Operations

DESTINATION_COUNTRY_CODE

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE

Operations

PACKAGE

Packages, also known as "Bundles" are used to price and provision a specified set of Products.

Operations

PACKAGE_CURRENCY

This object is used to define a currency for a given package. It is a junction between the Package and Currency objects.

Operations

PACKAGE_PRODUCT

Package Products are the products that belong to a package or bundle.

Operations

PARENT_PACKAGE_PRODUCT

Operations

PRICING

Pricing records are used for pricing on Contracts, Rate Classes, Account Products and Account Package Products.

Operations

PRODUCT

The foundation of BillingPlatform is the product. It offers a way to structure your pricing information.

Operations

RATE_CLASS

A rate class is used to house product pricing that can be centrally managed and assigned to Account Contracts.

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

A Rating Method is used to define a Product's rating behavior. Examples of rating method types are Usage and Subscription.

Operations

ACCOUNT

An account in BillingPlatform is a customer account with the billing profile that consolidates all customer information.

Operations

ACCOUNT_PACKAGE

Account packages are collections of bundled products that are provisioned to the customer.

Operations

ACCOUNT_PRODUCT

An Account Product is used to provision services to an account such as subscriptions and discounts that generate charges.

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

Identifies the billing and invoicing attributes for a given element of the hierarchy

Operations

CONTRACT

Contracts add a level of pricing control after the provisioned products and provisioned package products.

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

A contract rate contains the rating method and pricing records under a contract for a given account and product.

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

Used for creating international rates and associating the pricing to provisioned products/packages and rate classes.

Operations

CURRENCY

CURRENCY API Reference

Operations

PRICING

Pricing records are used for pricing on Contracts, Rate Classes, Account Products and Account Package Products.

Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations

TIME_ZONE

TIME_ZONE API Reference

Operations

ACTIVITY

The Activity Object, also known as "Invoice Detail", contains all of the rated charges in the system for any given product.

Operations

ACTIVITY_COLLECTOR

Also known as a Usage Collector, the Activity Collector is the primary object used for mediation.

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

Also Known as Usage Data, Collector Fields is used to define the fild mappings for Usage Data files.

Operations

CREDIT

The credit object is used to provide a credit to an Account or Billing Profile.

Operations

CREDIT_ALLOCATION

Used to allocate a Credit to an invoice. Can only allocate as much of the unallocated credit amount that's available at creation

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

INVOICE

Contain charges (Activity) associated with an account. Invoices aggregate service charges, Payments Allocations, etc.

Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations

PAYMENT

The Payment table is a crucial component of our database that records all transactions related to payments.

Operations

REFUND

A Refund is used to refund credit card payments.

Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT

The Account Contact entity represents the person who the bills are addressed to. This name typically appears on invoices.

Operations

CONTACT_TYPE

The types an Account Contact can be. This contact receives the Action Items of a Collection Strategy.

Operations

Retrieve By Id Contact Categories

Request

Get Contact Categories By Id

Security
JWT
Path
idanyrequired

Id of the record

Headers
sessionIdstringrequired
curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/rest/2.0/CONTACT_TYPE/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "ConfigurationId": null,
    "Created": null,
    "CreatedUserId": null,
    "Description": null,
    "Id": null,
    "Name": null,
    "Updated": null,
    "UpdatedUserId": null
  }
}

Retrieve Filtered Contact Categories

Request

Get record(s) using filters

Security
JWT
Query
queryAnsiSqlstringrequired

SQL Where part

Headers
sessionIdstringrequired
curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/rest/2.0/CONTACT_TYPE?queryAnsiSql=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json
retrieveResponseobject
Response
application/json
{
  "retrieveResponse": {
    "ConfigurationId": null,
    "Created": null,
    "CreatedUserId": null,
    "Description": null,
    "Id": null,
    "Name": null,
    "Updated": null,
    "UpdatedUserId": null
  }
}

Update Contact Categories

Request

Update Contact Categories

Security
JWT
Headers
sessionIdstringrequired
Bodyapplication/json; charset=utf-8required
brmObjectsobject
curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/schema_10_05_2025/rest/2.0/CONTACT_TYPE \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "ConfigurationId": null,
      "Created": null,
      "CreatedUserId": null,
      "Description": null,
      "Id": null,
      "Name": null,
      "Updated": null,
      "UpdatedUserId": null
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json
updateResponseArray of objects
Response
application/json
{
  "updateResponse": [
    { … }
  ]
}

CS_ACCOUNT_ACTION

The collections Action associated with an account that is in collections. Such as emails, phone calls, termination of service.

Operations

CS_ACTION

Collection Actions are activities that are done whenever a workflow rule is evaluated as true

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

Used to define a named strategy and the filter or selection criteria that identifies what accounts to apply this strategy.

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

This object is used to allocate a Payments to an invoice.

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

The ability to report journal entries to the General Ledger system is an essential element of the sub ledger system.

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

BillingPlatform provides Revenue Recognition Contracts to facilitate key steps to ensure seamless compliance of ASC 606/IFRS 15.

Operations

ENTITY

Represent an object or table in the system. Entities are metadata and contains information used by the application.

Operations

ENTITY_FIELD

Entity Fields are the fields defined for an entity. Entity Fields can be of various types like a number, date or text

Operations

ENTITY_FIELD_ROLE

This Object is used to define the access for a given role to a given Entity.

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations

QUOTE

QUOTE API Reference

Operations

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations