Skip to main content

Entitlement

Operations on Entitlements.


Terminate an entitlement

An entitlement can be terminated by the customer or the service provider. The termination process varies depending on the entitlement's status.

  • If the entitlement is active
    • The entitlement can be terminated immediately or on a specified future date.
    • Suger will automatically calculate charges for any outstanding usage and generate the final invoice.
    • If the payment schedule type is prepay, the customer will receive a refund for the unused period.
  • If the entitlement is pending
    • The entitlement will be terminated immediately without any charges.

Alert before the end date of an entitlement

Sellers can configure the alertDaysBeforeEnd field in the entitlement configuration to send an alert to both the seller and the customer before the end date of an entitlement. The alertDaysBeforeEnd field can be set to 15 or 45 days.

AutoRenew an entitlement

Sellers can configure the autoRenew field in the entitlement configuration to automatically renew the entitlement at the end date. The autoRenew field can be set to either true or false.

  • If set to true, the entitlement will be automatically renewed at the end date.
  • If set to false, the entitlement will not be automatically renewed.