List unbilled charges

Try in API Explorer

This endpoint lists all the unbilled charges.

Sample Request

URL Format

GET https://[site].chargebee.com/api/v2/unbilled_charges

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. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → subscription_id[is] = "5hjdk8nOpd0b12"

Supported operators: is, is_not, starts_with, is_present, in, not_in

Example → 5hjdk8nOpd0b12

customer_id[<operator>]

optional, string filter

A unique identifier for the customer being charged. Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → customer_id[is] = "5hjdk8nOpd0b12"

Supported operators: is, is_not, starts_with, is_present, in, not_in

Example → 5hjdk8nOpd0b12

Returns

next_offsetoptional, 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.

unbilled_chargeUnbilled charge object

Resource object representing unbilled_charge