Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Billing

Get product by ID

Retrieves a product by its unique identifier.

The content field structure varies by quantity type and includes price, cost, taxable, billing type, and other type-specific configuration fields. See the examples for each quantity type to understand the complete structure.

get/v2/billing/products/{id}

Path parameters

idinteger required

Product ID

Response

Product found

idinteger

Unique identifier of the product.

namestring

Name of the product.

descriptionstring

Description of the product.

quantityType'MANUAL' | 'DEVICE_COUNTS' | 'TIME_ENTRIES' | 'END_USER_COUNTS' | 'BACKUP_STORAGE_COUNTS' | 'SOFTWARE_LICENSE'

Quantity type of the product.

contentobject

Additional content/configuration for the product. Structure varies by quantity type.

integrationSettingsobject

If 3rd party integration is enabled, the settings for exporting invoices with this product.

createTimenumber double

Timestamp when the product was created.

updateTimenumber double

Timestamp when the product was last updated.

accountIdinteger

Account ID associated with the product.

groupboolean

Whether the product is a group product.

taxIdinteger nullable

Tax ID associated with the product. Null if no specific tax is set.

inheritTaxFromAgreementboolean

Whether the product inherits tax from the agreement.

activeboolean

Indicates if the product is active.

Example response

{
  "id": 1,
  "name": "Hardware Support",
  "description": "Monthly hardware support service",
  "quantityType": "DEVICE_COUNTS",
  "productUserRole": {
    "allowAllTechnicians": true,
    "userRoles": [
      {
        "id": 1,
        "name": "Admin"
      }
    ]
  },
  "accountId": 8,
  "taxId": 1,
  "inheritTaxFromAgreement": true,
  "active": true
}