Appearance

Subscription Model ​

In a subscription-based business model, customers typically pay a recurring fee to access a service or product for a defined period of time. Creduse's API provides the necessary functionality to seamlessly implement and manage subscription plans within your application.

The subscription model workflow with Creduse typically involves the following steps:

  • Start a Cycle: When a new user subscribes to your service, you initiate a new cycle by calling the /start-cycle endpoint. You will need to define the timeframe during which the cycle is valid plus the amount of credits the user will receive. This cycle represents the subscription period during which the user's credits are valid.
  • Subtract Credits: As the user consumes your service or performs various actions, you subtract credits from their balance using the /subtract endpoint. This deduction reflects the usage or consumption of your service.
  • Automatic Renew of the Cycle: When the current cycle expires, it will be renewd automatically without any user intervention. The user will continue to have access to your service as long as the subscription is active.

Implementation ​

Here's an example of how you might implement the subscription model using Creduse's API:

Step 1: Start a Cycle ​

When a new user subscribes to your service, you'll need to start a new cycle for them. This example shows how to start a cycle with an initial credit amount of 1000 and a validity period of 30 days.

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

Step 2: Subtract Credits ​

Call the /subtract endpoint to deduct 10 credits from a user's balance whenever they perform an action that consumes credits. Here's an example:

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

If the user's balance reaches zero, you can prompt them to renew their subscription or purchase additional credits to continue using your service.

Step 3: Automatic Renewal ​

When the current cycle expires, the system will automatically renew the cycle for the user. The user will continue to have access to your service as long as the subscription is active.

For further details about: