Retrieve an enrollment
/users/{user_id}/enrollments/{enrollment_id}Retrieves an enrollment of the user by its public ID.
The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the enrollment to avoid overwriting a newer version.
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
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 <= 64Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/users/string/enrollments/string"{ "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" }}Create an enrollment POST
Grants the user access to a delivery. The `Idempotency-Key` header is required. If the user already has an enrollment for the same delivery, the existing enrollment is reactivated and returned with `200 OK` instead of creating a new one. The credentials must have access to every product included in the delivery. A delivery that does not exist, is archived, has no products, or includes products outside the scope of the current credentials is rejected with a validation error on `delivery_id`.
Update an enrollment PATCH
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.