Skip to content

Mercury: Products schemas

4 Mercury schemas with complete fields and constraints.

← Products operations · All schemas

Create a product — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest data to create a product catalog item using the public API
Additional keys: not allowed
descriptionJSONOptional
description (anyOf 1)stringAlternativeOptional description of the product.
description (anyOf 2)nullAlternative
namestringRequired within parentName of the product. Must be unique per organization in combination with the unit price.
Maximum length: 299
Minimum length: 1
unitPriceJSONRequired within parent
unitPrice (allOf 1)numberAll variants applyA dollar amount
Format: double
unitPrice (allOf 2)JSONAll variants applyUnit price of the product, in dollars.

Create a product — response body

FieldTypePresenceDescription and constraints
$objectRootA product catalog item for Accounts Receivable API endpoints
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the product, if any.
description (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyThe ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products.
Format: uuid
id (allOf 2)JSONAll variants applyID of the product.
namestringRequired within parentName of the product.
Maximum length: 299
Minimum length: 1
unitPriceJSONRequired within parent
unitPrice (allOf 1)ModelAll variants applyExpand Create a product — response body — unit Price value
unitPrice (allOf 2)JSONAll variants applyUnit price of the product, in dollars.
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
updatedAt (allOf 2)JSONAll variants applyThe time the product's current details were last set.

Referenced models: Create a product — response body — unit Price value

Create a product — response body — unit Price value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA dollar amount
Format: double
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List all products — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response data for Accounts Receivable products API endpoint
pageobjectRequired within parentPagination cursors for navigating to next/previous pages
page.nextPagestringOptionalThe ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products.
Format: uuid
page.previousPagestringOptionalThe ID of an invoicing product. Use the /api/v1/ar/products endpoint to list your products.
Format: uuid
productsarrayRequired within parentThe list of products for this page
products[]ModelEach itemExpand Create a product — response body

Referenced models: Create a product — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.