Revoke access to a purchase with nothing further to bill
Records one revocation for the entitlement; recomputation then ends it with reason revoked. Refused 409 already_ended on an ended entitlement or one already revoked, and 409 cancel_instead on anything still billing (cancel the subscription or line instead). A reason is required (400). Agents are refused (agent_revoke_not_available). Staff mode is not served: a request carrying Hms-Staff-Session is refused 400 staff_session_not_allowed, as on every member route.
/entitlement_revocationsRecords one revocation for the entitlement; recomputation then ends it with reason revoked. Refused 409 already_ended on an ended entitlement or one already revoked, and 409 cancel_instead on anything still billing (cancel the subscription or line instead). A reason is required (400). Agents are refused (agent_revoke_not_available). Staff mode is not served: a request carrying Hms-Staff-Session is refused 400 staff_session_not_allowed, as on every member route.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/entitlement_revocations" \ -H "Content-Type: application/json" \ -d '{ "entitlement": "string" }'{ "id": "string", "object": "entitlement_revocation", "entitlement": "string", "revoked_at": "2019-08-24T14:15:22Z", "withdrawn_at": "string", "operation_id": "cb4ede3c-a5d1-45e3-a9d2-fe83accbce52"}