v1
latestOpenAPI 3.0.02026-07-263403911.5 MBView service product
Find a single service product by ID.
Path parameters
Format - int32. ID of the service product to view.
Response
OK
Primary identifier for this service product.
ID of associated customer account.
ID of source product from catalog.
ID of the package of which this product is a member.
ID of the associated service.
Contains the description of the product that will display on the bill.
Supports provisioning codes for electronic ordering and provisioning with providers (i.e. USOC). This will be different for all electronic provisioning integrations.
Used for ordering and provisioning with providers (i.e. FID). This will be different for all electronic provisioning integrations.
Rate that will be passed on to the customer. Please use only positive numbers. Use the credit_flag field to pass a credit product.
The last day a customer was billed for this product.
The effective day of cancellation.
The current status of the service product.
The date this service product entered its current status.
ID of the user responsible for the product's current status.
Date this product became active or billable.
Your company's cost for this service product. Used in relation to Rate to calculate margin.
A secondary description of the product, typically related to provider-side naming. Not visible to end users through typical means, but may be exposed via reporting at your discretion.
Notes the start of a time frame for which this product is free.
Notes the end of a time frame for which this product is free.
Number of this type of product provided to end user. This is multiplied by the Rate field when calculating a recurring charge.
Beginning date for a contract to provide this service product.
Ending date for a contract to provide this service product.
Ending date for the automatic expiration for this service product.
The date this service product was added to the system.
Indicates total amount of charge should not exceed the value in rate. The base amount is adjusted dynamically on charges produced each month, to ensure base + tax = rate.
Applicable only to products that are a part of a package. Indicates this product's rate should be grouped into a sum package amount when displayed on a bill.
Applicable only to products that are a part of a package and grouped. Indicates that, although their price is grouped, the name of the product will still show indented underneath on the bill, but with no individual price displayed.
Determines the type of service product.