Sign in
Billing Entitlements

Get billing entitlements

Changed on

Returns all the entitlements a billing customer currently has access to

<div> <code>read:billing_entitlements</code> </div>
get/api/v1/billing/entitlements

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/billing/entitlements
  • Auth: HTTP bearer

Query parameters

page_sizeinteger nullable

Number of results per page. Defaults to 10 if parameter not sent.

starting_afterstring nullable

The ID of the billing entitlement to start after.

ending_beforestring nullable

The ID of the billing entitlement to end before.

customer_idstring required

The ID of the billing customer to retrieve entitlements for

max_valuestring nullable

When the maximum limit of an entitlement is null, this value is returned as the maximum limit

expand'plans' nullable

Additional plan data to include in the response. Allowed value: "plans".

Response

Billing entitlements successfully retrieved.

codestring

Response code.

messagestring

Response message.

has_moreboolean

Whether more records exist.

Example response

{
  "code": "OK",
  "message": "Success",
  "entitlements": [
    {
      "id": "entitlement_0195ac80a14e8d71f42b98e75d3c61ad",
      "fixed_charge": 35,
      "price_name": "Pro gym",
      "feature_code": "CcdkvEXpbg6UY",
      "feature_name": "Pro Gym"
    }
  ],
  "plans": [
    {
      "subscribed_on": "2024-11-18T13:32:03+11"
    }
  ]
}

Changes