Create a user-subscription-enrollment

POST

/user-subscription-enrollments

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Request Body ^required

object

data

object

user

required

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

plan

One of:

string

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

string

object

object

key

additional properties

any

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:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

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

Responses

200

Created

object

data

object

user

required

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

plan

One of:

string

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

string

object

object

key

additional properties

any

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:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

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

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)