HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

User / Subscribe to plan

Subscribe a user to a plan and collect payment.

The subscription and installment are created immediately. Payment collection happens asynchronously
and does not affect the response. If paymentMethodId is provided, that payment method is used
exclusively. If omitted, the system uses automatic payment method resolution. For free pre-paid plans (price = 0) and post-paid plans, payment is skipped.

If the user already has an active subscription to a different plan, that subscription is cancelled
and the new one is activated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

the user ID to subscribe to the plan

Body Params
integer
required

The ID of the subscription plan to activate

integer

Specific payment method ID to use for collection. Must belong to the target user and
be an active tokenized payment method (cards, bank transfers, wallets). If omitted when
the plan requires payment at activation, the system uses automatic payment method resolution.

string
required

Free-text reason recorded with the action event for audit purposes.

Responses
202

Action accepted.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json