GET
/
v5
/
company
/
memberships

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
statuses
enum<string>[]

An array of statuses to filter by.

Available options:
active,
trialing,
past_due,
completed,
canceled,
expired,
unresolved
​
valid
boolean
default: true

A boolean to filter by valid memberships

​
product_id
string

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

​
license_key
string

A license key to filter by.

​
page
integer
default: 1

The page number to retrieve

​
per
integer
default: 10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json
​
pagination
object
required
​
data
object[]
required

Was this page helpful?

OverviewRetrieve a Membership