List subscriptions

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

Example → customer_id[is] = "8gsnbYfsMLds"

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

Example → item_id[is_not] = "silver"

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

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

Current state of the subscription. Possible values are : future, in_trial, active, non_renewing, paused, cancelled.

Supported operators : is, is_not, in, not_in

Example → status[is_not] = "active"

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 → cancel_reason[is] = "not_paid"

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"

• 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 → remaining_billing_cycles[is_not] = "3"

The time at which the subscription was created. Supported operators : after, before, on, between

Example → created_at[before] = "1435054328"

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 → activated_at[after] = "1435054328"

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 → next_billing_at[after] = "1435054328"

Time at which subscription was cancelled or is set to be cancelled. Supported operators : after, before, on, between

Example → cancelled_at[after] = "1435054328"

If true , there are subscription changes scheduled on next renewal. Possible values are : true, false

Supported operators : is

Example → has_scheduled_changes[is] = "true"

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 → updated_at[after] = "1243545465"

The preferred offline payment method for the subscription. Possible values are : no_preference, cash, check, bank_transfer, ach_credit, sepa_credit.

Supported operators : is, is_not, in, not_in

Example → offline_payment_method[is_not] = "cash"

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 → auto_close_invoices[is] = "true"

If true , ignores the hierarchy relationship and uses customer as payment and invoice owner. Possible values are : true, false

Supported operators : is

Example → override_relationship[is] = "false"

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"

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 → channel[is_not] = "APP STORE"