Subscription loop
For loop type edd_subscription
, here are the available query arguments and fields.
Query arguments
-
bill_times
- Bill timesType: number
-
bill_times_operator
- Bill times operatorType: string
-
creation_date
- Creation exact date. Will ignore creation_start and creation_end if specifiedType: date
-
creation_end
- Creation end dateType: date
-
creation_start
- Creation start dateType: date
-
expiration_date
- Creation start date or 'any' for any non-lifetime expiration. Will ignore expiration_start and expiration_end if specifiedType: date, string
-
expiration_end
- Creation start dateType: date
-
expiration_start
- Creation start dateType: date
-
gateway
- Payment gatewayType: string
-
id
- Restrict to idsType: array
-
number
- Posts per pageDefault:
-1
Type: number -
order
- Order: ASC or DESCDefault:
ASC
Type: string -
orderby
- Order by fieldDefault:
name
Type: string -
parent_payment_id
- Get subscriptions for specific payment. Ignores all other arguments if specified.Type: number, string
-
product_id
- Specific productsType: number, string
-
search
- SearchType: string
-
status
- Subscription statusType: array, string
-
user
- User ID, name, or "current". Ignores all other arguments if specified.Type: number, string
Fields
-
bill_times
- bill_times
-
can_cancel
- Determines if subscription can be cancelled
-
can_reactivate
- Determines if subscription can be reactivated
-
can_renew
- Determines if subscription can be manually renewed
-
can_retry
- Determines if subscription can be retried when failing
-
can_update
- Determines if subscription can have their payment method updated
-
cancel_url
- Retrieves the URL to cancel subscription
-
child_payments
- Retrieve renewal payments for a subscription. Returns a loop.
-
created
- created
-
customer_id
- Customer ID
-
expiration
- expiration
-
gateway
- gateway
-
id
- Subscription ID
-
initial_amount
- initial_amount
-
initial_tax
- initial_tax
-
initial_tax_rate
- initial_tax_rate
-
is_active
- Determines if subscription is active
-
is_expired
- Determines if subscription is expired
-
lifetime_value
- Gets the lifetime value for the subscription
-
parent_payment_id
- parent_payment_id
-
period
- Period
-
price_id
- price_id
-
product_id
- product_id
-
profile_id
- profile_id
-
reactivation_url
- Retrieves the URL to reactivate subscription
-
recurring_amount
- recurring_amount
-
recurring_tax
- recurring_tax
-
recurring_tax_rate
- recurring_tax_rate
-
renew_url
- Retrieves the URL to renew a subscription
-
retry_url
- Retrieves the URL to retry a failing subscription
-
status
- Retrieves the subscription status
-
status_label
- Retrieves the subscription status label
-
times_billed
- Returns the number of times the subscription has been billed
-
transaction_id
- Retrieves the transaction ID from the subscription
-
trial_period
- trial_period
-
update_url
- Retrieves the URL to update subscription