Exports

API Version

Product Catalog

Library

Export resource represents an export job and contains the status of the job and the download URL, if the job is successfully completed.

Export operations are asynchronous and will return “Export” resource in response . The export resource will contain the status of the export job (like in-process, completed…) . If the status is completed, it will contain the download url pointing to the zip/pdf containing the exported data.

Note: At any given point, only 5 export jobs can be processed. Beyond that, an error stating that the API request limit has been reached will be returned.

Sample export [ JSON ]

{
    "created_at": 1527791400,
    "id": "__test__KyVnHhSBWTF7H8v",
    "mime_type": "zip",
    "object": "export",
    "operation_type": "Deferred Revenue Report",
    "status": "failed"
}

API Index URL GET

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

id

string, max chars=50
A unique identifier to identify the export

operation_type

string, max chars=100
Describes the type of export

mime_type

enumerated string, default=zip
Describes the mime type of download file

Possible values are

pdfPDFzipZIP

status

enumerated string, default=in_process
Current status of the export operation

Possible values are

in_processIn ProcesscompletedCompletedfailedFailed

created_at

timestamp(UTC) in seconds
Export created time

download
Show attributes [+]

optional, download
Returns the download_url for the export. The download URL is valid upto a specific date.

This API gets the status of the export job initiated by the Exports API. If the export job is completed, the downloads resource will also be obtained in the API response. The returned URL in the downloads resource is secure and can be downloaded. The URL expires after 4 hours. Please note that this is a public URL, and can be downloaded by anyone with whom it’s shared.

Note: In case the export is in Failed or In-process state, then the downloads resource will not be available.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/__test__KyVnHhSBWTF7H8v \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/__test__KyVnHhSBWTF7H8v \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTF7H8v",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Deferred Revenue Report",
        "status": "failed"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v2/exports/{export-id}

export

always returned
Resource object representing export

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.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/revenue_recognition \
     -u {site_api_key}:\
     -d report_by="INVOICE" \
     -d report_from_month=6 \
     -d report_from_year=2020 \
     -d report_to_month=7 \
     -d report_to_year=2020

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/revenue_recognition \
     -u {site_api_key}:\
     -d report_by="INVOICE" \
     -d report_from_month=6 \
     -d report_from_year=2020 \
     -d report_to_month=7 \
     -d report_to_year=2020

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1612968382,
        "id": "__test__8aszcSOcsxGt7u",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Revenue Recognition Report",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/revenue_recognition

report_by[]

required, enumerated string
Determines the scope of the report. Returns the report based on the value specified.

Possible values are

customerCustomerinvoiceInvoiceproductProduct (Includes Plan, Addon and Adhoc)subscriptionSubscription

currency_code[]

optional, string, max chars=3
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_from_month[]

required, integer
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[]

required, integer
Obtains report data from the specified year, combined with the value specified for report_from_month.

report_to_month[]

required, integer
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.

report_to_year[]

required, integer
Obtains report data until the specified year, combined with the value specified for report_to_month.

include_discounts[]

optional, boolean, default=true
Returns amount with discount in the report. If value specified is false, it returns amount without discount.

payment_owner[<operator>]

optional, string filter
optional, string filter
Payment owner of an invoice.
Supported operators : is, is_not, starts_with, in, not_in

Example → payment_owner[is] = "payment_customer"
Supported operators : is, is_not, starts_with, in, not_in

Example → payment_owner[is] = "payment_customer"

item_id[<operator>]

optional, string filter
optional, string filter
The plan item code.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_id[is] = "silver"
Supported operators : is, is_not, starts_with, in, not_in

Example → item_id[is] = "silver"

item_price_id[<operator>]

optional, string filter
optional, string filter
The plan item price code.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_price_id[is] = "silver-USD-monthly"
Supported operators : is, is_not, starts_with, in, not_in

Example → item_price_id[is] = "silver-USD-monthly"

cancel_reason_code[<operator>]

optional, string filter
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"
Supported operators : is, is_not, starts_with, in, not_in

Example → cancel_reason_code[is] = "Not Paid"

business_entity_id[<operator>]

optional, string filter
optional, string filter
The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer.
Supported operators : is, is_not, starts_with

Example → business_entity_id[is_not] = "business_entity_id"
Supported operators : is, is_not, starts_with

Example → business_entity_id[is] = "business_entity_id"

invoice

Parameters for invoice
pass parameters as invoice[<param name>][<operator>]

invoice[id][operator]

optional, string filter
The invoice number. Acts as a identifier for invoice and typically generated sequentially.
Supported operators : is, is_not, starts_with, in, not_in

Example → invoice[id][is] = "INVOICE_654"

invoice[recurring][operator]

optional, enumerated string filter
Boolean indicating whether this invoice belongs to a subscription Possible values are : true, false
Supported operators : is

Example → invoice[recurring][is] = "true"

invoice[status][operator]

optional, enumerated string filter
Current status of this invoice. Possible values are : paid, posted, payment_due, not_paid, voided, pending
Supported operators : is, is_not, in, not_in

Example → invoice[status][is] = "paid"

invoice[price_type][operator]

optional, enumerated string filter
The price type of the invoice. Possible values are : tax_exclusive, tax_inclusive
Supported operators : is, is_not, in, not_in

Example → invoice[price_type][is] = "tax_exclusive"

invoice[date][operator]

optional, timestamp(UTC) in seconds filter
The document date displayed on the invoice PDF.
Supported operators : after, before, on, between

Example → invoice[date][after] = "1394532759"

invoice[paid_at][operator]

optional, timestamp(UTC) in seconds filter
Timestamp indicating the date & time this invoice got paid.
Supported operators : after, before, on, between

Example → invoice[paid_at][after] = "1394532759"

invoice[total][operator]

optional, number filter
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.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[total][is] = "1000"

invoice[amount_paid][operator]

optional, number filter
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.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[amount_paid][is] = "800"

invoice[amount_adjusted][operator]

optional, number filter
Total adjustments made against this invoice.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[amount_adjusted][is] = "100"

invoice[credits_applied][operator]

optional, number filter
Total credits applied against this invoice.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[credits_applied][is] = "100"

invoice[amount_due][operator]

optional, number filter
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.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[amount_due][is] = "200"

invoice[dunning_status][operator]

optional, enumerated string filter
Current dunning status of the invoice. Possible values are : in_progress, exhausted, stopped, success
Supported operators : is, is_not, in, not_in, is_present

Example → invoice[dunning_status][is] = "in_progress"

invoice[updated_at][operator]

optional, timestamp(UTC) in seconds filter
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.
Supported operators : after, before, on, between

