Start Cycle

POST https://api.creduse.com/start-cycle

Starts a new cycle for a user. This is typically used when a user subscribes to a service or starts a pay-as-you-go monthly session.

• The cycle will be valid for the specified number of days, after which it will be automatically renewed.

For a further explanation of the concept of cycles, see the Cycles page.

Request body

Parameter	Type	Description
end_user_id	UUID	Required. The unique identifier of the user.
amount	integer	Required. The number of credits to add to the user's balance.
validity_days	integer or null	The number of days the cycle will be valid. Defaults to 31.

Example request

curl https://api.creduse.com/start-cycle \
    -H "Authorization : Bearer $YOUR_API_KEY"
    -H "Content-Type: application/json" \
    -d '{
        "end_user_id": "UUID",
        "amount": 100,
        "validity_days": 31
        }' \

Returns

Returns a cycle object representing the newly created cycle.

{
  "end_user_id": "UUID",
  "amount": 100,
  "created_at": "2024-01-01T18:50:22",
  "current_cycle_start": "2024-01-01T18:50:22",
  "current_cycle_end": "2024-02-29T23:59:99",
  "status": "active"
}