Start the user's first credit period.

Does nothing when the user already has a period, unless replaceUnusedPeriods is set and the user has no credit order; then the user's periods for the policy are deleted and replaced. The start date may be further back than one period; the periods since then are rolled over straight away.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
date-time
required
string
boolean

The periods are deleted and the first period is started from startDate. A user with a credit order of any status keeps the periods and gets ALREADY_STARTED. Custom credit amounts and environmental bonus set on the deleted periods are lost.

customCreditAmount
object

Set after the periods since startDate are rolled over, e.g. the remaining credit of an imported user. Credit amounts that are left out keep the start value or the rolled over credit.

Responses

409

Activated by another request at the same time, or a period to replace is being rolled over, retry

422

Unprocessable entity

500

Internal server error

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