Example → invoice[updated_at][after] = "1243545465"

invoice[channel][operator]

optional, enumerated string filter
The subscription channel this object originated from and is maintained in. Possible values are : web, app_store, play_store
Supported operators : is, is_not, in, not_in

Example → invoice[channel][is] = "APP STORE"

subscription

Parameters for subscription
pass parameters as subscription[<param name>][<operator>]

subscription[id][operator]

optional, string filter
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
Supported operators : is, is_not, starts_with, in, not_in

Example → subscription[id][is] = "8gsnbYfsMLds"

subscription[customer_id][operator]

optional, string filter
Identifier of the customer with whom this subscription is associated.
Supported operators : is, is_not, starts_with, in, not_in

Example → subscription[customer_id][is] = "8gsnbYfsMLds"

subscription[status][operator]

optional, enumerated string filter
Current state of the subscription Possible values are : future, in_trial, active, non_renewing, paused, cancelled, transferred
Supported operators : is, is_not, in, not_in

Example → subscription[status][is] = "active"

subscription[cancel_reason][operator]

optional, enumerated string filter
The reason for canceling the subscription. Set by Chargebee automatically. Possible values are : not_paid, no_card, fraud_review_failed, non_compliant_eu_customer, tax_calculation_failed, currency_incompatible_with_gateway, non_compliant_customer
Supported operators : is, is_not, in, not_in, is_present

Example → subscription[cancel_reason][is] = "not_paid"

subscription[remaining_billing_cycles][operator]

optional, number filter

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: this value is the number of billing cycles remaining in the contract term after the current billing cycle.

Supported operators : is, is_not, lt, lte, gt, gte, between, is_present

Example → subscription[remaining_billing_cycles][is] = "3"

subscription[created_at][operator]

optional, timestamp(UTC) in seconds filter
The time at which the subscription was created.
Supported operators : after, before, on, between

Example → subscription[created_at][after] = "1435054328"

subscription[activated_at][operator]

optional, timestamp(UTC) in seconds filter
Time at which the subscription status last changed to active. For example, this value is updated when an in_trial or cancelled subscription activates.
Supported operators : after, before, on, between, is_present

Example → subscription[activated_at][after] = "1435054328"

subscription[next_billing_at][operator]

optional, timestamp(UTC) in seconds filter
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.
Supported operators : after, before, on, between

Example → subscription[next_billing_at][after] = "1435054328"

subscription[cancelled_at][operator]

optional, timestamp(UTC) in seconds filter
Time at which subscription was cancelled or is set to be cancelled.
Supported operators : after, before, on, between

Example → subscription[cancelled_at][after] = "1435054328"

subscription[has_scheduled_changes][operator]

optional, enumerated string filter
If true, there are subscription changes scheduled on next renewal. Possible values are : true, false
Supported operators : is

Example → subscription[has_scheduled_changes][is] = "true"

subscription[updated_at][operator]

subscription[offline_payment_method][operator]

optional, enumerated string filter
The preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit, boleto, us_automated_bank_transfer, eu_automated_bank_transfer, uk_automated_bank_transfer, jp_automated_bank_transfer, mx_automated_bank_transfer, custom
Supported operators : is, is_not, in, not_in

Example → subscription[offline_payment_method][is] = "cash"

subscription[auto_close_invoices][operator]

optional, enumerated string filter
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. Possible values are : true, false
Supported operators : is

Example → subscription[auto_close_invoices][is] = "true"

subscription[channel][operator]

customer

Parameters for customer
pass parameters as customer[<param name>][<operator>]

customer[id][operator]

optional, string filter
Identifier of the customer.
Supported operators : is, is_not, starts_with, in, not_in

Example → customer[id][is] = "9bsvnHgsvmsI"

customer[first_name][operator]

optional, string filter
First name of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[first_name][is] = "John"

customer[last_name][operator]

optional, string filter
Last name of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[last_name][is] = "Clint"

customer[email][operator]

optional, string filter
Email of the customer. Configured email notifications will be sent to this email.
Supported operators : is, is_not, starts_with, is_present

Example → customer[email][is] = "john@test.com"

customer[company][operator]

optional, string filter
Company name of the customer.
Supported operators : is, is_not, starts_with, is_present

Example → customer[company][is] = "Globex Corp"

customer[phone][operator]

optional, string filter
Phone number of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[phone][is] = "(541) 754-3010"

customer[auto_collection][operator]

optional, enumerated string filter
Whether payments needs to be collected automatically for this customer Possible values are : on, off
Supported operators : is, is_not, in, not_in

Example → customer[auto_collection][is] = "on"

customer[taxability][operator]

optional, enumerated string filter
Specifies if the customer is liable for tax Possible values are : taxable, exempt
Supported operators : is, is_not, in, not_in

Example → customer[taxability][is] = "taxable"

customer[created_at][operator]

optional, timestamp(UTC) in seconds filter
Timestamp indicating when this customer resource is created.
Supported operators : after, before, on, between

Example → customer[created_at][after] = "1435054328"

customer[updated_at][operator]

customer[offline_payment_method][operator]

optional, enumerated string filter
The preferred offline payment method for the customer. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit, boleto, us_automated_bank_transfer, eu_automated_bank_transfer, uk_automated_bank_transfer, jp_automated_bank_transfer, mx_automated_bank_transfer, custom
Supported operators : is, is_not, in, not_in

Example → customer[offline_payment_method][is] = "cash"

customer[auto_close_invoices][operator]

optional, enumerated string filter
Override for this customer, the site-level setting 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 which takes precedence. Possible values are : true, false
Supported operators : is

Example → customer[auto_close_invoices][is] = "true"

customer[channel][operator]

relationship

Parameters for relationship
pass parameters as relationship[<param name>][<operator>]

relationship[parent_id][operator]

optional, string filter
Immediate parent with whom we will link our new customer(child)
Supported operators : is, is_not, starts_with

Example → relationship[parent_id][is] = "future_billing"

relationship[payment_owner_id][operator]

optional, string filter
Parent who is going to pay
Supported operators : is, is_not, starts_with

Example → relationship[payment_owner_id][is] = "active1"

relationship[invoice_owner_id][operator]

optional, string filter
Parent who is going to handle invoices
Supported operators : is, is_not, starts_with

Example → relationship[invoice_owner_id][is] = "future_billing"

export

always returned
Resource object representing export

Important:

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

