Create an enrollment
/users/{user_id}/enrollmentsGrants 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 or is archived is rejected with a validation error on delivery_id.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
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/users/string/enrollments" \ -H "Content-Type: application/json" \ -d '{ "delivery_id": "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" }}List a user's enrollments GET
Lists the user's enrollments, one per delivery. When the credentials are restricted to specific products, only enrollments for deliveries that include at least one of those products are returned. Revoked enrollments are excluded unless `status=revoked` or `deleted=true` is supplied.
Retrieve an enrollment GET
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.