API Docs / Schemas / UpdateClientBillingScheduleItemRequest

UpdateClientBillingScheduleItemRequest

Request to edit one scheduled occurrence: its billing date, amount and description. The date is
always pinned and marks the item edited, so a later reconcile leaves it alone. A null quantity,
price or description clears any override and goes back to following the service's billing rule.
Only a Scheduled item can be edited.

Properties

Name Type Description
billingDate*string

The date to bill the occurrence on

The date to bill the occurrence on

quantitynumber

The quantity to bill. Leave null to keep taking it from the rule.

The quantity to bill. Leave null to keep taking it from the rule.

unitPricenumber

The unit price to bill at. Leave null to keep taking it from the rule.

The unit price to bill at. Leave null to keep taking it from the rule.

descriptionstring

The invoice line description. Leave null to keep deriving it from the rule's template at promotion.

The invoice line description. Leave null to keep deriving it from the rule's template at promotion.

JSON Example

{
  "billingDate": "2024-01-01",
  "quantity": 0.01,
  "unitPrice": 0,
  "description": "string"
}

Used By Operations