NAME

WebService::Braintree::SubscriptionSearch

PURPOSE

This class represents a search for subscriptions.

This class should never be instantiated directly. Instead, you will access objects of this class through the search interface.

FIELDS

address_country_name

This is a text field. It will restrict the search to a specific country name.

billing_cycles_remaining

This is a range field. It will restrict the search to subscriptions created between the two values.

days_past_due

This is a range field. It will restrict the search to subscriptions created between the two values.

id

This is a text field. It will restrict the search to a specific id.

ids

This is a multiple-values field. It will restrict the search to a list of specific ids.

in_trial_period

This is a multiple-values field. It will restrict the search to the provided list.

merchant_account_id

This is a multiple-values field. It will restrict the search to the provided list.

next_billing_date

This is a range field. It will restrict the search to subscriptions created between the two values.

plan_id

This is a text field. It will restrict the search to a specific id.

price

This is a range field. It will restrict the search to subscriptions created between the two values.

status

This is a multiple-values field. It will restrict the search to the provided list.

This list is restricted to the values defined by "All" in WebService::Braintree::Subscription::Status

transaction_id

This is a text field. It will restrict the search to a specific id.