GET /subscriptions

The device from which the customer has made the request

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.

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

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.

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"

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

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

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"

optional, boolean filter

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

Supported operators : is

Example → has_scheduled_changes[is] = "true"

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"

optional, enumerated string filter

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"

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

optional, boolean filter

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"

Indicates whether to include deleted objects in the list. The deleted objects have the attribute deleted as true .

Default value: false

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

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 → id[is_not] = "8gsnbYfsMLds"

optional, string filter

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"

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.

Supported operators : is, is_not, in, not_in

Example → offline_payment_method[is_not] = "cash"

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

The number of resources to be returned.

Default value: 10

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

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

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

optional, timestamp(UTC) in seconds filter

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

Example → created_at[before] = "1435054328"

optional, string filter

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

Example → item_id[is_not] = "silver"

optional, string filter

Sorts based on the specified attribute. Supported attributes : created_at, updated_at

Supported sort-orders : asc, desc

Example → sort_by[asc] = "created_at"

This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.

Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set offset to the value of next_offset obtained in the previous iteration of the API call.