Settings
API Version
Product Catalog
Library

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 ]

{ "unbilled_charges": [ { "amount": 200, "currency_code": "USD", "customer_id": "__test__8asyaSyvdsRW9", "date_from": 1517490343, "date_to": 1517490343, "deleted": false, "description": "non_recurring_addon", "discount_amount": 0, "entity_id": "non_recurring_addon", "entity_type": "addon", "id": "li___test__8asyaSyvdyLvK", "is_voided": false, "object": "unbilled_charge", "pricing_model": "per_unit", "quantity": 2, "subscription_id": "__test__8asyaSyvdtlIC", "unit_amount": 100 }, { "amount": 100, "currency_code": "USD", "customer_id": "__test__8asyaSyvdsRW9", "date_from": 1517490343, "date_to": 1517490343, "deleted": false, "description": "ad_hoc", "discount_amount": 0, "entity_type": "adhoc", "id": "li___test__8asyaSyvdyKzJ", "is_voided": false, "object": "unbilled_charge", "pricing_model": "flat_fee", "quantity": 1, "subscription_id": "__test__8asyaSyvdtlIC", "unit_amount": 100 } ] }

API Index URL GET

https://{site}.chargebee.com/api/v2/unbilled_charges

Model Class

Chargebee\Resources\UnbilledCharge\UnbilledCharge

Unbilled charge attributes

id
optional, string, max chars=40
Uniquely identifies an unbilled charge.
customer_id
optional, string, max chars=50
A unique identifier for the customer being charged.
subscription_id
optional, string, max chars=50
A unique identifier for the subscription this charge belongs to.
date_from
optional, timestamp(UTC) in seconds
Start date of this charge.
date_to
optional, timestamp(UTC) in seconds
End date of this charge.
unit_amount
optional, in cents, min=0
Unit amount of the charge item.
pricing_model
optional, enumerated string
The pricing scheme for this line item.
Possible values are
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.volumeThe per unit price is based on the tier that the total quantity falls in.stairstepA quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.volumeThe per unit price is based on the tier that the total quantity falls in.
stairstepA quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
Show all values[+]
quantity
optional, integer, min=0
Quantity of the item which is represented by this charge.
amount
optional, in cents, min=0
Total amount of this charge. Typically equals to unit amount x quantity.
currency_code
string, max chars=3
The currency code (ISO 4217 format) for the charge.
discount_amount
optional, in cents, min=0
Total discounts for this charge.
description
optional, string, max chars=250
Detailed description about this charge.
entity_type
enumerated string
Specifies the modelled entity this line item is based on.
Possible values are
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan idplanIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan idaddonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon idadhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan idplanIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan idaddonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon idadhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
Show all values[+]
entity_id
optional, string, max chars=100
The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
is_voided
boolean, default=false
Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
voided_at
optional, timestamp(UTC) in seconds
Timestamp indicating the date and time this charge got voided.
unit_amount_in_decimal
optional, string, max chars=39
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.
quantity_in_decimal
optional, string, max chars=33
The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and multi-decimal pricing is enabled.
amount_in_decimal
optional, string, max chars=39
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.
updated_at
timestamp(UTC) in seconds
Timestamp indicating when the unbilled charge was last updated
is_advance_charge
optional, boolean, default=false
The value of this parameter will be true if it is a recurring unbilled charge for a future term.
business_entity_id
optional, string, max chars=50
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
Note