This API triggers export for the Deferred Revenue Report.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/deferred_revenue \
     -u {site_api_key}:\
     -d report_by="INVOICE" \
     -d report_from_month=6 \
     -d report_from_year=2020 \
     -d report_to_month=7 \
     -d report_to_year=2020

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/deferred_revenue \
     -u {site_api_key}:\
     -d report_by="INVOICE" \
     -d report_from_month=6 \
     -d report_from_year=2020 \
     -d report_to_month=7 \
     -d report_to_year=2020

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1612968382,
        "id": "__test__8aszcSOcsxDp7s",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Deferred Revenue Report",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/deferred_revenue

report_by[]

required, enumerated string
Determines the scope of the report. Returns the report based on the value specified.

Possible values are

customerCustomerinvoiceInvoiceproductProduct (Includes Plan, Addon and Adhoc)subscriptionSubscription

currency_code[]

default=null, string, max chars=3
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_from_month[]

required, integer
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[]

required, integer
Obtains report data from the specified year, combined with the value specified for report_from_month.

report_to_month[]

required, integer
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.

report_to_year[]

required, integer
Obtains report data until the specified year, combined with the value specified for report_to_month.

include_discounts[]

optional, boolean, default=true
Returns amount with discount in the report. If value specified is false, it returns amount without discount.

payment_owner[<operator>]

item_id[<operator>]

item_price_id[<operator>]

cancel_reason_code[<operator>]

business_entity_id[<operator>]

invoice

Parameters for invoice
pass parameters as invoice[<param name>][<operator>]

invoice[id][operator]

invoice[recurring][operator]

invoice[status][operator]

invoice[price_type][operator]

invoice[date][operator]

optional, timestamp(UTC) in seconds filter
The document date displayed on the invoice PDF.
Supported operators : after, before, on, between

Example → invoice[date][after] = "1394532759"

invoice[paid_at][operator]

invoice[total][operator]

invoice[amount_paid][operator]

invoice[amount_adjusted][operator]

optional, number filter
Total adjustments made against this invoice.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[amount_adjusted][is] = "100"

invoice[credits_applied][operator]

optional, number filter
Total credits applied against this invoice.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[credits_applied][is] = "100"

invoice[amount_due][operator]

invoice[dunning_status][operator]

invoice[updated_at][operator]

invoice[channel][operator]

subscription

Parameters for subscription
pass parameters as subscription[<param name>][<operator>]

subscription[id][operator]

subscription[customer_id][operator]

subscription[status][operator]

subscription[cancel_reason][operator]

subscription[remaining_billing_cycles][operator]

optional, number filter

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: this value is the number of billing cycles remaining in the contract term after the current billing cycle.

Supported operators : is, is_not, lt, lte, gt, gte, between, is_present

Example → subscription[remaining_billing_cycles][is] = "3"

subscription[created_at][operator]

subscription[activated_at][operator]

subscription[next_billing_at][operator]

subscription[cancelled_at][operator]

subscription[has_scheduled_changes][operator]

subscription[updated_at][operator]

subscription[offline_payment_method][operator]

subscription[auto_close_invoices][operator]

subscription[channel][operator]

customer

Parameters for customer
pass parameters as customer[<param name>][<operator>]

customer[id][operator]

optional, string filter
Identifier of the customer.
Supported operators : is, is_not, starts_with, in, not_in

Example → customer[id][is] = "9bsvnHgsvmsI"

customer[first_name][operator]

optional, string filter
First name of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[first_name][is] = "John"

customer[last_name][operator]

optional, string filter
Last name of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[last_name][is] = "Clint"

customer[email][operator]

customer[company][operator]

optional, string filter
Company name of the customer.
Supported operators : is, is_not, starts_with, is_present

Example → customer[company][is] = "Globex Corp"

customer[phone][operator]

optional, string filter
Phone number of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[phone][is] = "(541) 754-3010"

customer[auto_collection][operator]

customer[taxability][operator]

customer[created_at][operator]

customer[updated_at][operator]

customer[offline_payment_method][operator]

customer[auto_close_invoices][operator]

customer[channel][operator]

relationship

Parameters for relationship
pass parameters as relationship[<param name>][<operator>]

relationship[parent_id][operator]

relationship[payment_owner_id][operator]

optional, string filter
Parent who is going to pay
Supported operators : is, is_not, starts_with

Example → relationship[payment_owner_id][is] = "active1"

relationship[invoice_owner_id][operator]

optional, string filter
Parent who is going to handle invoices
Supported operators : is, is_not, starts_with

Example → relationship[invoice_owner_id][is] = "future_billing"

export

always returned
Resource object representing export

This API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/coupons \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/coupons \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTBFx8n",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Coupons",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/coupons

currency_code[<operator>]

optional, string filter
optional, string filter
The currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons alone.
Supported operators : is, is_not, starts_with, in, not_in

Example → currency_code[is] = "USD"
Supported operators : is, is_not, starts_with, in, not_in

Example → currency_code[is] = "USD"

coupon

Parameters for coupon
pass parameters as coupon[<param name>][<operator>]

coupon[id][operator]

optional, string filter

Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.

Note:

When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.

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

Example → coupon[id][is] = "OFF2008"

coupon[name][operator]

optional, string filter

The display name used in web interface for identifying the coupon.

Note:

When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.

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

Example → coupon[name][is] = "Offer 10"

coupon[discount_type][operator]

optional, enumerated string filter
The type of deduction Possible values are : fixed_amount, percentage, offer_quantity
Supported operators : is, is_not, in, not_in

Example → coupon[discount_type][is] = "fixed_amount"

coupon[duration_type][operator]

optional, enumerated string filter
Specifies the time duration for which this coupon is attached to the subscription. Possible values are : one_time, forever, limited_period
Supported operators : is, is_not, in, not_in

Example → coupon[duration_type][is] = "forever"

coupon[status][operator]

optional, enumerated string filter
Status of the coupon. Possible values are : active, expired, archived, deleted, future
Supported operators : is, is_not, in, not_in

Example → coupon[status][is] = "active"

coupon[apply_on][operator]

optional, enumerated string filter
The amount on the invoice to which the coupon is applied. Possible values are : invoice_amount, each_specified_item
Supported operators : is, is_not, in, not_in

Example → coupon[apply_on][is] = "invoice_amount"

coupon[created_at][operator]

optional, timestamp(UTC) in seconds filter
Timestamp indicating when this coupon is created.
Supported operators : after, before, on, between

Example → coupon[created_at][after] = "145222875"

coupon[updated_at][operator]

optional, timestamp(UTC) in seconds filter
To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
Supported operators : after, before, on, between

Example → coupon[updated_at][after] = "1243545465"

export

always returned
Resource object representing export

