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

# Get customer entitlements

> Returns whether the customer has access to paid features and at what tier. Use this before serving any feature — don't parse subscription state yourself. Returns `has_access: false` if the customer has no subscription.




## OpenAPI

````yaml GET /v1/customers/{id}/entitlements
openapi: 3.0.3
info:
  title: Plinth API
  version: 0.9.0
  description: >
    Recurring billing for Nigerian SaaS — card charging, bank transfers via
    virtual accounts,

    proration, dunning, and recovery in one API.


    All amounts are in **kobo** (1/100th of a Naira). ₦5,000 = `500000`.
servers:
  - url: https://api.useplinth.com
    description: Production
  - url: http://localhost:7331
    description: Local development
security:
  - BearerAuth: []
tags:
  - name: Sandbox
    description: Create an isolated sandbox environment for testing. No auth required.
  - name: Customers
    description: Who you are billing. One customer can have multiple subscriptions.
  - name: Plans
    description: Plan groups and the plans within them. Customers subscribe to plans.
  - name: Subscriptions
    description: The recurring billing relationship between a customer and a plan.
  - name: Virtual Accounts
    description: Dedicated bank account numbers for customers who pay by transfer.
  - name: Invoices
    description: Created at each billing cycle. Tracks what a customer owes for a period.
  - name: Webhooks
    description: >-
      Register endpoints that receive signed, retried events. See Receiving
      webhooks.
  - name: Admin
    description: Test clock control, billing tick, and suspense resolution. Test-mode only.
paths:
  /v1/customers/{id}/entitlements:
    get:
      tags:
        - Customers
      summary: Get customer entitlements
      description: >
        Returns whether the customer has access to paid features and at what
        tier. Use this before serving any feature — don't parse subscription
        state yourself. Returns `has_access: false` if the customer has no
        subscription.
      operationId: get-customer-entitlements
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          example: cus_01JABC...
      responses:
        '200':
          description: Entitlement status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entitlements'
              example:
                object: entitlements
                subscription_id: sub_01JABC...
                state: active
                has_access: true
                tier: full
                features: []
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Entitlements:
      type: object
      properties:
        object:
          type: string
          enum:
            - entitlements
        subscription_id:
          type: string
          nullable: true
          example: sub_01JABC...
        state:
          type: string
          nullable: true
          enum:
            - active
            - trialing
            - past_due
            - grace
            - delinquent
            - paused
            - canceled
          example: active
        has_access:
          type: boolean
          description: >
            True if the customer should have access to paid features. Active,
            trialing, past_due, and grace all return true.
          example: true
        tier:
          type: string
          enum:
            - full
            - free
          example: full
        features:
          type: array
          items:
            type: string
          example: []
    Error:
      type: object
      properties:
        error:
          type: string
          example: Not found
        code:
          type: string
          example: not_found
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Use `sk_test_` keys for sandbox. Use `sk_live_` keys for production.
        Obtain your key from the dashboard.

````