Pricing Templates
Log in Sign up
Integrations / Chargebee Product / ...

POST /exports/revenue_recognition

Important:

This report is deprecated. Therefore, the endpoint is also deprecated.

This API triggers export for the revenue recognition report.

Note: This API call is asynchronous. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the wait for export completion function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method waitForExportCompletion() on the returned Export resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method waitForExportCompletion() on the returned Export resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method wait_for_export_completion on the returned export resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method wait_for_export_completion on the returned export resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method WaitForExportCompletion on the returned Export resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method wait_for_export_completion on the returned export resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is completed . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method wait_for_export_completion on the returned export resource which wait until the export status changes.

Servers

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

Valid values:

  • "all-disabled"
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

Valid values:

  • "all-disabled"
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.
chargebee-event-email String No

skip only emails

Valid values:

  • "all-disabled"

Request body fields

Name Type Required Description
cancel_reason_code Object No

optional, string filter Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation** . Must be passed if set as mandatory in the app. The codes are case-sensitive.**Supported operators :** is, is_not, starts_with, in, not_in**Example →** *cancel_reason_code\[is\] = "Not Paid"*
cancel_reason_code.not_in String No
cancel_reason_code.starts_with String No
cancel_reason_code.in String No
cancel_reason_code.is_not String No
cancel_reason_code.is String No
subscription Object No

Parameters for subscription
subscription.cancel_reason Object No

The reason for canceling the subscription. Set by Chargebee automatically.
subscription.cancel_reason.not_in String No
subscription.cancel_reason.in String No
subscription.cancel_reason.is_not String No

* `not_paid` - Not Paid * `no_card` - No Card * `fraud_review_failed` - Fraud Review Failed * `non_compliant_eu_customer` - Non Compliant EU Customer * `tax_calculation_failed` - Tax Calculation Failed * `currency_incompatible_with_gateway` - Currency incompatible with Gateway * `non_compliant_customer` - Non Compliant Customer

Valid values:

  • "tax_calculation_failed"
  • "non_compliant_eu_customer"
  • "non_compliant_customer"
  • "not_paid"
  • "currency_incompatible_with_gateway"
  • "fraud_review_failed"
  • "no_card"
subscription.cancel_reason.is String No

* `not_paid` - Not Paid * `no_card` - No Card * `fraud_review_failed` - Fraud Review Failed * `non_compliant_eu_customer` - Non Compliant EU Customer * `tax_calculation_failed` - Tax Calculation Failed * `currency_incompatible_with_gateway` - Currency incompatible with Gateway * `non_compliant_customer` - Non Compliant Customer

Valid values:

  • "tax_calculation_failed"
  • "non_compliant_eu_customer"
  • "non_compliant_customer"
  • "not_paid"
  • "currency_incompatible_with_gateway"
  • "fraud_review_failed"
  • "no_card"
subscription.cancel_reason.is_present String No

Valid values:

  • "false"
  • "true"
subscription.activated_at Object No

Time at which the subscription status last changed to  active. For example, this value is updated when an in_trial or  cancelled subscription activates.
subscription.activated_at.on String No
subscription.activated_at.after String No
subscription.activated_at.between String No
subscription.activated_at.before String No
subscription.activated_at.is_present String No

Valid values:

  • "false"
  • "true"
subscription.has_scheduled_changes Object No

If true, there are subscription changes scheduled on next renewal.
subscription.has_scheduled_changes.is String No

Valid values:

  • "false"
  • "true"
subscription.status Object No

Current state of the subscription
subscription.status.not_in String No
subscription.status.in String No
subscription.status.is_not String No

* `future` - The subscription is scheduled to start at a future date. * `in_trial` - The subscription is in trial. * `active` - The subscription is active and will be charged for automatically based on the items in it. * `non_renewing` - The subscription will be canceled at the end of the current term. * `paused` - The subscription is paused. The subscription will not renew while in this state. * `cancelled` - The subscription has been canceled and is no longer in service. * `transferred` - The subscription has been transferred to another business entity within the organization.

