Sign in
Contracts

Update a contract line.

patch/v2/contracts/{contract_id}/lines/{line_id}

Path parameters

contract_idstring required
line_idstring required

Request body

price_idstring

LedgerUp resource identifier.

rate_card_idstring

LedgerUp resource identifier.

descriptionstring nullable
quantitystring nullable
starts_atinteger

Unix timestamp in seconds.

ends_atinteger

Unix timestamp in seconds.

billing_timing'advance' | 'arrears' | 'point_in_time'

Whether the line is billed before or after the service period.

proration'none' | 'prorate'

How partial periods are handled.

{"stackTrail":"components:schemas:Properties","oasType":"schema","type":"unknown","description":"Arbitrary JSON object or value. If omitted on write endpoints, the service stores an empty object."}

Example request

{
  "starts_at": 1767225600,
  "ends_at": 1767225600,
  "billing_timing": "arrears",
  "proration": "prorate"
}

Response

Success.

idstring required

LedgerUp resource identifier.

contract_idstring required

LedgerUp resource identifier.

price_idstring required

LedgerUp resource identifier.

rate_card_idstring required

LedgerUp resource identifier.

descriptionstring nullable required
quantitystring required
status'active' | 'canceled' | 'ended' required
starts_atinteger required

Unix timestamp in seconds.

ends_atinteger required

Unix timestamp in seconds.

billing_timing'advance' | 'arrears' | 'point_in_time' required

Whether the line is billed before or after the service period.

proration'none' | 'prorate' required

How partial periods are handled.

{"stackTrail":"components:schemas:Properties","oasType":"schema","type":"unknown","description":"Arbitrary JSON object or value. If omitted on write endpoints, the service stores an empty object."}
created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

canceled_atinteger required

Unix timestamp in seconds.

cancel_atinteger required

Unix timestamp in seconds.

Example response

{
  "quantity": "1",
  "status": "active",
  "starts_at": 1767225600,
  "ends_at": 1767225600,
  "billing_timing": "arrears",
  "proration": "prorate",
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "canceled_at": 1767225600,
  "cancel_at": 1767225600
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.