GET /unbilled_charges

This endpoint lists all the unbilled charges.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.

Query parameters

Name	Type	Required	Description
`customer_id`	Object	No	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"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`is_voided`	Boolean	No	Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration. Default value: false
`offset`	String	No	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`	Boolean	No	If set to true, includes the deleted resources in the response. For the deleted resources in the response, the 'deleted' attribute will be 'true'. Default value: false
`subscription_id`	Object	No	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"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.