Multiple Business Entities is a feature available only on Product Catalog 2.0.
deleted
boolean
Indicates that this resource has been deleted.
tiers
Show attributes [+]
optional, list of line_item_tier
The list of tiers applicable for this line item
id id
optional, string, max chars=40
Uniquely identifies an unbilled charge.
customer_id customer_id
optional, string, max chars=50
A unique identifier for the customer being charged.
subscription_id subscription_id
optional, string, max chars=50
A unique identifier for the subscription this charge belongs to.
date_from date_from
optional, timestamp(UTC) in seconds
Start date of this charge.
date_to date_to
optional, timestamp(UTC) in seconds
End date of this charge.
unit_amount unit_amount
optional, in cents, min=0
Unit amount of the charge item.
pricing_model pricing_model
optional, enumerated string
The pricing scheme for this line item.
Possible values are
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.volumeThe per unit price is based on the tier that the total quantity falls in.stairstepA quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
flat_feeA fixed price that is not quantity-based.per_unitA fixed price per unit quantity.tieredThere are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.volumeThe per unit price is based on the tier that the total quantity falls in.
stairstepA quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
Show all values[+]
quantity quantity
optional, integer, min=0
Quantity of the item which is represented by this charge.
amount amount
optional, in cents, min=0
Total amount of this charge. Typically equals to unit amount x quantity.
currency_code currency_code
string, max chars=3
The currency code (ISO 4217 format) for the charge.
discount_amount discount_amount
optional, in cents, min=0
Total discounts for this charge.
description description
optional, string, max chars=250
Detailed description about this charge.
entity_type entity_type
enumerated string
Specifies the modelled entity this line item is based on.
Possible values are
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan idplanIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan idaddonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon idadhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
plan_setupIndicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the plan idplanIndicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the plan idaddonIndicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the addon idadhocIndicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case
Show all values[+]
entity_id entity_id
optional, string, max chars=100
The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
is_voided is_voided
boolean, default=false
Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
voided_at voided_at
optional, timestamp(UTC) in seconds
Timestamp indicating the date and time this charge got voided.
unit_amount_in_decimal unit_amount_in_decimal
optional, string, max chars=39
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.
quantity_in_decimal quantity_in_decimal
optional, string, max chars=33
The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and multi-decimal pricing is enabled.
amount_in_decimal amount_in_decimal
optional, string, max chars=39
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.
updated_at updated_at
timestamp(UTC) in seconds
Timestamp indicating when the unbilled charge was last updated
is_advance_charge is_advance_charge
optional, boolean, default=false
The value of this parameter will be true if it is a recurring unbilled charge for a future term.
business_entity_id business_entity_id
optional, string, max chars=50
The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
Note

Multiple Business Entities is a feature available only on Product Catalog 2.0.
deleted deleted
boolean
Indicates that this resource has been deleted.
tiers
optional, list of line_item_tier
The list of tiers applicable for this line item

Consent Fields for Unbilled charge

Custom Fields for Unbilled charge

Create unbilled charges for a subscription

Idempotency Supported
Create unbilled charges for a subscription using this API.

Notes

Sample Codes 
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->createUnbilledCharge([
    "subscription_id" => "__test__8asyaSyvdtlIC",
    "addons" => [
    [
      "id" => "non_recurring_addon",
      "quantity" => 2
    ]
  ],
    "charges" => [
    [
      "amount" => 100,
      "description" => "ad_hoc"
    ]
  ]
]);
$unbilledCharges = $result->unbilled_charges;
copy
Click to Copy
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->createUnbilledCharge([
    "subscription_id" => "__test__8asyaSyvdtlIC",
    "addons" => [
    [
      "id" => "non_recurring_addon",
      "quantity" => 2
    ]
  ],
    "charges" => [
    [
      "amount" => 100,
      "description" => "ad_hoc"
    ]
  ]
]);
$unbilledCharges = $result->unbilled_charges;

Sample Result [ JSON ]

Show more...
{
    "unbilled_charges": [
        {
            "amount": 200,
            "currency_code": "USD",
            "customer_id": "__test__8asyaSyvdsRW9",
            "date_from": 1517490343,
            "date_to": 1517490343,
            "deleted": false,
            "description": "non_recurring_addon",
            "discount_amount": 0,
            "entity_id": "non_recurring_addon",
            "entity_type": "addon",
            "id": "li___test__8asyaSyvdyLvK",
            "is_voided": false,
            "object": "unbilled_charge",
            "pricing_model": "per_unit",
            "quantity": 2,
            "subscription_id": "__test__8asyaSyvdtlIC",
            "unit_amount": 100
        },
        {..}
    ]
}

URL Format POST

https://{site}.chargebee.com/api/v2/unbilled_charges/create

Method

$chargebee->unbilledCharge->createUnbilledCharge([<param name> : <value>,<param name> : <value> ...])

Input Parameters

subscription_id[]
required, string, max chars=50
Identifier of the subscription for which this unbilled charges needs to be created.
currency_code[]
required if Multicurrency is enabled, string, max chars=3
The currency code (ISO 4217 format) of the unbilled_charge.
id
optional, string, max chars=100
Identifier of the addon. Multiple addons can be passed.
quantity
optional, integer, default=1, min=1
Quantity of the addon. Applicable for addons with pricing_model other than flat_fee.
unit_price
optional, in cents, min=0

The price or per-unit-price of the addon. The value depends on the type of currency.

Note:

For recurring addons, this is the final price or per-unit price for each billing period of the subscription, regardless of the addon period. For example, consider the following details:

  • The unit_price provided is $10
  • The addon billing period is 1 month.
  • The plan billing period is 3 months.
  • The addon is only billed for $10 on each subscription renewal.
