Unbilled charge represents the charges that are held by passing invoice_immediately in various operations such as update subscription, add charge, create subscription, etc. Learn more.
If any invoice is to be created for a subscription all the unbilled charges associated with the subscription will be included in that invoice.
If any invoice is to be created for a customer, all the unbilled charges associated with its subscriptions will be included in that invoice.
Any automatic invoice creation like renewal, activation, etc., will include the unbilled charges.
Subscriptions are invoiced at the start of every term based on the recurring items and charged immediately against the customer's credit card if 'auto_collection' is turned 'on', otherwise the resulting invoice will be created as 'Payment Due'.
If consolidated invoicing is enabled, the charges during the subscription renewals/activations will be held and consolidated at the last renewal/activation that takes place on that particular day.
Sample Unbilled chargeJSON
Unbilled charges attributes
A unique identifier for the subscription this charge belongs to.
The pricing scheme for this line item.
A fixed price that is not quantity-based.
A fixed price per unit quantity.
There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
The per unit price is based on the tier that the total quantity falls in.
A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
Total amount of this charge. Typically equals to unit amount x quantity.
Specifies the modelled entity this line item is based on.
Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
Indicates that this line item is based on plan Item Price
Indicates that this line item is based on addon Item Price
Indicates that this line item is based on charge Item Price
The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
Timestamp indicating the date and time this charge got voided.
The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and multi-decimal pricing is enabled.
The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and multi-decimal pricing is enabled.
The decimal representation of the amount for the charge, in major units of the currency. Typically equals to unit_amount_in_decimal
x quantity_in_decimal.
Returned when multi-decimal pricing
is enabled.
Timestamp indicating when the unbilled charge was last updated
The value of this parameter will be true if it is a recurring unbilled charge for a future term.
The unique ID of the business entity of this unbilled charge. This is always the same as the business entity of the customer.