Skip to navigation
Entitlements Service APIEntitlements

Modify entitlement expiration

View as Markdown

Modifies the expiration date of an entitlement. For the entitlement modified:

  • live is updated to true
  • An EntitlementTransaction is created
  • If called on a meta-entitlement with renewal date correction enabled, existing orders for the resource move to the new expiration date
  • An entitlement.entitlements_expiration_modified event is triggered upon successful modification

The entitlement must belong to the authenticated merchant; otherwise the request returns 404. If another request modifies the same entitlement at the same time, this request returns 409 and makes no changes — retry it.

Requires Application API Scope authentication.

Path parameters

entitlement.public_idstringRequired
Entitlement ID.

Request

This endpoint expects an object.
expirationdateRequired

New expiration date, in YYYY-MM-DD format. The entitlement expires at 23:59:59 UTC on this date, so today’s date is accepted but earlier dates aren’t.

Response

resultsobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error