POST /unbilled_charges
This endpoint creates unbilled charges for a subscription.
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 |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
chargebee-event-webhook |
String | No |
skip only webhooks Possible values:
|
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-event-actions |
String | No |
skip all actions to be done on the events Possible values:
|
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-event-email |
String | No |
skip only emails Possible values:
|
Request body fields
Name | Type | Required | Description |
---|---|---|---|
item_prices |
Object | No |
Parameters for item_prices |
item_prices.unit_price[] |
Array | No |
The price or per-unit-price of the item price. By default, it is the value set for the |
item_prices.date_from[] |
Array | No |
The time when the service period for the item starts. |
item_prices.date_to[] |
Array | No |
The time when the service period for the item ends. |
item_prices.unit_price_in_decimal[] |
Array | No |
The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when multi-decimal pricing is enabled. |
item_prices.item_price_id[] |
Array | No |
A unique ID for your system to identify the item price. |
item_prices.quantity[] |
Array | No |
Item price quantity |
item_prices.quantity_in_decimal[] |
Array | No |
The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when multi-decimal pricing is enabled. |
currency_code |
String | No |
The currency code (ISO 4217 format) of the unbilled_charge. |
item_tiers |
Object | No |
Parameters for item_tiers |
item_tiers.starting_unit_in_decimal[] |
Array | No |
The decimal representation of the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as |
item_tiers.price_in_decimal[] |
Array | No |
The decimal representation of the per-unit price for the tier when the |
item_tiers.package_size[] |
Array | No |
Package size for the tier when pricing type is |
item_tiers.price[] |
Array | No |
The per-unit price for the tier when the |
item_tiers.ending_unit[] |
Array | No |
The highest value in the quantity tier. |
item_tiers.item_price_id[] |
Array | No |
The id of the item price to which this tier belongs. |
item_tiers.pricing_type[] |
Array | No | |
item_tiers.starting_unit[] |
Array | No |
The lowest value in the quantity tier. |
item_tiers.ending_unit_in_decimal[] |
Array | No |
The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the |
tax_providers_fields |
Object | No |
Parameters for tax_providers_fields |
tax_providers_fields.field_value[] |
Array | No |
The value of the corresponding tax field. |
tax_providers_fields.field_id[] |
Array | No |
Field id of the attribute which tax vendor has provided while getting onboarded with us. |
tax_providers_fields.provider_name[] |
Array | No |
Name of the tax provider currently supported. |
charges |
Object | No |
Parameters for charges |
charges.description[] |
Array | No |
Description for this charge |
charges.date_to[] |
Array | No |
The time when the service period for the charge ends. |
charges.avalara_tax_code[] |
Array | No |
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. |
charges.avalara_sale_type[] |
Array | No | |
charges.avalara_service_type[] |
Array | No |
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. |
charges.date_from[] |
Array | No |
The time when the service period for the charge starts. |
charges.amount_in_decimal[] |
Array | No |
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. |
charges.tax_profile_id[] |
Array | No |
Tax profile of the charge. |
charges.amount[] |
Array | No |
The amount to be charged. The unit depends on the type of currency. |
charges.taxjar_product_code[] |
Array | No |
The TaxJar product codes to which items are mapped to should be provided here. Applicable only if you use Chargebee's TaxJar integration. |
charges.taxable[] |
Array | No |
The amount to be charged is taxable or not. |
charges.hsn_code[] |
Array | No |
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:
|
charges.avalara_transaction_type[] |
Array | No |
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. |
subscription_id |
String | Yes |
Identifier of the subscription for which this unbilled charges needs to be created. |
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.