Skip to main content
GET
/
v5
/
me
/
memberships
List Memberships
curl --request GET \
  --url https://{defaultHost}/v5/me/memberships \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "user_id": "<string>",
      "plan_id": "<string>",
      "page_id": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "renewal_period_start": 123,
      "renewal_period_end": 123,
      "quantity": 123,
      "valid": true,
      "cancel_at_period_end": true,
      "metadata": {},
      "affiliate_username": "<string>",
      "manage_url": "<string>",
      "status": "trialing",
      "license_key": "<string>",
      "checkout_id": "<string>",
      "company_buyer_id": 123,
      "marketplace": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

User OAuth token for /v5/me endpoints

Query Parameters

​
company_id
string

An ID of a company to filter by, which will look like biz_*************

​
product_id
string

An ID of a product to filter by, which will look like prod_*************

​
statuses
enum<string>[]
Available options:
active,
trialing,
past_due,
completed,
canceled,
expired,
unresolved
​
valid
boolean
default:true
​
license_key
string
​
page
integer
default:1
​
per
integer
default:10

Response

200 - application/json

memberships retrieved

​
pagination
object
required
​
data
object[]
required