This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/customers \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/customers \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTC8J8p",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Customers",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/customers

export_type[]

optional, enumerated string, default=data
Determines the format of the data. Returns the export type based on the selected value.

Possible values are

dataDownload your current data in CSV.import_friendly_dataDownload import friendly data in CSV. This CSV can be used to perform bulk operations.

business_entity_id[<operator>]

optional, string filter
optional, string filter
The unique ID of the business entity of this subscription. This is always the same as the business entity of the customer.
Supported operators : is, is_not, starts_with

Example → business_entity_id[is] = "business_entity_id"
Supported operators : is, is_not, starts_with

Example → business_entity_id[is] = "business_entity_id"

customer

Parameters for customer
pass parameters as customer[<param name>][<operator>]

customer[id][operator]

optional, string filter
Identifier of the customer.
Supported operators : is, is_not, starts_with, in, not_in

Example → customer[id][is] = "9bsvnHgsvmsI"

customer[first_name][operator]

optional, string filter
First name of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[first_name][is] = "John"

customer[last_name][operator]

optional, string filter
Last name of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[last_name][is] = "Clint"

customer[email][operator]

customer[company][operator]

optional, string filter
Company name of the customer.
Supported operators : is, is_not, starts_with, is_present

Example → customer[company][is] = "Globex Corp"

customer[phone][operator]

optional, string filter
Phone number of the customer
Supported operators : is, is_not, starts_with, is_present

Example → customer[phone][is] = "(541) 754-3010"

customer[auto_collection][operator]

customer[taxability][operator]

customer[created_at][operator]

customer[updated_at][operator]

customer[offline_payment_method][operator]

customer[auto_close_invoices][operator]

customer[channel][operator]

relationship

Parameters for relationship
pass parameters as relationship[<param name>][<operator>]

relationship[parent_id][operator]

relationship[payment_owner_id][operator]

optional, string filter
Parent who is going to pay
Supported operators : is, is_not, starts_with

Example → relationship[payment_owner_id][is] = "active1"

relationship[invoice_owner_id][operator]

optional, string filter
Parent who is going to handle invoices
Supported operators : is, is_not, starts_with

Example → relationship[invoice_owner_id][is] = "future_billing"

export

always returned
Resource object representing export

This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/subscriptions \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/subscriptions \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1612968382,
        "id": "__test__8aszcSOcsxFR7t",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Subscriptions",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/subscriptions

export_type[]

optional, enumerated string, default=data
Determines the format of the data. Returns the export type based on the selected value.

Possible values are

dataDownload your current data in CSV.import_friendly_dataDownload import friendly data in CSV. This CSV can be used to perform bulk operations.

item_id[<operator>]

item_price_id[<operator>]

cancel_reason_code[<operator>]

subscription

Parameters for subscription
pass parameters as subscription[<param name>][<operator>]

subscription[id][operator]

subscription[customer_id][operator]

subscription[status][operator]

subscription[cancel_reason][operator]

subscription[remaining_billing_cycles][operator]

optional, number filter

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: this value is the number of billing cycles remaining in the contract term after the current billing cycle.

Supported operators : is, is_not, lt, lte, gt, gte, between, is_present

Example → subscription[remaining_billing_cycles][is] = "3"

subscription[created_at][operator]

subscription[activated_at][operator]

subscription[next_billing_at][operator]

subscription[cancelled_at][operator]

subscription[has_scheduled_changes][operator]

subscription[updated_at][operator]

subscription[offline_payment_method][operator]

subscription[auto_close_invoices][operator]

subscription[channel][operator]

export

always returned
Resource object representing export

This API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data.

Invoice Export Best Practice

For a full export, Chargebee recommends exporting data in batches by using date filters. The table below provides examples of how to set the filters:

Scenario	Filter Example	Description
Export invoices updated after January 1, 2024	invoice[updated_at][after] = "1704067200"	Export invoices from January 1, 2024 onwards.
Export invoices for 2023	invoice[updated_at][between] = "[1672531200,1704067199]"	Export all invoices for the year 2023.
Export invoices for 2022	invoice[updated_at][between] = "[1640995200,1672531199]"	Export all invoices for the year 2022.

If the export still fails, further reduce the date range, for example:

Scenario	Filter Example	Description
Export for the second half of 2024	invoice[updated_at][after] = "1717200000"	Export invoices are updated after June 1, 2024.
Export for the first half of 2024	invoice[updated_at][between] = "[1704067200,1717199999]"	Export invoices updated between January 1, 2024, and May 31, 2024.
Export for the second half of 2023	invoice[updated_at][between] = "[1685577600,1704067199]"	Export invoices updated between June 1, 2023, and December 31, 2023.
Export for the first half of 2023	invoice[updated_at][between] = "[1672531200,1685577599]"	Export invoices updated between January 1, 2023, and May 31, 2023.

Note

The date ranges in the examples above are just suggestions; you can adjust the date window to fit your specific needs. If an export fails due to large data volume, reduce the date window further and retry the export.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/invoices \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/invoices \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTCX18q",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Invoices",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/invoices

payment_owner[<operator>]

invoice

Parameters for invoice
pass parameters as invoice[<param name>][<operator>]

invoice[id][operator]

invoice[subscription_id][operator]

optional, string filter
To filter based on subscription_id.
NOTE: Not to be used if consolidated invoicing is enabled.
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → invoice[subscription_id][is] = "3bdjnDnsdQn"

invoice[customer_id][operator]

optional, string filter
The identifier of the customer this invoice belongs to.
Supported operators : is, is_not, starts_with, in, not_in

Example → invoice[customer_id][is] = "3bdjnDnsdQn"

invoice[recurring][operator]

invoice[status][operator]

invoice[price_type][operator]

invoice[date][operator]

optional, timestamp(UTC) in seconds filter
The document date displayed on the invoice PDF.
Supported operators : after, before, on, between

Example → invoice[date][after] = "1394532759"

invoice[paid_at][operator]

invoice[total][operator]

invoice[amount_paid][operator]

invoice[amount_adjusted][operator]

optional, number filter
Total adjustments made against this invoice.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[amount_adjusted][is] = "100"

invoice[credits_applied][operator]

optional, number filter
Total credits applied against this invoice.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → invoice[credits_applied][is] = "100"

invoice[amount_due][operator]

invoice[dunning_status][operator]

invoice[updated_at][operator]

Learn more about the best practice before performing full export.

Supported operators : after, before, on, between

Example → invoice[updated_at][after] = "1243545465"

invoice[channel][operator]

export

always returned
Resource object representing export

