API reference (1.0)

Billing Platform API

Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_03_06_2025_schema_edited/
https://my.billingplatform.com/demogm/

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

DESTINATION_COUNTRY_CODE

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE

Operations

PACKAGE

PACKAGE API Reference

Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference

Operations

PARENT_PACKAGE_PRODUCT

Operations

PRICING

PRICING API Reference

Operations

PRODUCT

Configure the Products in your product catalog

Operations

RATE_CLASS

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

RATING_METHOD API Reference

Operations

ACCOUNT

Account short help

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

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

CONTRACT API Reference

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

CURRENCY

CURRENCY API Reference

Operations

PRICING

PRICING API Reference

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

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations

CREDIT

CREDIT API Reference

Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

INVOICE

INVOICE API Reference

Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations

PAYMENT

PAYMENT API Reference

Operations

REFUND

REFUND API Reference

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

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACTION

CS_ACTION API Reference

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

REVREC_CONTRACT API Reference

Operations

ENTITY

ENTITY API Reference

Operations

ENTITY_FIELD

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE

ENTITY_FIELD_ROLE API Reference

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

ACCOUNT

Account short help

Operations

ACCOUNTING_DASHBOARD

ACCOUNTING_DASHBOARD API Reference

Operations

ACCOUNTING_PERIOD

ACCOUNTING_PERIOD API Reference

Operations

ACCOUNTING_PERIOD_HISTORY

ACCOUNTING_PERIOD_HISTORY API Reference

Operations

ACCOUNT_CONTACT

ACCOUNT_CONTACT API Reference

Operations

ACCOUNT_ORDER

ACCOUNT_ORDER API Reference

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PACKAGE_PRODUCT

ACCOUNT_PACKAGE_PRODUCT API Reference

Operations

ACCOUNT_PRICING_CURRENCY

ACCOUNT_PRICING_CURRENCY API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

ACCOUNT_PRODUCT_RELATION

ACCOUNT_PRODUCT_RELATION API Reference

Operations

ACCOUNT_PRODUCT_VERSION

ACCOUNT_PRODUCT_VERSION API Reference

Operations

ACCOUNT_PRODUCT_VERSION_ITEM

ACCOUNT_PRODUCT_VERSION_ITEM API Reference

Operations

ACCOUNT_PRODUCT_VERSION_REPORT

ACCOUNT_PRODUCT_VERSION_REPORT API Reference

Operations

ACCOUNT_TAX_EXEMPTION

ACCOUNT_TAX_EXEMPTION API Reference

Operations

ACCOUNT_TRANSACTION_LEDGER

ACCOUNT_TRANSACTION_LEDGER API Reference

Operations

ACCOUNT_TYPE

ACCOUNT_TYPE API Reference

Operations

ACCUMULATOR_VALUE_DETAILS

ACCUMULATOR_VALUE_DETAILS API Reference

Operations

ACCUMULATOR_VALUE_INVOICE

ACCUMULATOR_VALUE_INVOICE API Reference

Operations

ACTIVITY

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

ACTIVITY_COLLECTOR_HISTORY

ACTIVITY_COLLECTOR_HISTORY API Reference

Operations

ADHOC_SCHEDULED_REPORT

ADHOC_SCHEDULED_REPORT API Reference

Operations

ADJUSTMENT

ADJUSTMENT API Reference

Operations

ALERT

ALERT API Reference

Operations

ALERT_BATCH_QUEUE

ALERT_BATCH_QUEUE API Reference

Operations

ALERT_GROUP

ALERT_GROUP API Reference

Operations

ALERT_TYPE

ALERT_TYPE API Reference

Operations

APPLICATION_USER

APPLICATION_USER API Reference

Operations

APPROVAL_HISTORY

APPROVAL_HISTORY API Reference

Operations

APPROVAL_HISTORY_DETAIL

APPROVAL_HISTORY_DETAIL API Reference

Operations

APPROVAL_REQUEST

APPROVAL_REQUEST API Reference

Operations

APPROVAL_REQUEST_DETAIL

APPROVAL_REQUEST_DETAIL API Reference

Operations

AVALARA_REQUEST

AVALARA_REQUEST API Reference

Operations

BILLING_ACTIVITY_DISCOUNT

BILLING_ACTIVITY_DISCOUNT API Reference

Operations

BILLING_ACTIVITY_FORMULA

BILLING_ACTIVITY_FORMULA API Reference

Operations

BILLING_ACTIVITY_TAX

BILLING_ACTIVITY_TAX API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

BILLING_PROFILE

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

Operations

BILLING_PROFILE_LEDGER

BILLING_PROFILE_LEDGER API Reference

Operations

BILLSOFT_TAX_TYPE

BILLSOFT_TAX_TYPE API Reference

Operations

BPPAY_REPORT

BPPAY_REPORT API Reference

Operations

BP_METRICS

BP_METRICS API Reference

Operations

BP_METRICS_LOG

BP_METRICS_LOG API Reference

Operations

BULK_API_REQUEST

BULK_API_REQUEST API Reference

Operations

BULK_APPROVE_REJECT_CREDITS

BULK_APPROVE_REJECT_CREDITS API Reference

Operations

BULK_DATA_LOADER

BULK_DATA_LOADER API Reference

Operations

BULK_RERATE_INVOICES

BULK_RERATE_INVOICES API Reference

Operations

BULK_RESPONSE

BULK_RESPONSE API Reference

Operations

BULK_UPLOAD_HISTORY

BULK_UPLOAD_HISTORY API Reference

Operations

BUNDLE

BUNDLE API Reference

Operations

BUNDLE_CONFIGURATION

