Menu

Please select your page
Home > Documentation > Concepts > Commitments

Commitments

Subscriptions may be part of a commitment agreement based on the terms and conditions of the subscription product. There are three different behaviors that you can use when creating a subscription product with a commitment. This is explained in detail below.

  • Renew Commitment
  • Continue Without Commitment
  • Close Subscription
Commitment can have a fixed or infinite duration. Setting the numberOfCycles and endOfCommitmentAction will determine the behavior of a commitment.

1- Behavior Renew_Commitment

In this behavior, a subscription with commitment can be renewable after each commitment cycle ends. This means that the subscription will continuously renew itself. In other words, it will run indefinitely until it is canceled.

renew_commitment.drawio.png

Request object example:

"commitment": {
  "numberOfPeriods": 3,
  "numberOfCycles": null
  "endOfCommitmentAction": "RENEW_COMMITMENT"
}

If a commitment is indefinite, the numberOfCycles value doesn't need to be defined, which means it can carry a null value. However, in the other two behaviors CONTINUEWITHOUTCOMMITMENT and CLOSE_SUBSCRIPTION, the value of this field should be provided in order to determine the end of the commitment agreement.

2- Behavior ContinueWithoutCommitment

In this behavior, a subscription with commitment could be finite but can continue its own lifetime without any commitment. This means once number of commitment cycles has been complete, the subscription will continue as a running subscription (regular) subscription.

It can be automatically renewable as long as the length of numberOfCycles is greater than one.

continue_without_commitment.drawio.png

Request object example:

"commitment": {
  "numberOfPeriods": 3,
  "numberOfCycles": 2
  "endOfCommitmentAction": "CONTINUE_WITHOUT_COMMITMENT"
}

3- Behavior Close_Subscription

In this behavior, a subscription with commitment is finite based on the length of numberOfCycles. This means that once the number of commitment cycles has been complete then subscription will be closed.

close_subscription.drawio-1.png

Request object example:

"commitment": {
  "numberOfPeriods": 3,
  "numberOfCycles": 1
  "endOfCommitmentAction": "CLOSE_SUBSCRIPTION"
}

If there are more cycles in a commitment, it can be automatically renewable as long as length of numberOfCycles greater than one.

close_subscription.drawio-2.png

Request object example:

"commitment": {
  "numberOfPeriods": 3,
  "numberOfCycles": 2
  "endOfCommitmentAction": "CLOSE_SUBSCRIPTION"
}

By default, commitments will be renewed on the same day of the cycle on which it was started. For example, a subscription with a commitment that started on the 9th day of the month will always renew on the 9th day of that month for the next cycle.

Request Parameters

Commitment object must be provided as a part of termsAndConditions object in the subscription product.

Parameters in the commitment object to be sent to the service are as follows:

Input Name Type Description
NumberOfPeriods Integer Specifies how many periods are in a commitment cycle.
NumberOfCycles Integer? Specifies how many cycles the commitment will last.
Null means indefinitely, in other words, it runs until canceled.
EndOfCommitmentAction String Specifies the type of action to take when the commitment is complete.
Valid values are:
RENEW_COMMITMENT
CONTINUE_WITHOUT_COMMITMENT
CLOSE_SUBSCRIPTION