EBB Component

API Docs by APIMATIC
Advanced Billing APIModelsStructures

EBB Component
#

NameDescription
name
REQUIRED
String

A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes".

unit_name
REQUIRED
String

The name of the unit of measurement for the component. It should be singular since it will be automatically pluralized when necessary. i.e. “message”, which may then be shown as “5 messages” on a subscription’s component line-item

description
String

A description for the component that will be displayed to the user on the hosted signup page.

handle
String

A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.

Constraints: Pattern: ^[a-z0-9][a-z0-9\-_:.]*$

taxable
Boolean

Boolean flag describing whether a component is taxable or not.

pricing_scheme
REQUIRED

The identifier for the pricing scheme. See Product Components for an overview of pricing schemes.

prices

(Not required for ‘per_unit’ pricing schemes) One or more price brackets. See Price Bracket Rules for an overview of how price brackets work for different pricing schemes.

price_points
unit_price
tax_code
String

A string representing the tax code related to the component type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters.

hide_date_range_on_invoice
Boolean

(Only available on Relationship Invoicing sites) Boolean flag describing if the service date range should show for the component on generated invoices.

event_based_billing_metric_id
REQUIRED
Number

The ID of an event based billing metric that will be attached to this component.

interval
Number

The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component's default price point would renew every 30 days. This property is only available for sites with Multifrequency enabled.

interval_unit

A string representing the interval unit for this component's default price point, either month or day. This property is only available for sites with Multifrequency enabled.

  • HTTP
  • Java
  • .NET
  • PHP
  • Python
  • Ruby
  • TypeScript
  • Go
{
  "name": "name0",
  "unit_name": "unit_name2",
  "description": "description0",
  "handle": "handle6",
  "taxable": false,
  "pricing_scheme": "per_unit",
  "prices": [
    {
      "starting_quantity": 242,
      "ending_quantity": 40,
      "unit_price": 23.26
    }
  ],
  "price_points": [
    {
      "name": "name2",
      "handle": "handle8",
      "pricing_scheme": "per_unit",
      "interval": 92,
      "interval_unit": "day"
    }
  ],
  "event_based_billing_metric_id": 190
}