Skip to main content
PUT
Update Revenue Contract Line

Path Parameters

id
integer
required

Body

Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.

contract
integer
required
product_name
string
required
Maximum string length: 255
ordinal
integer
Required range: 0 <= x <= 2147483647
product
integer | null
product_bundle
integer | null
rate_card
integer | null

Rate card used to price usage reported against this line.

product_sku
string
Maximum string length: 255
description
string
currency
string
Maximum string length: 3
quantity
number<double>
Required range: -100000000000 < x < 100000000000
unit_price
number<double>
Required range: -1000000000000000 < x < 1000000000000000
discount
number<double>
Required range: -10000000000000 < x < 10000000000000
discount_percent
number<double> | null

When set, the line discount is this percentage of quantity × unit price and discount holds the resulting amount; null means the discount was entered as an amount.

Required range: -1000 < x < 1000
transaction_price
number<double>
Required range: -10000000000000 < x < 10000000000000
service_start
string<date> | null
service_end
string<date> | null
first_invoice_date
string<date> | null

Date the first invoice is issued; later invoices follow one billing cadence apart. Defaults to service start. Service periods stay on the contract's dates.

exclude_from_allocation
boolean
is_mrr
boolean
billing_cadence
enum<string>
  • MONTHLY - Monthly
  • QUARTERLY - Quarterly
  • SEMI_ANNUAL - Semi-annual
  • ANNUAL - Annual
  • ONE_TIME - One Time
  • CUSTOM - Custom
Available options:
MONTHLY,
QUARTERLY,
SEMI_ANNUAL,
ANNUAL,
ONE_TIME,
CUSTOM
billing_timing
enum<string>
  • ADVANCE - In advance (start of period)
  • ARREARS - In arrears (end of period)
  • ON_DEMAND - On Demand (In arrears from usage)
Available options:
ADVANCE,
ARREARS,
ON_DEMAND
invoice_calculation
enum<string>
  • FIXED_RATE - Fixed Rate
  • FIXED_QUANTITY - Fixed Quantity
Available options:
FIXED_RATE,
FIXED_QUANTITY
net_terms
integer | null
Required range: 0 <= x <= 2147483647
department
integer | null
tags
integer[]

Response

200 - application/json

Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.

id
integer
required
read-only
contract
integer
required
contract_name
string
required
read-only
rate_card_name
string | null
required
read-only
product_name
string
required
Maximum string length: 255
overage_rate
number<double> | null
required
read-only
Required range: -1000000000000000 < x < 1000000000000000
overage_cadence
required
  • MONTHLY - Monthly
  • QUARTERLY - Quarterly
  • SEMI_ANNUAL - Semi-annual
  • ANNUAL - Annual
  • ONE_TIME - One Time
  • CUSTOM - Custom
Available options:
MONTHLY,
QUARTERLY,
SEMI_ANNUAL,
ANNUAL,
ONE_TIME,
CUSTOM
department_name
string
default:""
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
ordinal
integer
Required range: 0 <= x <= 2147483647
product
integer | null
product_bundle
integer | null
rate_card
integer | null

Rate card used to price usage reported against this line.

product_sku
string
Maximum string length: 255
description
string
currency
string
Maximum string length: 3
quantity
number<double>
Required range: -100000000000 < x < 100000000000
unit_price
number<double>
Required range: -1000000000000000 < x < 1000000000000000
discount
number<double>
Required range: -10000000000000 < x < 10000000000000
discount_percent
number<double> | null

When set, the line discount is this percentage of quantity × unit price and discount holds the resulting amount; null means the discount was entered as an amount.

Required range: -1000 < x < 1000
transaction_price
number<double>
Required range: -10000000000000 < x < 10000000000000
service_start
string<date> | null
service_end
string<date> | null
first_invoice_date
string<date> | null

Date the first invoice is issued; later invoices follow one billing cadence apart. Defaults to service start. Service periods stay on the contract's dates.

exclude_from_allocation
boolean
is_mrr
boolean
billing_cadence
enum<string>
  • MONTHLY - Monthly
  • QUARTERLY - Quarterly
  • SEMI_ANNUAL - Semi-annual
  • ANNUAL - Annual
  • ONE_TIME - One Time
  • CUSTOM - Custom
Available options:
MONTHLY,
QUARTERLY,
SEMI_ANNUAL,
ANNUAL,
ONE_TIME,
CUSTOM
billing_timing
enum<string>
  • ADVANCE - In advance (start of period)
  • ARREARS - In arrears (end of period)
  • ON_DEMAND - On Demand (In arrears from usage)
Available options:
ADVANCE,
ARREARS,
ON_DEMAND
invoice_calculation
enum<string>
  • FIXED_RATE - Fixed Rate
  • FIXED_QUANTITY - Fixed Quantity
Available options:
FIXED_RATE,
FIXED_QUANTITY
net_terms
integer | null
Required range: 0 <= x <= 2147483647
department
integer | null
tags
integer[]