Developers
Enrollments

List enrollments

GET/enrollments

Lists enrollments across all users in the account.

At least one of user_id, product_id, delivery_id, or updated_after must be supplied; requests without any of these filters are rejected with a validation error. Revoked enrollments are excluded unless status=revoked or deleted=true is supplied.

Each item includes a links.self URL pointing to the enrollment under its user.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
user_id?string
product_id?string
delivery_id?string
status?string

Value in

  • "active"
  • "suspended"
  • "revoked"
origin?string

Value in

  • "manual"
  • "sale"
  • "subscription"
deleted?boolean
updated_after?string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/enrollments"
{  "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"    }  ]}

Enrollments

Enrollments in API v3: list enrollments, list a user's enrollments, create an enrollment, retrieve an enrollment, update an enrollment.

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.