BUNDLE_CONFIGURATION API Reference

Operations

BUNDLE_CONTENT

BUNDLE_CONTENT API Reference

Operations

BUNDLE_LOG

BUNDLE_LOG API Reference

Operations

CHARGE_ESTIMATION_RUN_HISTORY

CHARGE_ESTIMATION_RUN_HISTORY API Reference

Operations

COLLECTOR_AGGREGATE_FIELD

COLLECTOR_AGGREGATE_FIELD API Reference

Operations

COLLECTOR_CRITERIA_FIELD

COLLECTOR_CRITERIA_FIELD API Reference

Operations

COLLECTOR_EXT_ENTITY_FIELD

COLLECTOR_EXT_ENTITY_FIELD API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations

COLLECTOR_FIELD_MAPPING

COLLECTOR_FIELD_MAPPING API Reference

Operations

COLLECTOR_LOAD_STATUS

COLLECTOR_LOAD_STATUS API Reference

Operations

COLLECTOR_RERATE_FIELD

COLLECTOR_RERATE_FIELD API Reference

Operations

COLLECTOR_ROLLBACK_QUEUE

COLLECTOR_ROLLBACK_QUEUE API Reference

Operations

COLLECTOR_UPLOAD_PROGRESS

COLLECTOR_UPLOAD_PROGRESS API Reference

Operations

COMMITMENT_INCLUSION_CRITERIA

COMMITMENT_INCLUSION_CRITERIA API Reference

Operations

COMMITMENT_SCOPE

COMMITMENT_SCOPE API Reference

Operations

COMPANY_PROFILE

COMPANY_PROFILE API Reference

Operations

CONDITION

CONDITION API Reference

Operations

CONDITION_GROUP_MEMBER

CONDITION_GROUP_MEMBER API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

CREDIT

CREDIT API Reference

Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_LINE_ITEM

CREDIT_LINE_ITEM API Reference

Operations

CREDIT_TAX_DETAIL

CREDIT_TAX_DETAIL API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

CS_ACCOUNT

CS_ACCOUNT API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACCOUNT_BALANCES

CS_ACCOUNT_BALANCES API Reference

Operations

CS_ACTION

CS_ACTION API Reference

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_EMAIL_ATTACHMENT

CS_EMAIL_ATTACHMENT API Reference

Operations

CS_MODULE_CONFIGURATION

CS_MODULE_CONFIGURATION API Reference

Operations

CS_PTP

CS_PTP API Reference

Operations

CS_PTP_INVOICE

CS_PTP_INVOICE API Reference

Operations

CS_PTP_PAYMENT

CS_PTP_PAYMENT API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

CS_SUMMARY

CS_SUMMARY API Reference

Operations

CURRENCY

CURRENCY API Reference

Operations

CUSTOMER_AUTO_PAYMENT

CUSTOMER_AUTO_PAYMENT API Reference

Operations

CUSTOMER_BILLING_PROFILE

CUSTOMER_BILLING_PROFILE API Reference

Operations

CUSTOM_FIELD_LABEL_VERSION

CUSTOM_FIELD_LABEL_VERSION API Reference

Operations

CUSTOM_FUNCTION

CUSTOM_FUNCTION API Reference

Operations

CUSTOM_REPORT

CUSTOM_REPORT API Reference

Operations

CUSTOM_REPORT_FIELD

CUSTOM_REPORT_FIELD API Reference

Operations

CUSTOM_REPORT_FILTER

CUSTOM_REPORT_FILTER API Reference

Operations

CUSTOM_REPORT_LABEL_VERSION

CUSTOM_REPORT_LABEL_VERSION API Reference

Operations

DATA_SOURCE

DATA_SOURCE API Reference

Operations

DISCOUNT_ELIG_FILTER

DISCOUNT_ELIG_FILTER API Reference

Operations

DISCOUNT_TARGET_FILTER

DISCOUNT_TARGET_FILTER API Reference

Operations

DOCGEN_QUEUE

DOCGEN_QUEUE API Reference

Operations

DOCUMENT_STORAGE

DOCUMENT_STORAGE API Reference

Operations

DOCUMENT_TEMPLATE

DOCUMENT_TEMPLATE API Reference

Operations

DOCUMENT_TEMPLATE_QUERY

DOCUMENT_TEMPLATE_QUERY API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

DUNNING_INTERVAL_EMAIL

DUNNING_INTERVAL_EMAIL API Reference

Operations

ECOM_TRANSACTION

ECOM_TRANSACTION API Reference

Operations

ECOM_TRANSACTION_REQUEST_FIELD

ECOM_TRANSACTION_REQUEST_FIELD API Reference

Operations

ECOM_TRANSACTION_RESPONSE

ECOM_TRANSACTION_RESPONSE API Reference

Operations

ECOM_TRANSACTION_RESP_FIELD

ECOM_TRANSACTION_RESP_FIELD API Reference

Operations

EFILE

EFILE API Reference

Operations

EFILE_EVENT

EFILE_EVENT API Reference

Operations

EFILE_EVENT_CONTENT

EFILE_EVENT_CONTENT API Reference

Operations

EFILE_FORMAT_FIELDS

EFILE_FORMAT_FIELDS API Reference

Operations

EFILE_TEMPLATE

EFILE_TEMPLATE API Reference

Operations

EINVOICE_COUNTRY

EINVOICE_COUNTRY API Reference

Operations

EINVOICE_DOCUMENT_TYPE

EINVOICE_DOCUMENT_TYPE API Reference

Operations

EINVOICE_FORMAT

EINVOICE_FORMAT API Reference

Operations