This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/credit_notes \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/credit_notes \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTBby8o",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Credit Notes",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/credit_notes

credit_note

Parameters for credit_note
pass parameters as credit_note[<param name>][<operator>]

credit_note[id][operator]

optional, string filter
Credit-note id.
Supported operators : is, is_not, starts_with, in, not_in

Example → credit_note[id][is] = "CN_123"

credit_note[customer_id][operator]

optional, string filter
The identifier of the customer this Credit Note belongs to.
Supported operators : is, is_not, starts_with, in, not_in

Example → credit_note[customer_id][is] = "4gmiXbsjdm"

credit_note[subscription_id][operator]

optional, string filter
To filter based on subscription_id.
NOTE: Not to be used if consolidated invoicing feature is enabled.
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → credit_note[subscription_id][is] = "4gmiXbsjdm"

credit_note[reference_invoice_id][operator]

optional, string filter
The identifier of the invoice against which this Credit Note is issued
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → credit_note[reference_invoice_id][is] = "INVOICE_876"

credit_note[type][operator]

optional, enumerated string filter
The credit note type. Learn more about credit note types. Possible values are : adjustment, refundable, store
Supported operators : is, is_not, in, not_in

Example → credit_note[type][is] = "adjustment"

credit_note[reason_code][operator]

optional, enumerated string filter
The reason for issuing this Credit Note. The following reason codes are supported now[Deprecated; use the create_reason_code parameter instead] Possible values are : write_off, subscription_change, subscription_cancellation, subscription_pause, chargeback, product_unsatisfactory, service_unsatisfactory, order_change, order_cancellation, waiver, other, fraudulent
Supported operators : is, is_not, in, not_in

Example → credit_note[reason_code][is] = "waiver"

credit_note[create_reason_code][operator]

optional, string filter
Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Credit Notes > Create Credit Note. 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 → credit_note[create_reason_code][is] = "Other"

credit_note[status][operator]

optional, enumerated string filter
The credit note status. Possible values are : adjusted, refunded, refund_due, voided
Supported operators : is, is_not, in, not_in

Example → credit_note[status][is] = "adjusted"

credit_note[date][operator]

optional, timestamp(UTC) in seconds filter
The date the Credit Note is issued.
Supported operators : after, before, on, between

Example → credit_note[date][after] = "1435054328"

credit_note[total][operator]

optional, number filter
Credit Note amount in cents.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → credit_note[total][is] = "1200"

credit_note[price_type][operator]

optional, enumerated string filter
The price type of the Credit Note. Possible values are : tax_exclusive, tax_inclusive
Supported operators : is, is_not, in, not_in

Example → credit_note[price_type][is] = "tax_exclusive"

credit_note[amount_allocated][operator]

optional, number filter
The amount allocated to the invoices.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → credit_note[amount_allocated][is] = "1200"

credit_note[amount_refunded][operator]

optional, number filter
The refunds issued from this Credit Note.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → credit_note[amount_refunded][is] = "130"

credit_note[amount_available][operator]

optional, number filter
The yet to be used credits of this Credit Note.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → credit_note[amount_available][is] = "1400"

credit_note[voided_at][operator]

optional, timestamp(UTC) in seconds filter
Timestamp indicating the date and time this Credit Note gets voided.
Supported operators : after, before, on, between

Example → credit_note[voided_at][after] = "1435054328"

credit_note[updated_at][operator]

optional, timestamp(UTC) in seconds filter
To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
Supported operators : after, before, on, between

Example → credit_note[updated_at][after] = "1243545465"

credit_note[channel][operator]

export

always returned
Resource object representing export

This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/transactions \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/transactions \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTEge8u",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Transactions",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/transactions

transaction

Parameters for transaction
pass parameters as transaction[<param name>][<operator>]

transaction[id][operator]

optional, string filter
Uniquely identifies the transaction.
Supported operators : is, is_not, starts_with, in, not_in

Example → transaction[id][is] = "txn_88ybdbsnvf2"

transaction[customer_id][operator]

optional, string filter
Identifier of the customer for which this transaction is made
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → transaction[customer_id][is] = "5hjdk8nOpd"

transaction[subscription_id][operator]

optional, string filter
Identifier of the subscription for which this transaction is made.
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → transaction[subscription_id][is] = "5hjdk8nOpd"

transaction[payment_source_id][operator]

optional, string filter
To filter based on Transaction payment source id.
Supported operators : is, is_not, starts_with, is_present, in, not_in

Example → transaction[payment_source_id][is] = "pm_3Nl8XXUQUXDVFa2"

transaction[payment_method][operator]

optional, enumerated string filter
The payment method of this transaction Possible values are : card, cash, check, chargeback, bank_transfer, amazon_payments, paypal_express_checkout, direct_debit, alipay, unionpay, apple_pay, wechat_pay, ach_credit, sepa_credit, ideal, google_pay, sofort, bancontact, giropay, dotpay, other, upi, netbanking_emandates, custom, boleto, venmo, pay_to, faster_payments, sepa_instant_transfer, automated_bank_transfer, klarna_pay_now, online_banking_poland
Supported operators : is, is_not, in, not_in

Example → transaction[payment_method][is] = "card"

transaction[gateway][operator]

optional, enumerated string filter
Gateway through which this transaction was done. Applicable only for 'Card' Payment Method Possible values are : chargebee, chargebee_payments, adyen, stripe, wepay, braintree, authorize_net, paypal_pro, pin, eway, eway_rapid, worldpay, balanced_payments, beanstream, bluepay, elavon, first_data_global, hdfc, migs, nmi, ogone, paymill, paypal_payflow_pro, sage_pay, tco, wirecard, amazon_payments, paypal_express_checkout, gocardless, orbital, moneris_us, moneris, bluesnap, cybersource, vantiv, checkout_com, paypal, ingenico_direct, exact, mollie, quickbooks, razorpay, global_payments, bank_of_america, ecentric, metrics_global, windcave, pay_com, ebanx, dlocal, nuvei, paystack, jp_morgan, not_applicable
Supported operators : is, is_not, in, not_in

Example → transaction[gateway][is] = "stripe"

transaction[gateway_account_id][operator]

optional, string filter
The gateway account used for this transaction
Supported operators : is, is_not, starts_with, in, not_in

Example → transaction[gateway_account_id][is] = "gw_3Nl9BNeQ7438Ks1"

transaction[id_at_gateway][operator]

optional, string filter
The id with which this transaction is referred in gateway.
Supported operators : is, is_not, starts_with

Example → transaction[id_at_gateway][is] = "txn_5678HJS89900"

transaction[reference_number][operator]

