Skip to main content
GET
/
api
/
accounts
/
{id}
/
subscription
cURL
curl --request GET \
  --url https://api.recoupable.com/api/accounts/{id}/subscription \
  --header 'x-api-key: <api-key>'
{
  "isPro": true,
  "status": "active",
  "plan": "pro",
  "source": "account"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Path Parameters

​
id
string<uuid>
required

The unique identifier (UUID) of the account. Must be the authenticated account or another accessible via organization membership.

Response

Subscription retrieved successfully

​
isPro
boolean
required

True when the account has an active paid subscription, directly or via an organization.

​
status
enum<string>
required

Lifecycle state of the subscription. none when no subscription exists.

Available options:
active,
trialing,
canceled,
past_due,
none
Example:

"active"

​
plan
string | null
required

Plan identifier (e.g. pro). Null when no subscription exists.

Example:

"pro"

​
source
enum<string> | null
required

Origin of the subscription. account for direct, organization when covered by an organization. Null when no subscription exists.

Available options:
account,
organization
Example:

"account"