Skip to content
Sencai Logo Sencai Logo Sencai Docs

List user-subscription-enrollments

GET
/user-subscription-enrollments

F3.USERPLAN.01 — one enrollment per user (oneToOne), tracks the user’s personal User Plan lifecycle (trial → active/free → cancelled). Auto-created on user registration (see src/lifecycles/user-kc-sync.ts).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
pagination[page]
integer
pagination[pageSize]
integer
filters

Strapi REST filter syntax

object
sort
string
populate
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
data
Array
object
user
required
One of:

DocumentId reference to plugin::users-permissions.user

string
plan
One of:

DocumentId reference to api::user-plan.user-plan

string
status
required
string
Allowed values: trial active pending_downgrade grace_period cancelled
started_at
string format: date-time
trial_ends_at
string format: date-time
expires_at
string format: date-time
sponsor
One of:

DocumentId reference to plugin::users-permissions.user

string
stripe_customer_id

Convention: user-${userId}, symmetric to the existing org-${orgId} convention (see billing-adapter.ts / checkout.ts).

string
stripe_subscription_id
string
sponsorship_invitation_token

F3.USERPLAN.04 — 7-day JWT (mirrors organisation-member.invitation_token) proving the sponsor invited THIS beneficiary. Set on POST /:sponsorId/sponsor, cleared once accepted (or replaced by a new invite).

string
pending_sponsorship

F3.USERPLAN.04 — set while a sponsorship invitation is outstanding (not yet accepted by the beneficiary): { sponsorId, sponsorEnrollmentId, tierId, beneficiaryEmail, invitedAt }. Cleared on accept (sponsor/plan/status become authoritative) or on a fresh re-invite.

sponsorship_stripe_item_id

F3.USERPLAN.04 — id of the Stripe subscription item added to the SPONSOR’s existing subscription for this beneficiary (stripe.subscriptionItems). Required to remove exactly this line item on revoke without touching the sponsor’s own base plan item or other beneficiaries’ items.

string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable
meta
object
pagination
object
page
integer
pageSize
integer
pageCount
integer
total
integer

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

Not authorized (tenant scope or capability)