Valid values:

  • "active"
  • "future"
  • "in_trial"
  • "non_renewing"
  • "paused"
  • "cancelled"
  • "transferred"
subscription.status.is String No

* `future` - The subscription is scheduled to start at a future date. * `in_trial` - The subscription is in trial. * `active` - The subscription is active and will be charged for automatically based on the items in it. * `non_renewing` - The subscription will be canceled at the end of the current term. * `paused` - The subscription is paused. The subscription will not renew while in this state. * `cancelled` - The subscription has been canceled and is no longer in service. * `transferred` - The subscription has been transferred to another business entity within the organization.

Valid values:

  • "active"
  • "future"
  • "in_trial"
  • "non_renewing"
  • "paused"
  • "cancelled"
  • "transferred"
subscription.auto_close_invoices Object No

Set to false to override for this subscription, the site-level setting for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the customer level.
subscription.auto_close_invoices.is String No

Valid values:

  • "false"
  • "true"
subscription.updated_at Object No

To filter based on updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response.
subscription.updated_at.on String No
subscription.updated_at.after String No
subscription.updated_at.between String No
subscription.updated_at.before String No
subscription.id Object No

A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
subscription.id.not_in String No
subscription.id.starts_with String No
subscription.id.in String No
subscription.id.is_not String No
subscription.id.is String No
subscription.customer_id Object No

Identifier of the customer with whom this subscription is associated.
subscription.customer_id.not_in String No
subscription.customer_id.starts_with String No
subscription.customer_id.in String No
subscription.customer_id.is_not String No
subscription.customer_id.is String No
subscription.offline_payment_method Object No

The preferred offline payment method for the subscription.
subscription.offline_payment_method.not_in String No
subscription.offline_payment_method.in String No
subscription.offline_payment_method.is_not String No

* `no_preference` - No Preference * `cash` - Cash * `check` - Check * `bank_transfer` - Bank Transfer * `ach_credit` - ACH Credit * `sepa_credit` - SEPA Credit * `boleto` - Boleto * `us_automated_bank_transfer` - US Automated Bank Transfer * `eu_automated_bank_transfer` - EU Automated Bank Transfer * `uk_automated_bank_transfer` - UK Automated Bank Transfer * `jp_automated_bank_transfer` - JP Automated Bank Transfer * `mx_automated_bank_transfer` - MX Automated Bank Transfer * `custom` - Custom

Valid values:

  • "mx_automated_bank_transfer"
  • "cash"
  • "boleto"
  • "no_preference"
  • "bank_transfer"
  • "jp_automated_bank_transfer"
  • "custom"
  • "check"
  • "eu_automated_bank_transfer"
  • "sepa_credit"
  • "ach_credit"
  • "us_automated_bank_transfer"
  • "uk_automated_bank_transfer"
subscription.offline_payment_method.is String No

* `no_preference` - No Preference * `cash` - Cash * `check` - Check * `bank_transfer` - Bank Transfer * `ach_credit` - ACH Credit * `sepa_credit` - SEPA Credit * `boleto` - Boleto * `us_automated_bank_transfer` - US Automated Bank Transfer * `eu_automated_bank_transfer` - EU Automated Bank Transfer * `uk_automated_bank_transfer` - UK Automated Bank Transfer * `jp_automated_bank_transfer` - JP Automated Bank Transfer * `mx_automated_bank_transfer` - MX Automated Bank Transfer * `custom` - Custom

Valid values:

  • "mx_automated_bank_transfer"
  • "cash"
  • "boleto"
  • "no_preference"
  • "bank_transfer"
  • "jp_automated_bank_transfer"
  • "custom"
  • "check"
  • "eu_automated_bank_transfer"
  • "sepa_credit"
  • "ach_credit"
  • "us_automated_bank_transfer"
  • "uk_automated_bank_transfer"
subscription.next_billing_at Object No