quantity_in_decimal
optional, string, max chars=33
The decimal representation of the quantity of the non-recurring addon. Provide the value in major units of the currency. Must be provided when the addon is quantity-based. This parameter can only be passed when multi-decimal pricing is enabled.
unit_price_in_decimal
optional, string, max chars=39
When price overriding is enabled for the site, the price or per-unit price of the non-recurring addon can be set here. The value set for the addon is used by default. Provide the value as a decimal string in major units of the currency. This parameter can only be passed when multi-decimal pricing is enabled.
date_from
optional, timestamp(UTC) in seconds
The time when the service period for the addon starts.
date_to
optional, timestamp(UTC) in seconds
The time when the service period for the addon ends.
amount
optional, in cents, min=1
The amount to be charged. The unit depends on the type of currency.
amount_in_decimal
optional, string, max chars=39
The decimal representation of the amount for the one-time charge. Provide the value in major units of the currency. Can be provided only when multi-decimal pricing is enabled.
description
optional, string, max chars=250
Description for this charge
taxable
optional, boolean, default=true
The amount to be charged is taxable or not.
tax_profile_id
optional, string, max chars=50
Tax profile of the charge.
avalara_tax_code
optional, string, max chars=50
The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's AvaTax for Sales integration.
hsn_code
optional, string, max chars=50
The HSN code to which the item is mapped for calculating the customer’s tax in India. Applicable only when both of the following conditions are true:
taxjar_product_code
optional, string, max chars=50
The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's TaxJar integration.
avalara_sale_type
optional, enumerated string
Indicates the type of sale carried out. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
Possible values are
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
wholesaleTransaction is a sale to another company that will resell your product or service to another consumerretailTransaction is a sale to an end userconsumedTransaction is for an item that is consumed directlyvendor_useTransaction is for an item that is subject to vendor use tax
Show all values[+]
avalara_transaction_type
optional, integer
Indicates the type of product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
avalara_service_type
optional, integer
Indicates the type of service for the product to be taxed. Values for this field can be taken from Avalara. This is applicable only if you use Chargebee’s AvaTax for Communications integration.
date_from
optional, timestamp(UTC) in seconds
The time when the service period for the charge starts.
date_to
optional, timestamp(UTC) in seconds
The time when the service period for the charge ends.
provider_name
optional, string, max chars=50
Name of the tax provider currently supported.
field_id
optional, string, max chars=50
Field id of the attribute which tax vendor has provided while getting onboarded with us.
field_value
optional, string, max chars=50
The value of the corresponding tax field.

Returns

unbilled_charges unbilled_charges
always returned
Resource object representing unbilled_charge

Sample admin console URL

https://{site}.chargebee.com/admin-console/unbilled_charges/123x

Create an invoice for unbilled charges

Idempotency Supported

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

Notes

Sample Codes 
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->invoiceUnbilledCharges([
    "subscription_id" => "__test__KyVnHhSBWSjWC2p"
]);
$invoices = $result->invoices;
copy
Click to Copy
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->invoiceUnbilledCharges([
    "subscription_id" => "__test__KyVnHhSBWSjWC2p"
]);
$invoices = $result->invoices;

Sample Result [ JSON ]

Show more...
{
    "invoices": [
        {
            "adjustment_credit_notes": [],
            "amount_adjusted": 0,
            "amount_due": 895,
            "amount_paid": 0,
            "amount_to_collect": 895,
            "applied_credits": [],
            "base_currency_code": "USD",
            "credits_applied": 0,
            "currency_code": "USD",
            "customer_id": "__test__KyVnHhSBWSjWC2p",
            "date": 1517501348,
            "deleted": false,
            "due_date": 1517501348,
            "dunning_attempts": [],
            "exchange_rate": 1,
            "first_invoice": true,
            "has_advance_charges": false,
            "id": "__demo_inv__1",
            "is_gifted": false,
            "issued_credit_notes": [],
            "line_items": [
                {
                    "amount": 895,
                    "customer_id": "__test__KyVnHhSBWSjWC2p",
                    "date_from": 1517501348,
                    "date_to": 1519920548,
                    "description": "No Trial",
                    "discount_amount": 0,
                    "entity_id": "no_trial",
                    "entity_type": "plan",
                    "id": "li___test__KyVnHhSBWSjXc2r",
                    "is_taxed": false,
                    "item_level_discount_amount": 0,
                    "object": "line_item",
                    "pricing_model": "per_unit",
                    "quantity": 1,
                    "subscription_id": "__test__KyVnHhSBWSjWC2p",
                    "tax_amount": 0,
                    "tax_exempt_reason": "tax_not_configured",
                    "unit_amount": 895
                },
                {..}
            ],
            "linked_orders": [],
            "linked_payments": [],
            "net_term_days": 0,
            "new_sales_amount": 895,
            "object": "invoice",
            "price_type": "tax_exclusive",
            "recurring": true,
            "resource_version": 1517501348000,
            "round_off_amount": 0,
            "status": "payment_due",
            "sub_total": 895,
            "subscription_id": "__test__KyVnHhSBWSjWC2p",
            "tax": 0,
            "term_finalized": true,
            "total": 895,
            "updated_at": 1517501348,
            "write_off_amount": 0
        },
        {..}
    ]
}

