Resource: /levels

Contents

Supported Verbs: GET, POST

GET

Retrieves an array list of all membership levels. Each entry contains the following:

Variable Name Type Description
$id integer Membership Level ID
$name string Membership Level Name

POST

Creates a new membership level

Variable Name Type Description Default Values
$id integer READ-ONLY
Membership Level ID
$name string REQUIRED
Membership Level Name
$registration_url string Registration URL slug. Auto-generated if not specified on creation auto-generated
$after_login_redirect mixed After login redirect page
Possible values are “global” – default global settings; “homepage”
homepage; $page_id – specific page
global
$after_registration_redirect mixed After registration redirect page
Possible values are “global” – default global settings; “homepage”
homepage; $page_id – specific page
global
$access_all_pages boolean FALSE
$access_all_categories boolean FALSE
$access_all_posts boolean FALSE
$access_all_comments boolean FALSE
$no_expiry boolean TRUE
$expiry integer Expiration schedule (ignored if $no_expiry is TRUE)
$expiry_period string The period relating to $expiry
Possible values are Days; Weeks; Months; Years
Days
$sequential_upgrade_to integer Membership Level ID to upgrade to. Leave blank to disable sequential upgrade for level
$sequential_upgrade_after integer Sequential upgrade schedule in days
$sequential_upgrade_method string Sequential upgrade method
Possible values are ADD; MOVE
Note: Zero-day moves are not allowed
$member_count integer READ-ONLY
Total number of members in the level
$require_captcha boolean FALSE
$require_email_confirmation boolean FALSE
$require_admin_approval boolean FALSE
$grant_continued_access boolean FALSE
$disable_existing_users_link boolean FALSE
$registration_date_reset boolean FALSE
$uncancel_on_registration boolean FALSE
$wordpress_role string WordPress role subscriber
$level_order integer
$remove_from_levels[remove_from_level] array An array of membership level Ids to remove a user from when a user is added to this level.
Updated on July 11, 2018

Was this article helpful?

Not the solution you were looking for?
Click the link below to submit a support ticket
Submit Ticket