Subscription
For loop type edd_subscription
, here are the query parameters and fields.
Query parameters
bill_times
- Bill times
Type: numberbill_times_operator
- Bill times operator
Type: stringcreation_date
- Creation exact date. Will ignore creation_start and creation_end if specified
Type: datecreation_end
- Creation end date
Type: datecreation_start
- Creation start date
Type: dateexpiration_date
- Creation start date or 'any' for any non-lifetime expiration. Will ignore expiration_start and expiration_end if specified
Type: date, stringexpiration_end
- Creation start date
Type: dateexpiration_start
- Creation start date
Type: dategateway
- Payment gateway
Type: stringid
- Restrict to ids
Type: arraynumber
- Posts per page
Type: numberorder
- Order: ASC or DESC
Type: string - Default: ASCorderby
- Order by field
Type: string - Default: nameparent_payment_id
- Get subscriptions for specific payment. Ignores all other arguments if specified.
Type: number, stringproduct_id
- Specific products
Type: number, stringsearch
- Search
Type: stringstatus
- Subscription status
Type: array, stringuser
- User ID, name, or "current". Ignores all other arguments if specified.
Type: number, string
Fields
bill_times
- bill_timescan_cancel
- Determines if subscription can be cancelledcan_reactivate
- Determines if subscription can be reactivatedcan_renew
- Determines if subscription can be manually renewedcan_retry
- Determines if subscription can be retried when failingcan_update
- Determines if subscription can have their payment method updatedcancel_url
- Retrieves the URL to cancel subscriptionchild_payments
- Retrieve renewal payments for a subscription. Returns a loop.created
- createdcustomer_id
- Customer IDexpiration
- expirationgateway
- gatewayid
- Subscription IDinitial_amount
- initial_amountinitial_tax
- initial_taxinitial_tax_rate
- initial_tax_rateis_active
- Determines if subscription is activeis_expired
- Determines if subscription is expiredlifetime_value
- Gets the lifetime value for the subscriptionparent_payment_id
- parent_payment_idperiod
- Periodprice_id
- price_idproduct_id
- product_idprofile_id
- profile_idreactivation_url
- Retrieves the URL to reactivate subscriptionrecurring_amount
- recurring_amountrecurring_tax
- recurring_taxrecurring_tax_rate
- recurring_tax_raterenew_url
- Retrieves the URL to renew a subscriptionretry_url
- Retrieves the URL to retry a failing subscriptionstatus
- Retrieves the subscription statusstatus_label
- Retrieves the subscription status labeltimes_billed
- Returns the number of times the subscription has been billedtransaction_id
- Retrieves the transaction ID from the subscriptiontrial_period
- trial_periodupdate_url
- Retrieves the URL to update subscription