> ## Documentation Index
> Fetch the complete documentation index at: https://docs.grdd.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Billing and plan access

> Preview plan access on Connect at data.grdd.net and keep payment and subscription changes separate.

## Choose your task

| Task | Start here |
| - | - |
| Preview whether your plan permits an operation | Use [`POST /api/entitlements/check`](#preview-plan-access-on-connect) on Connect. |
| Check a content operation's plan requirements | Read the endpoint's Authentication and access section, such as [fleets](https://docs.grdd.dev/connect-api/content/fleets.md#authentication-and-access), [vehicles](https://docs.grdd.dev/connect-api/content/vehicles.md#authentication-and-access) or [services](https://docs.grdd.dev/connect-api/content/services.md#authentication-and-access). |
| Understand a refused or unavailable content operation | [API errors](https://docs.grdd.dev/connect-api/content/api-conventions.md#errors) and the endpoint's error table. |
| Add a payment method in the portal | [Add payment method](https://docs.grdd.dev/gnet-connect/billing/add-payment-method.md). |
| Change a subscription or request another billing integration | Contact [GRiDD support](mailto:support@grdd.net). This reference does not document a payments or subscription-change API. |

## Check the protected operation

Plan requirements apply to individual operations. A successful read does not grant permission to create, publish or start another workflow. Check the plan requirements and limits on the endpoint page before writing data.

A plan denial and an unavailable decision are different results. Where documented, `403 entitlement_denied` means the plan does not permit the operation. `503 temporarily_unavailable` means the service could not establish the required facts. Do not treat either result as permission to continue.

## Previews and billing metadata

Use the Connect preview below for your company's plan-access decisions. A preview is a snapshot. It does not reserve quota, charge an account or authorize a later command.

Billing-profile metadata is not a payment operation. Use the supported portal or a separately approved billing integration for payment and subscription work. Do not infer a financial API from a profile field or dashboard request.

## Preview plan access on Connect

Send `POST https://data.grdd.net/api/entitlements/check` with a [Core-issued Bearer access token](https://docs.grdd.dev/connect-api/get-token.md) and `Content-Type: application/json`. The token selects your company. The request does not accept a company, plan, usage, trial or exemption selector. It does not need `Idempotency-Key` or `If-Match`.

```bash theme={null}
curl --include --fail-with-body -X POST \
  'https://data.grdd.net/api/entitlements/check' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"capabilities":["fleet.create","vehicle.create"]}'
```

The strict JSON body accepts only `capabilities`, an array of 1 to 18 recognized capability IDs. Use the capability for the operation you intend to perform:

| Task | Capability IDs |
| - | - |
| Create content | `location.create`, `fleet.create`, `vehicle.create`, `member.create`, `service.create`, `testimonial.create`, `document.create`, `faq.create`, `profilePage.create` |
| Publish or reply to a need | `need.publish`, `need.reply`, `need.recipientDetail` |
| Search access | `search.results`, `search.badgeFilter`, `search.activityStatus` |
| Other plan checks | `smartAgent.use`, `document.tracking`, `rateEngine.paidProduct` |

A capability name is a plan check, not a reference for an otherwise undocumented API.

### Preview response

`200` returns `companyId`, `preview: true` and `decisions`, in request order. Each decision has these fields:

| Field | Meaning |
| - | - |
| `capability` | The requested capability ID. |
| `outcome` | `allowed`, `denied` or `unavailable`. Check this even when HTTP status is `200`. |
| `reason` | `granted`, `trial`, `not_included`, `quota_exhausted`, `subscription_expired`, `facts_unavailable`, `capability_unknown`, `usage_unavailable` or `grant_unresolved`. |
| `plan` | `io`, `basic`, `professional`, `premium`, `enterprise` or `null`. |
| `limit`, `remaining` | A nonnegative integer, `"unlimited"` or `null`. |
| `usage` | A nonnegative integer or `null`. `null` does not mean zero. |
| `windowMs` | A positive rolling-window duration in milliseconds, or `null`. |
| `contractVersion` | A positive integer that identifies the decision contract version. |

The operation checks access again before protected work. An `allowed` preview does not guarantee later capacity. An `unavailable` decision is not permission to proceed.

Request-level failures use the [Connect problem format](https://docs.grdd.dev/connect-api/content/api-conventions.md#errors), including `400 invalid_request`, `401 unauthenticated`, `403 forbidden` or `503 temporarily_unavailable`. These are separate from decision outcomes inside a `200` response.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.