Unbilled charges

Unbilled charge represents the charges that are held by passing invoice_later 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 charge [ JSON ]

API Index URL GET

curl  https://{site}.chargebee.com/api/v2/unbilled_charges \
     -u {site_api_key}:\
     -d subscription_id="__test__5SK2lmRmS627AvF5Z" \
     -d item_prices[item_price_id][0]="ssl-charge-USD"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges \
     -u {site_api_key}:\
     -d subscription_id="__test__5SK2lmRmS627AvF5Z" \
     -d item_prices[item_price_id][0]="ssl-charge-USD"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges \
     -u {site_api_key}:\
     -d subscription_id="__test__5SK2lmRmS627BA25k" \
     -d currency_code="usd" \
     -d charges[amount][1]=100 \
     -d charges[description][1]="Implementation charge"

Sample Response [ JSON ]

{"unbilled_charges": [
    {
        "amount": 500,
        "currency_code": "USD",
        "customer_id": "__test__5SK2lmRmS627Arv5X",
        "date_from": 1517483456,
        "date_to": 1517483456,
        "deleted": false,
        "description": "SSL Charge USD Monthly",
        "discount_amount": 0,
        "entity_id": "ssl-charge-USD",
        "entity_type": "charge_item_price",
        "id": "li___test__5SK2lmRmS627B3A5f",
        "is_voided": false,
        "object": "unbilled_charge",
        "pricing_model": "flat_fee",
        "quantity": 1,
        "subscription_id": "__test__5SK2lmRmS627AvF5Z",
        "unit_amount": 500
    },
    {..}
]}

{"unbilled_charges": [
    {
        "amount": 100,
        "currency_code": "USD",
        "customer_id": "__test__5SK2lmRmS627B6q5i",
        "date_from": 1517483457,
        "date_to": 1517483457,
        "deleted": false,
        "description": "Implementation charge",
        "discount_amount": 0,
        "entity_type": "adhoc",
        "id": "li___test__5SK2lmRmS627BGu5q",
        "is_voided": false,
        "object": "unbilled_charge",
        "pricing_model": "flat_fee",
        "quantity": 1,
        "subscription_id": "__test__5SK2lmRmS627BA25k",
        "unit_amount": 100
    },
    {..}
]}

URL Format POST

Use this API to bill the unbilled charges. Available Credits and Excess Payments will automatically be applied while creating the invoice.

If the Auto Collection is turned on for the particular customer, the invoice will be created in payment_due state and the payment collection will be scheduled immediately.

During invoice creation, the PO number for the line items will be filled from the subscription’s current PO number, if available.

If no recurring item is present in the created invoice, the invoice will be marked as recurring=false.

If consolidated invoicing is enabled and the parameter ‘customer_id’ is passed, multiple invoices can be created based on the following factors.

• Currency
• PO number if ‘Group by PO number’ is enabled
• Shipping address
• Auto Collection
• Payment method

curl  https://{site}.chargebee.com/api/v2/unbilled_charges/invoice_unbilled_charges \
     -X POST  \
     -u {site_api_key}:\
     -d subscription_id="__test__8aszcSOcqxg162"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges/invoice_unbilled_charges \
     -X POST  \
     -u {site_api_key}:\
     -d subscription_id="__test__8aszcSOcqxg162"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges/li___test__8aszcSOcqxX05r/delete \
     -X POST  \
     -u {site_api_key}:

curl  https://{site}.chargebee.com/api/v2/unbilled_charges/li___test__8aszcSOcqxX05r/delete \
     -X POST  \
     -u {site_api_key}:

curl  https://{site}.chargebee.com/api/v2/unbilled_charges \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2 \
     --data-urlencode customer_id[is]="__test__8aszcSOcqy1i6F"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2 \
     --data-urlencode customer_id[is]="__test__8aszcSOcqy1i6F"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges/invoice_now_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d customer_id="__test__8aszcSOcqyER6Q"

curl  https://{site}.chargebee.com/api/v2/unbilled_charges/invoice_now_estimate \
     -X POST  \
     -u {site_api_key}:\
     -d customer_id="__test__8aszcSOcqyER6Q"