Skip to content
API referenceConsumerBilling

Get the caller's currently effective entitlements

GET
/consumer/v1/billing/entitlements/current

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/consumer/v1/billing/entitlements/current"
{  "billing_account_id": "db2251e5-5308-40a7-9f48-3aed5a9ce736",  "can_use_shared_exit_node": true,  "extras": {    "property1": "string",    "property2": "string"  },  "in_grace": true,  "max_bandwidth_gb": 0,  "max_devices": 0,  "max_exit_nodes": 0,  "max_seats": 0,  "max_sessions": 0,  "multi_hop_max_hops": 0,  "pending_cancel": true,  "plan_code": "string",  "priority_support": true,  "valid_until": "2019-08-24T14:15:22Z"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}
{  "detail": "Pool slug must be unique.",  "instance": "urn:forestvpn:trace:a1b2c3d4",  "title": "Validation Error",  "type": "https://fvpn.net/errors/validation"}