Skip to main content
GET
Get user plan
This endpoint returns the subscription plan of one of your users: a plan you gave them with Update user plan, or one they subscribed to on your platform. data is null when the user has no plan.
This endpoint is available to the account owner (with an active plan) and to team members with Billing Access. Other users receive a 403 Forbidden error. Only users of your platform can be read: any other ID, including the owner account, returns 404.

Path Parameters

integer
required
The ID of the user. Administrators can list user IDs with Get platform users.

Response

object | null
The user’s plan, or null when they have none

Rate limit

The platform settings, default limits, user settings and plan endpoints share a limit of 60 requests per minute for each account. Above it they return 429, and the Retry-After response header tells you how many seconds to wait.

Example