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

# Get subscription

> Upstream billing-provider IDs are omitted from the API response.



## OpenAPI

````yaml GET /locations/{locationId}/subscription
openapi: 3.1.0
info:
  title: PickupBell API
  version: 1.0.0
  description: >
    Public REST surface for PickupBell — the AI receptionist for HVAC, plumbing,
    and home-services contractors.


    All requests authenticate via `Authorization: Bearer <uuid>`. Every response
    is JSON with shape `{ "data": … }` (or `{ "error": { "code", "message",
    "details" } }` on failure).


    Only endpoints an API token can successfully call are documented here.
    UI-only operations (create location, invite member, mint / revoke API key,
    billing checkout / portal) require a user session and are not part of the
    public API.
  contact:
    email: support@pickupbell.com
servers:
  - url: https://api.pickupbell.com
    description: >-
      Production (vanity domain — Vercel rewrite proxies to
      app.pickupbell.com/api/v1)
  - url: https://app.pickupbell.com/api/v1
    description: App-domain alias (works without the rewrite)
  - url: http://localhost:3000/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Me
  - name: Locations
  - name: Members
  - name: API keys
  - name: Agent
  - name: Business hours
  - name: Call forwarding
  - name: FAQs
  - name: Pricebook
  - name: Calls
  - name: Leads
  - name: Bookings
  - name: Insights
  - name: Notifications
  - name: Integrations
  - name: Webhook endpoints
paths:
  /locations/{locationId}/subscription:
    parameters:
      - $ref: '#/components/parameters/WorkspaceId'
    get:
      tags:
        - Locations
      summary: Subscription + trial state
      description: Upstream billing-provider IDs are omitted from the API response.
      operationId: getSubscription
      responses:
        '200':
          description: Subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Subscription'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    WorkspaceId:
      name: locationId
      in: path
      required: true
      schema:
        type: string
      description: Location UUID or slug (e.g. `premier-hvac`).
  schemas:
    Subscription:
      type: object
      description: Upstream billing-provider IDs are omitted for API callers.
      properties:
        location_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - incomplete
            - trialing
            - active
            - past_due
            - unpaid
            - canceled
            - paused
        stripe_price_id:
          type: string
          nullable: true
        trial_ends_at:
          type: string
          format: date-time
          nullable: true
        current_period_start:
          type: string
          format: date-time
          nullable: true
        current_period_end:
          type: string
          format: date-time
          nullable: true
        cancel_at:
          type: string
          format: date-time
          nullable: true
        canceled_at:
          type: string
          format: date-time
          nullable: true
        billing_email:
          type: string
          format: email
          nullable: true
        invoice_business_name:
          type: string
          nullable: true
        tax_id:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - not_found
                - validation
                - conflict
                - server
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
  responses:
    Unauthorized:
      description: Missing or invalid Bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: uuid
      description: Location-scoped API token from **Settings → API & MCP**.

````