Documentation
Documentation
    • English (United States)
Subscription Ledger Entry
Close
Subscription Ledger Entry

The subscription ledger entry represents a single change on the subscription balance.

States
  • Open
    The ledger entry is not assigned to a charge.
  • Scheduled
    The ledger entry is scheduled to be paid.
  • Paid
    The ledger entry is linked with a charge which has been paid.
Properties
  • Aggregated Tax Rate
    The total tax rate applied to the ledger entry, calculated from the rates of all tax lines.
  • Amount Excluding Tax
    The leger entry's amount with discounts applied, excluding taxes.
  • Amount Including Tax
    The leger entry's amount with discounts applied, including taxes.
  • Created By
    The ID of the user the ledger entry was created by.
  • Created On
    The date and time when the object was created.
  • Discount Including Tax
    The discount allocated to the ledger entry, including taxes.
  • External ID
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Pro Rata Calculated
  • Quantity
    The number of items that were consumed.
  • State
    The object's current state.
  • Subscription Version
    The subscription version that the ledger entry belongs to.
  • Tax Amount
    The sum of all taxes applied to the ledger entry.
  • Taxes
    A set of tax lines, each of which specifies a tax applied to the ledger entry.
  • Title
    The title that indicates what the ledger entry is about.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.