Overage

An overage represents usage or consumption that exceeds the included allowance in a subscription plan, resulting in additional charges.

Properties

• id (string): Unique identifier for the overage.
• object (string): String representing the object's type (always "overage").
• subscription ([[Subscription]]): ID of the subscription with the overage.
• customer ([[Customer]]): ID of the customer incurring the overage.
• entitlement ([[Entitlement]]): ID of the entitlement that was exceeded.
• feature (string): Name of the feature or resource with overage.
• includedQuantity (number): Quantity included in the plan.
• usedQuantity (number): Total quantity used.
• overageQuantity (number): Quantity over the included amount.
• unitPrice (number): Price per unit of overage in cents.
• totalAmount (number): Total overage charge in cents.
• periodStart (number): Start of the billing period (Unix timestamp).
• periodEnd (number): End of the billing period (Unix timestamp).
• invoice ([[Invoice]]): ID of the invoice containing the overage charge.
• metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Record a new overage.

Input: [[Overage]]
Output: [[Overage]]

retrieve

Retrieve the details of an overage.

Input: [[Overage]]
Output: [[Overage]]

calculate

Calculate overage for a period.

Input: [[OverageRequest]]
Output: [[Overage]]

invoice

Generate invoice for overage charges.

Input: [[Overage]]
Output: [[Invoice]]

list

Return a list of overages.

Input: [[ListRequest]]
Output: [[OverageList]]

Events

• created: Triggered when an overage is recorded.
• detected: Triggered when overage usage is detected.
• calculated: Triggered when overage charge is calculated.
• invoiced: Triggered when overage is added to an invoice.
• thresholdReached: Triggered when overage reaches a threshold.