Welcome
Guides
Wingback.js
Advanced
API Reference
- Introduction
- Customer
- Contract
- Billing Portal
- Entitlements
- Usage
- Payment
- Balance
- Virtual Wallets (Credits)
- Invoices
Get Access Entitlements
Retrieve a list of all features a customer currently has access to.
curl --request GET \
--url http://127.0.0.1:8080/v1/c/entitlement/{customer_id}/access \
--header 'wb-key: <api-key>'
{
"contract": {
"contract_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"status": "active"
},
"customer": {
"status": "active"
},
"plan": {
"entitlement_details": {
"pricing_strategy": "flat"
},
"features": [
{
"entitlement_details": {
"pricing_strategy": "flat"
},
"name": "<string>",
"original_feature_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"slug": "<string>"
}
],
"name": "<string>",
"original_plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"slug": "<string>"
}
}
Authorizations
Path Parameters
Id of the customer
Response
Data to show what features the given user should have access to
Describes Contract object for Entitlement endpoint
Unique identifier of an object. Consists of object class prefix and a UUID
Status of the contract:
- Active - Contract is active
- Pending - Contract is not active
- Scheduled - Contract is scheduled to activate in the future
- Canceled - Contract has been canceled
- Moved - User upgraded from this contract to a different one
- NotReady - Contract was created, but billing engine has not completed contract setup
active
, pending
, scheduled
, canceled
, moved
, not_ready
Describes the status of the customer for Entitlement response
Status of the Customer
- Active - customer is active
- Inactive - Customer account was deactivated
- Temporary - Customer was created, but registration process was not completed
active
, inactive
, temporary
Reduced information about a Plan for Entitlement endpoint
Features that the plan gives access to
Reduced information about the plan features for Entitlement API
Name of the feature
Slug of the feature
Reduced information about price specific to the Entitlement endpoint
flat
Unique identifier of an object. Consists of object class prefix and a UUID
Name of the plan
Slug of the plan
Reduced information about price specific to the Entitlement endpoint
flat
Unique identifier of an object. Consists of object class prefix and a UUID
curl --request GET \
--url http://127.0.0.1:8080/v1/c/entitlement/{customer_id}/access \
--header 'wb-key: <api-key>'
{
"contract": {
"contract_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"status": "active"
},
"customer": {
"status": "active"
},
"plan": {
"entitlement_details": {
"pricing_strategy": "flat"
},
"features": [
{
"entitlement_details": {
"pricing_strategy": "flat"
},
"name": "<string>",
"original_feature_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"slug": "<string>"
}
],
"name": "<string>",
"original_plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"slug": "<string>"
}
}