Skip to main content
POST
Create revenue record

Authorizations

Authorization
string
header
required

API key prefixed with cr_ (e.g. cr_a1b2c3...)

Body

application/json
entity_id
string<uuid>
required
client_name
string
required
type
enum<string>
required
Available options:
recurring,
project,
one_time
amount_cents
integer
required
website_id
string<uuid>
currency
string
default:USD
billing_frequency
enum<string>
Available options:
monthly,
quarterly,
semi_annual,
annual
status
enum<string>
default:active
Available options:
active,
paused,
churned,
completed
next_invoice_date
string<date>
renewal_date
string<date>
payment_terms
string
started_at
string<date-time>
notes
string
product_line_id
string<uuid>

Response

Created revenue record

success
boolean
required
data
object