Sign in

v2

latestOpenAPI 3.0.12026-07-263104131.9 MB
Billing

Updates a product

Updates a previously created product given its ID and updated content.

The content field structure varies by quantity type and must include all required fields for that type (price, cost, taxable, billing, and type-specific fields). See the create product description for details on required fields per quantity type.

Note: The quantity type cannot be changed after product creation.

put/v2/billing/products/{id}

Path parameters

idinteger required

Response

Product successfully updated

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. Includes price, cost, taxable, and other type-specific fields.

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",
  "accountId": 8,
  "taxId": 1,
  "inheritTaxFromAgreement": true,
  "active": true
}