URL Format POST

https://{site}.chargebee.com/api/v2/unbilled_charges/invoice_unbilled_charges

Method

$chargebee->unbilledCharge->invoiceUnbilledCharges([<param name> : <value>,<param name> : <value> ...])

Input Parameters

subscription_id[]
optional, string, max chars=50
Identifier of the subscription for which this invoice needs to be created. Should be specified if 'customer_id' is not specified.
customer_id[]
optional, string, max chars=50
Identifier of the customer for whom this invoice needs to be created. Should be specified if 'subscription_id' is not specified. Applicable only if the consolidated invoicing is enabled. .

Returns

invoices invoices
always returned
Resource object representing invoice

Sample admin console URL

https://{site}.chargebee.com/admin-console/unbilled_charges/123x

Delete an unbilled charge

Idempotency Supported
Use this API to delete an unbilled charge by specifying the id of the charge.

Notes

Sample Codes 
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->delete("li___test__KyVnHhSBWSjQY2g");
$unbilledCharge = $result->unbilled_charge;
copy
Click to Copy
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->delete("li___test__KyVnHhSBWSjQY2g");
$unbilledCharge = $result->unbilled_charge;

Sample Result [ JSON ]

Show more...
{
    "unbilled_charge": {
        "amount": 895,
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWSjBm2e",
        "date_from": 1517501348,
        "date_to": 1519920548,
        "deleted": false,
        "description": "No Trial",
        "discount_amount": 0,
        "entity_id": "no_trial",
        "entity_type": "plan",
        "id": "li___test__KyVnHhSBWSjQY2g",
        "is_voided": false,
        "object": "unbilled_charge",
        "pricing_model": "per_unit",
        "quantity": 1,
        "subscription_id": "__test__KyVnHhSBWSjBm2e",
        "unit_amount": 895
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/unbilled_charges/{unbilled-charge-id}/delete

Method

$chargebee->unbilledCharge->delete(<unbilled_charge_id>,[<param name> : <value>,<param name> : <value> ...])

Returns

unbilled_charge unbilled_charge
always returned
Resource object representing unbilled_charge

Sample admin console URL

https://{site}.chargebee.com/admin-console/unbilled_charges/123x

List unbilled charges

This endpoint lists all the unbilled charges.

Notes

Sample Codes 
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->all([
    "limit" => 2,
  "customer_id" => [ "is" => "__test__KyVnHhSBWSjfS30" ]
]);
foreach($result->list as $entry){
  $unbilledCharge = $entry->unbilled_charge;
}
copy
Click to Copy
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->all([
    "limit" => 2,
  "customer_id" => [ "is" => "__test__KyVnHhSBWSjfS30" ]
]);
foreach($result->list as $entry){
  $unbilledCharge = $entry->unbilled_charge;
}

Sample Result [ JSON ]

Show more...
{
    "list": [
        {
            "unbilled_charge": {
                "amount": 895,
                "currency_code": "USD",
                "customer_id": "__test__KyVnHhSBWSjfS30",
                "date_from": 1517501349,
                "date_to": 1519920549,
                "deleted": false,
                "description": "No Trial",
                "discount_amount": 0,
                "entity_id": "no_trial",
                "entity_type": "plan",
                "id": "li___test__KyVnHhSBWSjhc32",
                "is_voided": false,
                "object": "unbilled_charge",
                "pricing_model": "per_unit",
                "quantity": 1,
                "subscription_id": "__test__KyVnHhSBWSjfS30",
                "unit_amount": 895
            }
        },
        {..}
    ]
}

URL Format GET

https://{site}.chargebee.com/api/v2/unbilled_charges

Method

$chargebee->unbilledCharge->all([<param name> : <value>,<param name> : <value> ...])

Input Parameters

limit[]
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset[]
optional, string, max chars=1000
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.
include_deleted[]
optional, boolean, default=false
If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted' attribute will be 'true'.
is_voided[]
optional, boolean, default=false
Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
Filter Params
For operator usages, see the Pagination and Filtering section.
subscription_id[<operator>]
optional, string filter
A unique identifier for the subscription this charge belongs to. Possible values are :
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → "subscription_id[is] = "5hjdk8nOpd0b12"
is[<operator>]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example →
is_not[<operator>]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example →
starts_with[<operator>]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example →
is_present[<operator>]
optional, enumerated string filter
Possible values are : true, false
Supported operators :

Example →
in[<operator>]
optional, string filter
Possible values are :
Supported operators :

Example →
not_in[<operator>]
optional, string filter
Possible values are :
Supported operators :

Example →
customer_id[<operator>]
optional, string filter
A unique identifier for the customer being charged. Possible values are :
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → "customer_id[is] = "5hjdk8nOpd0b12"
is[<operator>]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example →
is_not[<operator>]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example →
starts_with[<operator>]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example →
is_present[<operator>]
optional, enumerated string filter
Possible values are : true, false
Supported operators :

Example →
in[<operator>]
optional, string filter
Possible values are :
Supported operators :

Example →
not_in[<operator>]
optional, string filter
Possible values are :
Supported operators :

Example →

Returns

unbilled_charge unbilled_charge
always returned
Resource object representing unbilled_charge
next_offset next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/unbilled_charges/123x

Create an estimate for unbilled charges

This is similar to the "Create an invoice for unbilled charges" API but no invoice will be created, only an estimate for this operation is created.

In the estimate response,

  • estimate.invoice_estimates is an array of estimate.invoice_estimate. This has the details of the invoices that will be generated now.

Note:

  • This API when invoked does not perform the actual operation. It just generates an estimate.
  • Both subscription_id and customer_id parameters should not be given at the same time.

Notes

Sample Codes 
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->invoiceNowEstimate([
    "customer_id" => "__test__KyVnHhSBWSjn239"
]);
$estimate = $result->estimate;
copy
Click to Copy
require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
  "site" => "{site}",
  "apiKey" => "{apiKey}",
]);

