Skip to main content
GET
cURL

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

Subscription that confers the account's plan, directly or via an organization. plan, source, and the six billing fields (name, amountCents, currency, interval, collectionMethod, currentPeriodEnd) are all null when status is none.

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"

name
string | null
required

Display name of the plan's Stripe price (nickname) or product. Null when no subscription exists.

Example:

"Pro"

amountCents
integer | null
required

Recurring amount in the smallest currency unit (cents for USD). Null when no subscription exists.

Example:

9900

currency
string | null
required

ISO 4217 currency code, lowercase.

Example:

"usd"

interval
enum<string> | null
required

Billing interval of the recurring price.

Available options:
day,
week,
month,
year
Example:

"month"

collectionMethod
enum<string> | null
required

charge_automatically bills the card on file at renewal; send_invoice emails an invoice that is paid manually (enterprise plans). A saved card is never charged for a send_invoice plan.

Available options:
charge_automatically,
send_invoice
Example:

"charge_automatically"

currentPeriodEnd
string<date-time> | null
required

End of the current billing period: the renewal date, or the next invoice date for invoiced plans.

Example:

"2026-10-04T00:00:00Z"