optional, string filter
The reference number for this transaction. For example, the check number when payment_method = check.
Supported operators : is, is_not, starts_with, is_present

Example → transaction[reference_number][is] = "cus_u239732"

transaction[type][operator]

optional, enumerated string filter
Type of the transaction. Possible values are : authorization, payment, refund, payment_reversal
Supported operators : is, is_not, in, not_in

Example → transaction[type][is] = "payment"

transaction[date][operator]

optional, timestamp(UTC) in seconds filter
Indicates when this transaction occurred.
Supported operators : after, before, on, between

Example → transaction[date][after] = "1435054328"

transaction[amount][operator]

optional, number filter
Amount for this transaction.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → transaction[amount][is] = "1200"

transaction[amount_capturable][operator]

optional, number filter
To filter based on transaction’s unused authorized/blocked amount.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → transaction[amount_capturable][is] = "1200"

transaction[status][operator]

optional, enumerated string filter
The status of this transaction. Possible values are : in_progress, success, voided, failure, timeout, needs_attention, late_failure
Supported operators : is, is_not, in, not_in

Example → transaction[status][is] = "success"

transaction[updated_at][operator]

export

always returned
Resource object representing export

This API triggers export of order data. The exported zip file contains CSV files with order-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/orders \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/orders \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__KyVnHhSBWTDEb8r",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Orders",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/orders

total[<operator>]

optional, number filter
optional, in cents filter
Total amount charged for the order.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → total[is] = "1394532759"
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → total[is] = "1394532759"

order

Parameters for order
pass parameters as order[<param name>][<operator>]

order[id][operator]

optional, string filter
Uniquely identifies the order. It is the api identifier for the order
Supported operators : is, is_not, starts_with, in, not_in

Example → order[id][is] = "3"

order[subscription_id][operator]

optional, string filter
To filter based on subscription_id.

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

Example → order[subscription_id][is] = "3bdjnDnsdQn"

order[customer_id][operator]

optional, string filter
The customer for which the order is created
Supported operators : is, is_not, starts_with, in, not_in

Example → order[customer_id][is] = "3bdjnDnsdQn"

order[status][operator]

optional, enumerated string filter
The status of this order. Possible values are : new, processing, complete, cancelled, voided, queued, awaiting_shipment, on_hold, delivered, shipped, partially_delivered, returned
Supported operators : is, is_not, in, not_in

Example → order[status][is] = "paid"

order[price_type][operator]

optional, enumerated string filter
The price type of the order Possible values are : tax_exclusive, tax_inclusive
Supported operators : is, is_not, in, not_in

Example → order[price_type][is] = "tax_exclusive"

order[order_date][operator]

optional, timestamp(UTC) in seconds filter
The date on which the order will start getting processed.
Supported operators : after, before, on, between

Example → order[order_date][after] = "1394532759"

order[shipping_date][operator]

optional, timestamp(UTC) in seconds filter
This is the date on which the order will be delivered to the customer.
Supported operators : after, before, on, between

Example → order[shipping_date][after] = "1394532759"

order[shipped_at][operator]

optional, timestamp(UTC) in seconds filter
The time at which the order was shipped.
Supported operators : after, before, on, between

Example → order[shipped_at][after] = "1394532759"

order[delivered_at][operator]

optional, timestamp(UTC) in seconds filter
The time at which the order was delivered
Supported operators : after, before, on, between

Example → order[delivered_at][after] = "1394532759"

order[cancelled_at][operator]

optional, timestamp(UTC) in seconds filter
The time at which the order was cancelled.
Supported operators : after, before, on, between

Example → order[cancelled_at][after] = "1394532759"

order[amount_paid][operator]

optional, number filter
Total amount paid for the order.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → order[amount_paid][is] = "1000"

order[refundable_credits][operator]

optional, number filter
The total amount that can be issued as credits for this order.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → order[refundable_credits][is] = "1000"

order[refundable_credits_issued][operator]

optional, number filter
The total amount issued as credits on behalf of this order.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → order[refundable_credits_issued][is] = "1000"

order[updated_at][operator]

optional, timestamp(UTC) in seconds filter
Filter based on the time at which order has been updated.
Supported operators : after, before, on, between

Example → order[updated_at][after] = "1243545465"

order[resent_status][operator]

optional, enumerated string filter
Resent order status. Possible values are : fully_resent, partially_resent
Supported operators : is, is_not, in, not_in

Example → order[resent_status][is] = "fully_resent"

order[is_resent][operator]

optional, enumerated string filter
Order is resent order or not. Possible values are : true, false
Supported operators : is

Example → order[is_resent][is] = "false"

order[original_order_id][operator]

optional, string filter
If resent order what is the parent order id.
Supported operators : is, is_not, starts_with

Example → order[original_order_id][is] = "1243545465"

export

always returned
Resource object representing export

This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/item_families \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/item_families \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__8at0kS38wNVKS",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Item Families",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/item_families

business_entity_id[<operator>]

optional, enumerated string filter
optional, string filter
The unique ID of the business entity of this item_family. Learn more about all the scenarios before using this filter.
Supported operators : is, is_present

Example → business_entity_id[is_present] = "true" Possible values are : true, false
Supported operators : is_present, is

Example → business_entity_id[is_present] = "business_entity_id"

include_site_level_resources[<operator>]

optional, enumerated string filter
optional, boolean filter

Default value is true . To exclude site-level resources in specific cases, set this parameter to false.

Possible values are : true, false
Supported operators : is

Example → include_site_level_resources[is] = "null" Possible values are : true, false
Supported operators : is

Example → include_site_level_resources[is] = "null"

item_family

Parameters for item_family
pass parameters as item_family[<param name>][<operator>]

item_family[id][operator]

optional, string filter
The identifier for the item family. It is unique and immutable.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_family[id][is] = "family-id"

item_family[name][operator]

optional, string filter
A unique display name for the item family. This is visible only in Chargebee and not to customers.
Supported operators : is, is_not, starts_with

Example → item_family[name][is] = "family-name"

item_family[updated_at][operator]

optional, timestamp(UTC) in seconds filter
When the item family was last updated.
Supported operators : after, before, on, between

Example → item_family[updated_at][after] = "1243545465"

export

always returned
Resource object representing export

This API triggers export of item data. The exported zip file contains CSV files with item-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/items \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/items \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__8at0kS38wOG7U",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Items",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/items

business_entity_id[<operator>]

optional, enumerated string filter
optional, string filter
The unique ID of the business entity of this item. Learn more about all the scenarios before using this filter.
Supported operators : is, is_present