The date/time at which the next billing for the subscription happens. This is usually right after current_term_end unless multiple subscription terms were invoiced in advance using the terms_to_charge parameter.
subscription.next_billing_at.on String No
subscription.next_billing_at.after String No
subscription.next_billing_at.between String No
subscription.next_billing_at.before String No
subscription.channel Object No

The subscription channel this object originated from and is maintained in.
subscription.channel.not_in String No
subscription.channel.in String No
subscription.channel.is_not String No

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
subscription.channel.is String No

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
subscription.remaining_billing_cycles Object No

* When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels. * When the subscription is on a [contract term](contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
subscription.remaining_billing_cycles.gt String No
subscription.remaining_billing_cycles.lte String No
subscription.remaining_billing_cycles.between String No
subscription.remaining_billing_cycles.gte String No
subscription.remaining_billing_cycles.is_not String No
subscription.remaining_billing_cycles.lt String No
subscription.remaining_billing_cycles.is String No
subscription.remaining_billing_cycles.is_present String No

Valid values:

  • "false"
  • "true"
subscription.cancelled_at Object No

Time at which subscription was cancelled or is set to be cancelled.
subscription.cancelled_at.on String No
subscription.cancelled_at.after String No
subscription.cancelled_at.between String No
subscription.cancelled_at.before String No
subscription.created_at Object No

The time at which the subscription was created.
subscription.created_at.on String No
subscription.created_at.after String No
subscription.created_at.between String No
subscription.created_at.before String No
currency_code String No

Value must be in ISO 4217 format. Generates the report based on the value specified. If no currency_code value is specified, then consolidated report based on base currency is returned.
report_to_year Integer Yes

Obtains report data until the specified year, combined with the value specified for report_to_month.
report_by String Yes

Determines the scope of the report. Returns the report based on the value specified. * subscription - Subscription * invoice - Invoice * product - Product (Includes Plan, Addon and Adhoc) * customer - Customer

Valid values:

  • "product"
  • "subscription"
  • "customer"
  • "invoice"
item_price_id Object No

optional, string filterThe plan item price code.**Supported operators :** is, is_not, starts_with, in, not_in**Example →** *item_price_id\[is\] = "silver-USD-monthly"*
item_price_id.not_in String No
item_price_id.starts_with String No
item_price_id.in String No
item_price_id.is_not String No
item_price_id.is String No
business_entity_id Object No

optional, string filterThe unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer. **Supported operators :** is, is_not, starts_with**Example →** *business_entity_id\[is_not\] = "business_entity_id"*
business_entity_id.starts_with String No
business_entity_id.is_not String No
business_entity_id.is String No
relationship Object No

Parameters for relationship
relationship.parent_id Object No

Immediate parent with whom we will link our new customer(child)
relationship.parent_id.starts_with String No
relationship.parent_id.is_not String No
relationship.parent_id.is String No
relationship.invoice_owner_id Object No

Parent who is going to handle invoices
relationship.invoice_owner_id.starts_with String No
relationship.invoice_owner_id.is_not String No
relationship.invoice_owner_id.is String No
relationship.payment_owner_id Object No

Parent who is going to pay
relationship.payment_owner_id.starts_with String No
relationship.payment_owner_id.is_not String No
relationship.payment_owner_id.is String No
payment_owner Object No

optional, string filterPayment owner of an invoice.**Supported operators :** is, is_not, starts_with, in, not_in**Example →** *payment_owner\[is\] = "payment_customer"*
payment_owner.not_in String No
payment_owner.starts_with String No
payment_owner.in String No
payment_owner.is_not String No
payment_owner.is String No
report_from_month Integer Yes

Obtains report data from the specified month, combined with the value specified for report_from_year. Values must be between 1 and 12, where 1 is January and 12 is December.
report_from_year Integer Yes

Obtains report data from the specified year, combined with the value specified for report_from_month.
customer Object No

Parameters for customer
customer.taxability Object No

Specifies if the customer is liable for tax
customer.taxability.not_in String No
customer.taxability.in String No
customer.taxability.is_not String No
  • taxable - Computes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
  • exempt -
    • Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
    • However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.

Valid values:

  • "exempt"
  • "taxable"
customer.taxability.is String No
  • taxable - Computes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.
  • exempt -
    • Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
    • However, when using our Avalara integration, optionally, specify entity_code or exempt_number attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code/exempt_number/exemption_details based on the state/region/province of the taxable address.

Valid values:

  • "exempt"
  • "taxable"
customer.first_name Object No

First name of the customer
customer.first_name.starts_with String No
customer.first_name.is_not String No
customer.first_name.is String No
customer.first_name.is_present String No

Valid values:

  • "false"
  • "true"
customer.auto_close_invoices Object No

Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions?prod_cat_ver=2#subscription_auto_close_invoices) which takes precedence.
customer.auto_close_invoices.is String No

Valid values:

  • "false"
  • "true"
customer.updated_at Object No

To filter based on updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response.
customer.updated_at.on String No
customer.updated_at.after String No
customer.updated_at.between String No
customer.updated_at.before String No
customer.id Object No

Identifier of the customer.
customer.id.not_in String No
customer.id.starts_with String No
customer.id.in String No
customer.id.is_not String No
customer.id.is String No
customer.offline_payment_method Object No

The preferred offline payment method for the customer.
customer.offline_payment_method.not_in String No
customer.offline_payment_method.in String No
customer.offline_payment_method.is_not String No

* `no_preference` - No Preference * `cash` - Cash * `check` - Check * `bank_transfer` - Bank Transfer * `ach_credit` - ACH Credit * `sepa_credit` - SEPA Credit * `boleto` - Boleto * `us_automated_bank_transfer` - US Automated Bank Transfer * `eu_automated_bank_transfer` - EU Automated Bank Transfer * `uk_automated_bank_transfer` - UK Automated Bank Transfer * `jp_automated_bank_transfer` - JP Automated Bank Transfer * `mx_automated_bank_transfer` - MX Automated Bank Transfer * `custom` - Custom

Valid values:

  • "mx_automated_bank_transfer"
  • "cash"
  • "boleto"
  • "no_preference"
  • "bank_transfer"
  • "jp_automated_bank_transfer"
  • "custom"
  • "check"
  • "eu_automated_bank_transfer"
  • "sepa_credit"
  • "ach_credit"
  • "us_automated_bank_transfer"
  • "uk_automated_bank_transfer"
customer.offline_payment_method.is String No

* `no_preference` - No Preference * `cash` - Cash * `check` - Check * `bank_transfer` - Bank Transfer * `ach_credit` - ACH Credit * `sepa_credit` - SEPA Credit * `boleto` - Boleto * `us_automated_bank_transfer` - US Automated Bank Transfer * `eu_automated_bank_transfer` - EU Automated Bank Transfer * `uk_automated_bank_transfer` - UK Automated Bank Transfer * `jp_automated_bank_transfer` - JP Automated Bank Transfer * `mx_automated_bank_transfer` - MX Automated Bank Transfer * `custom` - Custom

Valid values:

  • "mx_automated_bank_transfer"
  • "cash"
  • "boleto"
  • "no_preference"
  • "bank_transfer"
  • "jp_automated_bank_transfer"
  • "custom"
  • "check"
  • "eu_automated_bank_transfer"
  • "sepa_credit"
  • "ach_credit"
  • "us_automated_bank_transfer"
  • "uk_automated_bank_transfer"
customer.email Object No

Email of the customer. Configured email notifications will be sent to this email.
customer.email.starts_with String No
customer.email.is_not String No
customer.email.is String No
customer.email.is_present String No

Valid values:

  • "false"
  • "true"
customer.channel Object No

The subscription channel this object originated from and is maintained in.
customer.channel.not_in String No
customer.channel.in String No
customer.channel.is_not String No

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
customer.channel.is String No

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
customer.last_name Object No

Last name of the customer
customer.last_name.starts_with String No
customer.last_name.is_not String No
customer.last_name.is String No
customer.last_name.is_present String No

Valid values:

  • "false"
  • "true"
customer.company Object No

Company name of the customer.
customer.company.starts_with String No
customer.company.is_not String No
customer.company.is String No
customer.company.is_present String No

Valid values:

  • "false"
  • "true"
customer.phone Object No

Phone number of the customer
customer.phone.starts_with String No
customer.phone.is_not String No
customer.phone.is String No
customer.phone.is_present String No

Valid values:

  • "false"
  • "true"
customer.auto_collection Object No

Whether payments needs to be collected automatically for this customer
customer.auto_collection.not_in String No
customer.auto_collection.in String No
customer.auto_collection.is_not String No

* `on` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. * `off` - Automatic collection of charges will not be made. All payments must be recorded offline.

Valid values:

  • "on"
  • "off"
customer.auto_collection.is String No

* `on` - Whenever an invoice is created, an automatic attempt to charge the customer's payment method is made. * `off` - Automatic collection of charges will not be made. All payments must be recorded offline.

Valid values:

  • "on"
  • "off"
customer.created_at Object No

Timestamp indicating when this customer resource is created.
customer.created_at.on String No
customer.created_at.after String No
customer.created_at.between String No
customer.created_at.before String No
invoice Object No

Parameters for invoice
invoice.credits_applied Object No

Total credits applied against this invoice.
invoice.credits_applied.gt String No
invoice.credits_applied.lte String No
invoice.credits_applied.between String No
invoice.credits_applied.gte String No
invoice.credits_applied.is_not String No
invoice.credits_applied.lt String No
invoice.credits_applied.is String No
invoice.amount_adjusted Object No

Total adjustments made against this invoice.
invoice.amount_adjusted.gt String No
invoice.amount_adjusted.lte String No
invoice.amount_adjusted.between String No
invoice.amount_adjusted.gte String No
invoice.amount_adjusted.is_not String No
invoice.amount_adjusted.lt String No
invoice.amount_adjusted.is String No
invoice.recurring Object No

Boolean indicating whether this invoice belongs to a subscription
invoice.recurring.is String No

Valid values:

  • "false"
  • "true"
invoice.dunning_status Object No

Current dunning status of the invoice.
invoice.dunning_status.not_in String No
invoice.dunning_status.in String No
invoice.dunning_status.is_not String No

* `in_progress` - Dunning is still in progress. * `exhausted` - Maximum number of attempts have been made. * `stopped` - Dunning has stopped for this invoice. * `success` - Payment successfully collected during dunning process.

Valid values:

  • "in_progress"
  • "success"
  • "exhausted"
  • "stopped"
invoice.dunning_status.is String No

* `in_progress` - Dunning is still in progress. * `exhausted` - Maximum number of attempts have been made. * `stopped` - Dunning has stopped for this invoice. * `success` - Payment successfully collected during dunning process.

Valid values:

  • "in_progress"
  • "success"
  • "exhausted"
  • "stopped"
invoice.dunning_status.is_present String No

Valid values:

  • "false"
  • "true"
invoice.status Object No

Current status of this invoice.
invoice.status.not_in String No
invoice.status.in String No
invoice.status.is_not String No
  • paid - Indicates a paid invoice.
  • posted - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
  • payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.
  • not_paid - Indicates the payment is not made and all attempts to collect is failed.
  • voided - Indicates a voided invoice.
  • pending -
    The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.
    The invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.

Valid values:

  • "posted"
  • "paid"
  • "payment_due"
  • "not_paid"
  • "voided"
  • "pending"
invoice.status.is String No
  • paid - Indicates a paid invoice.
  • posted - Indicates the payment is not yet collected and will be in this state till the due date to indicate the due period
  • payment_due - Indicates the payment is not yet collected and is being retried as per retry settings.
  • not_paid - Indicates the payment is not made and all attempts to collect is failed.
  • voided - Indicates a voided invoice.
  • pending -
    The invoice is yet to be closed (sent for payment collection). An invoice is generated with this status when it has line items that belong to items that are metered or when the subscription.create_pending_invoicesattribute is set to true.
    The invoice is yet to be closed (sent for payment collection). All invoices are generated with this status when Metered Billing is enabled for the site.

Valid values:

  • "posted"
  • "paid"
  • "payment_due"
  • "not_paid"
  • "voided"
  • "pending"
invoice.price_type Object No

The price type of the invoice.
invoice.price_type.not_in String No
invoice.price_type.in String No
invoice.price_type.is_not String No

* `tax_exclusive` - All amounts in the document are exclusive of tax. * `tax_inclusive` - All amounts in the document are inclusive of tax.

Valid values:

  • "tax_exclusive"
  • "tax_inclusive"
invoice.price_type.is String No

* `tax_exclusive` - All amounts in the document are exclusive of tax. * `tax_inclusive` - All amounts in the document are inclusive of tax.

Valid values:

  • "tax_exclusive"
  • "tax_inclusive"
invoice.date Object No

The document date displayed on the invoice PDF.
invoice.date.on String No
invoice.date.after String No
invoice.date.between String No
invoice.date.before String No
invoice.paid_at Object No

Timestamp indicating the date \& time this invoice got paid.
invoice.paid_at.on String No
invoice.paid_at.after String No
invoice.paid_at.between String No
invoice.paid_at.before String No
invoice.total Object No

Invoiced amount displayed in cents; that is, a decimal point is not present between the whole number and the decimal part. For example, $499.99 is displayed as 49999, and so on.
invoice.total.gt String No
invoice.total.lte String No
invoice.total.between String No
invoice.total.gte String No
invoice.total.is_not String No
invoice.total.lt String No
invoice.total.is String No
invoice.updated_at Object No

To filter based on updated_at. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the sort_by input parameter as updated_at for a faster response.
invoice.updated_at.on String No
invoice.updated_at.after String No
invoice.updated_at.between String No
invoice.updated_at.before String No
invoice.id Object No

The invoice number. Acts as a identifier for invoice and typically generated sequentially.
invoice.id.not_in String No
invoice.id.starts_with String No
invoice.id.in String No
invoice.id.is_not String No
invoice.id.is String No
invoice.channel Object No

The subscription channel this object originated from and is maintained in.
invoice.channel.not_in String No
invoice.channel.in String No
invoice.channel.is_not String No

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
invoice.channel.is String No

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

  • "web"
  • "play_store"
  • "app_store"
invoice.amount_due Object No

The unpaid amount that is due on the invoice. This is calculated as: total - amount_paid - sum of applied_credits.applied_amount - sum of adjustment_credit_notes.cn_total - sum of linked_taxes_withheld.amount.
invoice.amount_due.gt String No
invoice.amount_due.lte String No
invoice.amount_due.between String No
invoice.amount_due.gte String No
invoice.amount_due.is_not String No
invoice.amount_due.lt String No
invoice.amount_due.is String No
invoice.amount_paid Object No

Payments collected successfully for the invoice. This is the sum of linked_payments[].txn_amount for all linked_payments[] that have txn_status as success.
invoice.amount_paid.gt String No
invoice.amount_paid.lte String No
invoice.amount_paid.between String No
invoice.amount_paid.gte String No
invoice.amount_paid.is_not String No
invoice.amount_paid.lt String No
invoice.amount_paid.is String No
report_to_month Integer Yes

Obtains report data from the specified month, combined with the value specified for report_to_year. Values must be between 1 and 12, where 1 is January and 12 is December.
include_discounts Boolean No

Returns amount with discount in the report. If value specified is false, it returns amount without discount.

Default value: true
item_id Object No

optional, string filterThe plan item code.**Supported operators :** is, is_not, starts_with, in, not_in**Example →** *item_id\[is\] = "silver"*
item_id.not_in String No
item_id.starts_with String No
item_id.in String No
item_id.is_not String No
item_id.is String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy