| Method |
Description |
|
|
add_note ( $note = '' ) |
Adds a new note to a member |
|
|
calculate_expiration ( $force_now = false ) : String |
Calculates the new expiration date for a member |
|
|
can_access ( $post_id ) |
Determines if the member can access current content |
|
|
cancel ( ) |
Sets a member's membership as cancelled by updating status |
|
|
get_card_details ( ) : string |
Get details about the member's card on file |
|
|
get_expiration_date ( $formatted = true, $pending = true ) |
Retrieves the expiration date of the member |
|
|
get_expiration_time ( ) |
Retrieves the expiration date of the member as a timestamp |
|
|
get_joined_date ( $subscription_id ) : string |
Retrieves the joined date for a subscription |
|
|
get_merchant_subscription_id ( ) |
Retrieves the subscription ID of the member from the merchant processor. |
|
|
get_notes ( ) |
Retrieves the notes on a member |
|
|
get_payment_profile_id ( ) |
Retrieves the profile ID of the member. |
|
|
get_payments ( ) |
Retrieves all payments belonging to the member |
|
|
get_pending_subscription_id ( ) |
Retrieves the pending subscription ID of the member |
|
|
get_pending_subscription_key ( ) |
Retrieves the pending subscription key of the member |
|
|
get_pending_subscription_name ( ) |
Retrieves the pending subscription name of the member |
|
|
get_prorate_credit_amount ( ) : integer |
Get the prorate credit amount for the user's remaining subscription |
|
|
get_renewed_date ( $subscription_id ) : string |
Retrieves the renewed date for a subscription |
|
|
get_status ( ) |
Retrieves the status of the member |
|
|
get_subscription_id ( ) |
Retrieves the subscription ID of the member |
|
|
get_subscription_key ( ) |
Retrieves the subscription key of the member |
|
|
get_subscription_name ( ) |
Retrieves the current subscription name of the member |
|
|
get_switch_to_url ( ) |
Gets the URL to switch to the user
if the User Switching plugin is active |
|
|
has_trialed ( ) |
Determines if the member has used a trial |
|
|
is_active ( ) |
Determines if a member has an active subscription, or is cancelled but has not reached EOT |
|
|
is_expired ( ) |
Determines if the member is expired |
|
|
is_recurring ( ) |
Determines if a member has a recurring subscription |
|
|
is_trialing ( ) |
Determines if the member is currently trailing |
|
|
just_upgraded ( ) : integer |
Determines if the customer just upgraded |
|
|
renew ( $recurring = false, $status = 'active', $expiration = '' ) |
Renews a member's membership by updating status and expiration date |
|
|
set_expiration_date ( $new_date = '' ) |
Sets the expiration date for a member |
|
|
set_joined_date ( $date = '', $subscription_id ) |
Sets the joined date for a member |
|
|
set_merchant_subscription_id ( $subscription_id = '' ) |
Sets the payment profile ID for a member |
|
|
set_payment_profile_id ( $profile_id = '' ) |
Sets the payment profile ID for a member |
|
|
set_recurring ( $yes = true ) |
Sets whether a member is recurring |
|
|
set_renewed_date ( $date = '' ) |
Sets the renewed date for a member |
|
|
set_status ( $new_status = '' ) |
Sets the status of a member |
|