Example → business_entity_id[is_present] = "true" Possible values are : true, false
Supported operators : is_present, is

Example → business_entity_id[is_present] = "business_entity_id"

include_site_level_resources[<operator>]

optional, enumerated string filter
optional, boolean filter

Default value is true . To exclude site-level resources in specific cases, set this parameter to false.

item

Parameters for item
pass parameters as item[<param name>][<operator>]

item[id][operator]

optional, string filter
Filter items based on item id.
Supported operators : is, is_not, starts_with, in, not_in

Example → item[id][is] = "basic"

item[item_family_id][operator]

optional, string filter
Filter items based on item_family_id.
Supported operators : is, is_not, starts_with, in, not_in

Example → item[item_family_id][is] = "acme"

item[type][operator]

optional, enumerated string filter
Filter items based on item type. Possible values are : plan, addon, charge
Supported operators : is, is_not, in, not_in

Example → item[type][is] = "plan"

item[name][operator]

optional, string filter
Filter items based on item name.
Supported operators : is, is_not, starts_with

Example → item[name][is] = "basic"

item[item_applicability][operator]

optional, enumerated string filter
Filter items based on item_applicability. Possible values are : all, restricted
Supported operators : is, is_not, in, not_in

Example → item[item_applicability][is] = "all"

item[status][operator]

optional, enumerated string filter
Filter items based on item status. Possible values are : active, archived, deleted
Supported operators : is, is_not, in, not_in

Example → item[status][is] = "active"

item[is_giftable][operator]

optional, enumerated string filter
Specifies if gift subscriptions can be created for this item. Possible values are : true, false
Supported operators : is

Example → item[is_giftable][is] = "true"

item[updated_at][operator]

optional, timestamp(UTC) in seconds filter
Filter items based on when the items were last updated.
Supported operators : after, before, on, between

Example → item[updated_at][after] = "1243545465"

item[enabled_for_checkout][operator]

optional, enumerated string filter
Allow the plan to subscribed to via Checkout. Applies only for plan-items.
Note: Only the in-app version of Checkout is supported for Product Catalog v2. Possible values are : true, false
Supported operators : is

Example → item[enabled_for_checkout][is] = "null"

item[enabled_in_portal][operator]

optional, enumerated string filter
Allow customers to change their subscription to this plan via the Self-Serve Portal. Applies only for plan-items. This requires the Portal configuration to allow changing subscriptions. Possible values are : true, false
Supported operators : is

Example → item[enabled_in_portal][is] = "null"

item[metered][operator]

optional, enumerated string filter
Specifies whether the item undergoes metered billing. When true, the quantity is calculated from usage records. When false, the quantity is as determined while adding an item price to the subscription. Applicable only for items of type plan or addon and when Metered Billing is enabled. The value of this attribute cannot be changed. Possible values are : true, false
Supported operators : is

Example → item[metered][is] = "true"

item[usage_calculation][operator]

optional, enumerated string filter
How the quantity is calculated from usage data for the item prices belonging to this item. Only applicable when the item is metered. This value overrides the one set at the site level. Possible values are : sum_of_usages, last_usage, max_usage
Supported operators : is, is_not, in, not_in

Example → item[usage_calculation][is] = "SUM_OF_USAGES"

item[channel][operator]

export

always returned
Resource object representing export

This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/item_prices \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/item_prices \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__8at0kS38wNs8T",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Item Prices",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/item_prices

item_family_id[<operator>]

optional, string filter
optional, string filter
Filter item prices based on item_family_id.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_family_id[is] = "Acme"
Supported operators : is, is_not, starts_with, in, not_in

Example → item_family_id[is] = "Acme"

item_type[<operator>]

optional, enumerated string filter
optional, enumerated string filter
Filter item prices based on item_type. Possible values are : plan, addon, charge.
Supported operators : is, is_not, in, not_in

Example → item_type[is_not] = "plan" Possible values are : plan, addon, charge
Supported operators : is, is_not, in, not_in

Example → item_type[is] = "plan"

currency_code[<operator>]

optional, string filter
optional, string filter
Filter item prices based on their currency_code.
Supported operators : is, is_not, starts_with, in, not_in

Example → currency_code[is] = "USD"
Supported operators : is, is_not, starts_with, in, not_in

Example → currency_code[is] = "USD"

business_entity_id[<operator>]

optional, enumerated string filter
optional, string filter
The unique ID of the business entity of this item_price. Learn more about all the scenarios before using this filter.
Supported operators : is, is_present

Example → business_entity_id[is_present] = "true" Possible values are : true, false
Supported operators : is_present, is

Example → business_entity_id[is_present] = "business_entity_id"

include_site_level_resources[<operator>]

optional, enumerated string filter
optional, boolean filter

Default value is true . To exclude site-level resources in specific cases, set this parameter to false.

item_price

Parameters for item_price
pass parameters as item_price[<param name>][<operator>]

item_price[id][operator]

optional, string filter
Filter item prices based on their id.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_price[id][is] = "basic_USD"

item_price[name][operator]

optional, string filter
Filter item prices based on their names.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_price[name][is] = "basic USD"

item_price[pricing_model][operator]

optional, enumerated string filter
Filter item prices based on their pricing_model. Possible values are : flat_fee, per_unit, tiered, volume, stairstep
Supported operators : is, is_not, in, not_in

Example → item_price[pricing_model][is] = "flat_fee"

item_price[item_id][operator]

optional, string filter
Filter item prices based on their item_id.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_price[item_id][is] = "basic"

item_price[price_variant_id][operator]

optional, string filter
Filter item prices based on their price_variant_id.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_price[price_variant_id][is] = "tamilNadu-India"

item_price[trial_period][operator]

optional, number filter
Filter item prices based on their trial_period.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → item_price[trial_period][is] = "14"

item_price[trial_period_unit][operator]

optional, enumerated string filter
Filter item prices based on their trial_period_unit. Possible values are : day, month
Supported operators : is, is_not, in, not_in

Example → item_price[trial_period_unit][is] = "day"

item_price[status][operator]

optional, enumerated string filter
Filter item prices based on their status. Possible values are : active, archived, deleted
Supported operators : is, is_not, in, not_in

Example → item_price[status][is] = "active"

item_price[updated_at][operator]

optional, timestamp(UTC) in seconds filter
Filter item prices based on their updated_at.
Supported operators : after, before, on, between

Example → item_price[updated_at][after] = "1243545465"

item_price[period_unit][operator]

optional, enumerated string filter
Filter item prices based on their period_unit. Possible values are : day, week, month, year
Supported operators : is, is_not, in, not_in

