younifyd
Menu

List Entitlements

List entitlements granted to an account

GET/accounts/{account_id}/entitlements

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List Entitlements action (under account).
  3. Fill in the fields below, then reference the result from later steps as {{listEntitlements.response.data}}.

Request

Path parameters

account_idstringrequired

Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

Query parameters

statestring

Filter the entitlements based on the state of the applicable subscription. - When `state=active`, `state=canceled`, `state=expired`, or `state=future`, subscriptions with states that match the query and only those subscriptions will be returned. - When no state is provided, subscriptions with active or canceled states will be returned.

One ofactivecanceledexpiredfuture

Response

Returns 200 with an object. Read it in later steps with {{listEntitlements.response.data.<field>}}.

objectstring
has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
objectstring

Entitlement

customer_permissionobject5 fields
granted_byarray<object>2 fields

Subscription or item that granted the customer permission.

created_atstring (date-time)

Time object was created.

updated_atstring (date-time)

Time the object was last updated

json
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "object": "string",
      "customer_permission": {
        "id": "string",
        "code": "string",
        "name": "string",
        "description": "string",
        "object": "string"
      },
      "granted_by": [
        {
          "object": "string",
          "id": "string"
        }
      ],
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.