$result = $chargebee->unbilledCharge()->invoiceNowEstimate([
    "customer_id" => "__test__KyVnHhSBWSjn239"
]);
$estimate = $result->estimate;

Sample Result [ JSON ]

Show more...
{
    "estimate": {
        "created_at": 1517501349,
        "invoice_estimates": [
            {
                "amount_due": 895,
                "amount_paid": 0,
                "credits_applied": 0,
                "currency_code": "USD",
                "customer_id": "__test__KyVnHhSBWSjn239",
                "date": 1517501349,
                "line_item_discounts": [],
                "line_item_taxes": [],
                "line_items": [
                    {
                        "amount": 895,
                        "customer_id": "__test__KyVnHhSBWSjn239",
                        "date_from": 1517501349,
                        "date_to": 1519920549,
                        "description": "No Trial",
                        "discount_amount": 0,
                        "entity_id": "no_trial",
                        "entity_type": "plan",
                        "id": "li___test__KyVnHhSBWSjoI3B",
                        "is_taxed": false,
                        "item_level_discount_amount": 0,
                        "object": "line_item",
                        "pricing_model": "per_unit",
                        "quantity": 1,
                        "subscription_id": "__test__KyVnHhSBWSjn239",
                        "tax_amount": 0,
                        "unit_amount": 895
                    },
                    {..}
                ],
                "object": "invoice_estimate",
                "price_type": "tax_exclusive",
                "recurring": true,
                "round_off_amount": 0,
                "sub_total": 895,
                "taxes": [],
                "total": 895
            },
            {..}
        ],
        "object": "estimate"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/unbilled_charges/invoice_now_estimate

Method

$chargebee->unbilledCharge->invoiceNowEstimate([<param name> : <value>,<param name> : <value> ...])

Input Parameters

subscription_id[]
optional, string, max chars=50
Identifier of the subscription for which this estimate needs to be created. Should be given if 'customer_id' is not specified.
customer_id[]
optional, string, max chars=50
Identifier of the customer for whom this estimate is created. Is given if 'subscription_id' is not specified. Applicable only if the 'Consolidated Invoicing' is enabled. If 'Consolidated Invoicing' is not enabled, an invoice will be generated for every subscription.

Returns

estimate estimate
always returned
Resource object representing estimate

Sample admin console URL

https://{site}.chargebee.com/admin-console/unbilled_charges/123x