Update an enrollment
/users/{user_id}/enrollments/{enrollment_id}Updates the status or scheduled end of an enrollment, or restores a revoked enrollment.
Setting status to revoked or deleted to false requires the enrollments.delete permission in addition to enrollments.update. Only manually granted enrollments can be revoked or restored; enrollments originating from a sale or subscription return state_conflict.
ends_at must be an ISO 8601 date-time with a time zone offset. Send null to remove the scheduled end.
To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request 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
application/json
application/json
curl -X PATCH "https://example.com/users/string/enrollments/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "created_at": "2019-08-24T14:15:22Z", "deleted": true, "delivery_id": "string", "ends_at": "2019-08-24T14:15:22Z", "id": "string", "object": "enrollment", "origin": { "kind": "manual", "sale_id": "string", "subscription_id": "string" }, "product_ids": [ "string" ], "revision": "string", "status": "active", "subscription_ends_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string" }}