Example → item_price[period_unit][is] = "month"

item_price[period][operator]

optional, number filter
Filter item prices based on their period.
Supported operators : is, is_not, lt, lte, gt, gte, between

Example → item_price[period][is] = "3"

item_price[channel][operator]

export

always returned
Resource object representing export

This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/attached_items \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/attached_items \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791401,
        "id": "__test__8at0kS38wMW5Q",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Attached Items",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/attached_items

item_type[<operator>]

optional, enumerated string filter
optional, enumerated string filter
To filter based on the type of of the attached item. Possible values are : addon, charge. Possible values are : plan, addon, charge.
Supported operators : is, is_not, in, not_in

Example → item_type[is_not] = "plan" Possible values are : plan, addon, charge
Supported operators : is, is_not, in, not_in

Example → item_type[is] = "plan"

attached_item

Parameters for attached_item
pass parameters as attached_item[<param name>][<operator>]

attached_item[id][operator]

optional, string filter
Filter attached items based on their id.
Supported operators : is, is_not, starts_with, in, not_in

Example → attached_item[id][is] = "bec0c324-adb6-44d3-ad4f-694f449be97c"

attached_item[item_id][operator]

optional, string filter
Filter attached items based on the item_id of the item being attached.
Supported operators : is, is_not, starts_with, in, not_in

Example → attached_item[item_id][is] = "basic"

attached_item[type][operator]

optional, enumerated string filter
Filter attached items based on the type of attached item. Possible values are : recommended, mandatory, optional. Possible values are : recommended, mandatory, optional
Supported operators : is, is_not, in, not_in

Example → attached_item[type][is] = "mandatory"

attached_item[charge_on_event][operator]

optional, enumerated string filter
Indicates when the item is charged. This attribute only applies to charge-items. Possible values are : subscription_creation, subscription_trial_start, plan_activation, subscription_activation, contract_termination, on_demand
Supported operators : is, is_not, in, not_in

Example → attached_item[charge_on_event][is] = "subscription_creation"

attached_item[updated_at][operator]

optional, timestamp(UTC) in seconds filter
Filter attached items based on when the attached items were last updated.
Supported operators : after, before, on, between

Example → attached_item[updated_at][after] = "1243545465"

attached_item[parent_item_id][operator]

optional, string filter
The id of the plan-item to which the item is attached.
Supported operators : is, is_not, starts_with, in, not_in

Example → attached_item[parent_item_id][is] = "silver"

export

always returned
Resource object representing export

This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/differential_prices \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/differential_prices \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "created_at": 1527791400,
        "id": "__test__8at0kS38wN74R",
        "mime_type": "zip",
        "object": "export",
        "operation_type": "Differential Prices",
        "status": "in_process"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/differential_prices

item_id[<operator>]

optional, string filter
optional, string filter
Item Id of Addon / Charge item price for which differential pricing is applied to.
Supported operators : is, is_not, starts_with, in, not_in

Example → item_id[is] = "day-pass"
Supported operators : is, is_not, starts_with, in, not_in

Example → item_id[is] = "day-pass"

differential_price

Parameters for differential_price
pass parameters as differential_price[<param name>][<operator>]

differential_price[item_price_id][operator]

optional, string filter
The id of the item price (addon or charge) whose price should change according to the plan-item it is applied to.
Supported operators : is, is_not, starts_with, in, not_in

Example → differential_price[item_price_id][is] = "day-pass-USD"

differential_price[id][operator]

optional, string filter
A unique and immutable id for the differential price. It is auto-generated when the differential price is created.
Supported operators : is, is_not, starts_with, in, not_in

Example → differential_price[id][is] = "defcc4f1-f21f-47f4-8019-beddb9beab5f"

differential_price[parent_item_id][operator]

optional, string filter
The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the Standard or Enterprise plans-items mentioned in the examples above.
Supported operators : is, is_not, starts_with, in, not_in

Example → differential_price[parent_item_id][is] = "basic"

export

always returned
Resource object representing export

This API triggers export of price variant data. The exported zip file contains CSV files with price variant-related data.

Sample Request

curl  https://{site}.chargebee.com/api/v2/exports/price_variants \
     -u {site_api_key}:

copy

Click to Copy

curl  https://{site}.chargebee.com/api/v2/exports/price_variants \
     -u {site_api_key}:

Sample Response [ JSON ]

{
    "export": {
        "operation_type": "Price Variants",
        "mime_type": "zip",
        "created_at": 1527791400,
        "id": "__test__8aspETyUuirhM",
        "status": "in_process",
        "object": "export"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/exports/price_variants

business_entity_id[<operator>]

optional, enumerated string filter
optional, string filter
The unique ID of the business entity of this price_variant. Learn more about all the scenarios before using this filter.
Supported operators : is, is_present

Example → business_entity_id[is_present] = "true" Possible values are : true, false
Supported operators : is_present, is

Example → business_entity_id[is_present] = "business_entity_id"

include_site_level_resources[<operator>]

optional, enumerated string filter
optional, boolean filter

Default value is true . To exclude site-level resources in specific cases, set this parameter to false.

price_variant

Parameters for price_variant
pass parameters as price_variant[<param name>][<operator>]

price_variant[id][operator]

optional, string filter
Filter variant based on their id.
Supported operators : is, is_not, starts_with, in, not_in

Example → price_variant[id][is] = "basic"

price_variant[name][operator]

optional, string filter
Filter variant based on their names.
Supported operators : is, is_not, starts_with, in, not_in

Example → price_variant[name][is] = "basic"

price_variant[status][operator]

optional, enumerated string filter
Filter variant based on their status. Possible values are : active, archived
Supported operators : is, is_not, in, not_in

Example → price_variant[status][is] = "active"

price_variant[updated_at][operator]

optional, timestamp(UTC) in seconds filter
Filter product based on their updated time.
Supported operators : after, before, on, between

Example → price_variant[updated_at][after] = "1243545465"

price_variant[created_at][operator]

optional, timestamp(UTC) in seconds filter
Filter product based on their created time.
Supported operators : after, before, on, between

Example → price_variant[created_at][after] = "1243545465"

export

always returned
Resource object representing export

Sample export [ JSON ]

API Index URL GET

Model Class

Export attributes

Consent Fields for Export

Custom Fields for Export

Retrieve an export ¶

Notes

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Revenue Recognition Reports ¶

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Deferred Revenue Reports ¶

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Coupons ¶

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Customers ¶

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Subscriptions ¶

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Invoices ¶

Invoice Export Best Practice

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Export Credit Notes ¶

Notes