Skip to content

Create price book

POST/revenue/price-books

Creates a new price book with a currency and effective date. Price books become available for subscription assignment once created. Mark older price books as inactive rather than deleting them to preserve subscription history.

Request

Request body

Content type application/json (required).

FieldTypeRequiredDescription
namestringYes

Max length: 255

currencystringYes

ISO 4217 three-letter currency code.

Max length: 3

is_activebooleanNo

Default: true

effective_datestring (date)No
notesstringNo

Example

{
  "name": "Enterprise 2026",
  "currency": "USD",
  "is_active": true,
  "effective_date": "2026-01-01",
  "notes": "Approved pricing for all enterprise-tier customers from Jan 2026."
}

Responses

201 Price book created

Content type application/json, object · RevenuePriceBookV1.

FieldTypeRequiredDescription
idintegerNo
namestringNo

Human-readable price book name.

currencystringNo

ISO 4217 currency code this price book is denominated in.

Max length: 3

is_activebooleanNo

Whether the price book is available for new subscription assignments.

effective_datestring (date)No

Date from which this price book is valid.

notesstring, nullableNo
created_atstring (date-time)No

422 Validation failed — check currency code or effective_date format

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/revenue/price-books" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name": "Enterprise 2026", "currency": "USD", "is_active": true, "effective_date": "2026-01-01", "notes": "Approved pricing for all enterprise-tier customers from Jan 2026."}'
Loading