Cavuno Paywall API

openapi: 3.2.0
info:
  title: Cavuno v1 REST Paywall API
  version: 1.0.0
  description: 'The Cavuno API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. ## Base URL


    Production: `https://api.cavuno.com/v1`


    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. ## Authentication


    The Cavuno API uses API keys to authenticate requests. You can view and manage your API keys in the Cavuno dashboard, under Settings → Developer → API keys. Cavuno API keys have the prefix `cavuno_live_`. Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via Bearer auth. Provide your API key as the bearer token in the `Authorization` header:


    ```bash

    curl https://api.cavuno.com/v1/jobs \

    -H "Authorization: Bearer YOUR_SECRET_API_KEY"

    ```


    API requests without authentication will fail. ## Rate limits


    The Cavuno API has rate limits in place to ensure stability and reliability. By default, API keys are limited to 100 requests per minute. If you exceed your limit, requests return an HTTP 429 response with a `Retry-After` header indicating when you can try again. If you have a use case that needs a higher limit, contact support. ## Idempotency


    The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a job fails due to a network connection error, you can safely retry the request with the same idempotency key, and we''ll guarantee that only one job is created. To perform an idempotent request, provide an additional `Idempotency-Key` header on any `POST`, `PATCH`, or `DELETE` request:


    ```bash

    curl https://api.cavuno.com/v1/jobs \

    -X POST \

    -H "Authorization: Bearer cavuno_live_..." \

    -H "Idempotency-Key: $(uuidgen)" \

    -H "Content-Type: application/json" \

    -d ''{ "title": "Senior Engineer" }''

    ```


    ## Errors


    Cavuno uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the `5xx` range indicate an error with Cavuno''s servers (these are rare). Error responses include a JSON body with details:


    ```json

    {

    "error": {

    "code": "validation_bad_request",

    "message": "Field ''title'' is required.",

    "requestId": "req_..."

    }

    }

    ```


    Some errors carry an additional `details` field with structured context, such as per-field validation issues. ### Plan upgrade hints


    When an Operator API request is refused because of the board''s Cavuno plan, the error also carries an `upgrade` object. It names the capability that blocked the request, the cheapest self-serve plan that unlocks it (when that can be told), and the hosted billing endpoints that start the upgrade:


    ```json

    {

    "error": {

    "code": "settings_plan_required_for_branding_removal",

    "message": "Removing Cavuno branding requires a plan that includes branding removal.",

    "requestId": "req_...",

    "upgrade": {

    "capability": "canRemoveBranding",

    "requiredPlan": "basic",

    "checkout": { "method": "POST", "path": "/v1/billing/checkout" },

    "changePlan": { "method": "POST", "path": "/v1/billing/upgrade" }

    }

    }

    }

    ```


    Call `GET /v1/billing/subscription` first. With no active subscription, use `checkout`; with one, use `changePlan`. Send `{ "planKey": "" }` and give the returned `url` to a person: both endpoints return a hosted page where a person confirms the purchase. Nothing is charged until they do. Each `path` is relative to the API origin (`https://api.cavuno.com`), like `Location` headers and list `url` fields, so do not join it to a base URL that already ends in `/v1`.'
  contact:
    name: Cavuno
    url: https://cavuno.com
servers:
- url: https://api.cavuno.com/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Paywall
  description: Candidate-access paywall configuration, offers, and subscription state.
paths:
  /paywall:
    get:
      summary: Get candidate paywall configuration
      description: 'Return the atomic candidate-access paywall: copy, preview window, currency, and all six fixed offer keys. Missing stored offers still produce the stable six-offer resource. Requires `billing.read`. Never exposes Stripe product, price, portal, or customer identifiers.'
      responses:
        '200':
          description: The candidate paywall resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CandidatePaywall'
        default:
          description: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Paywall
      operationId: getCandidatePaywall
    put:
      summary: Replace candidate paywall configuration
      description: Atomically replace the candidate-access paywall (configuration + six offers). Matches the Board monetization form rules. Enabling requires candidate profiles, a ready hosted payment connection, and at least one nonzero enabled offer. Disabling schedules active recurring subscriptions to cancel at period end. Requires `billing.manage` and an `Idempotency-Key` header. Never accepts or returns Stripe identifiers.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCandidatePaywallBody'
      responses:
        '200':
          description: The replaced candidate paywall resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CandidatePaywall'
        default:
          description: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Paywall
      operationId: replaceCandidatePaywall
  /paywall/subscriptions:
    get:
      summary: List candidate paywall subscriptions
      description: Read-only list of candidate access subscriptions (grants) for the Board. Filter by product status and kind (`recurring` | `lifetime`). Requires `billing.read`. Never exposes Stripe customer, subscription, or checkout identifiers. There is no cancel endpoint — the ordinary UI does not provide one.
      parameters:
      - schema:
          type: string
          minLength: 1
        required: false
        name: cursor
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 100
        required: false
        name: limit
        in: query
      - schema:
          type: string
          enum:
          - pending
          - active
          - trialing
          - expired
          - past_due
          - unpaid
          - incomplete
          - incomplete_expired
          - canceled
        required: false
        name: status
        in: query
      - schema:
          type: string
          enum:
          - recurring
          - lifetime
        required: false
        name: kind
        in: query
      responses:
        '200':
          description: Paginated candidate paywall subscriptions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  url:
                    type: string
                    example: /v1/paywall/subscriptions
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                    - string
                    - 'null'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CandidatePaywallSubscription'
                required:
                - object
                - url
                - hasMore
                - nextCursor
                - data
        default:
          description: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Paywall
      operationId: listCandidatePaywallSubscriptions
components:
  schemas:
    CandidatePaywallOffer:
      type: object
      properties:
        key:
          type: string
          enum:
          - daily
          - weekly
          - monthly
          - quarterly
          - yearly
          - lifetime
        kind:
          type: string
          enum:
          - recurring
          - lifetime
        enabled:
          type: boolean
        amountCents:
          type: integer
          minimum: 0
        label:
          type: string
          maxLength: 60
        billingLabel:
          type: string
          maxLength: 60
        isDefault:
          type: boolean
        displayOrder:
          type: integer
          minimum: 0
        intervalUnit:
          type:
          - string
          - 'null'
          enum:
          - day
          - week
          - month
          - year
          - null
        intervalCount:
          type:
          - integer
          - 'null'
          exclusiveMinimum: 0
      required:
      - key
      - kind
      - enabled
      - amountCents
      - label
      - billingLabel
      - isDefault
      - displayOrder
      - intervalUnit
      - intervalCount
    CandidatePaywallSubscription:
      type: object
      properties:
        id:
          type: string
          description: Cavuno candidate access grant ID.
        object:
          type: string
          enum:
          - candidate_paywall_subscription
        candidateId:
          type: string
          description: Board user / Candidate Cavuno ID (boardUsers id).
        email:
          type: string
        displayName:
          type: string
        kind:
          type: string
          enum:
          - recurring
          - lifetime
        offerKey:
          type: string
          enum:
          - daily
          - weekly
          - monthly
          - quarterly
          - yearly
          - lifetime
          description: 'One of: daily, weekly, monthly, quarterly, yearly, lifetime.'
        status:
          type: string
          enum:
          - pending
          - active
          - trialing
          - expired
          - past_due
          - unpaid
          - incomplete
          - incomplete_expired
          - canceled
        amountCents:
          type: integer
          minimum: 0
        currency:
          type: string
          pattern: ^[a-z]{3}$
          description: ISO 4217 currency code, lowercase (e.g. usd).
        currentPeriodStart:
          type:
          - string
          - 'null'
          format: date-time
          description: ISO-8601 or null.
        currentPeriodEnd:
          type:
          - string
          - 'null'
          format: date-time
          description: ISO-8601 or null.
        cancelAtPeriodEnd:
          type: boolean
        activatedAt:
          type:
          - string
          - 'null'
          format: date-time
          description: ISO-8601 or null.
        canceledAt:
          type:
          - string
          - 'null'
          format: date-time
          description: ISO-8601 or null.
        createdAt:
          type: string
          format: date-time
          description: ISO-8601 creation time.
      required:
      - id
      - object
      - candidateId
      - email
      - displayName
      - kind
      - offerKey
      - status
      - amountCents
      - currency
      - currentPeriodStart
      - currentPeriodEnd
      - cancelAtPeriodEnd
      - activatedAt
      - canceledAt
      - createdAt
    PutCandidatePaywallBody:
      type: object
      properties:
        object:
          type: string
          enum:
          - candidate_paywall
        enabled:
          type: boolean
        previewCount:
          type: integer
          minimum: 1
          maximum: 500
        lockHeading:
          type: string
          minLength: 1
          maxLength: 120
        lockDescription:
          type: string
          maxLength: 600
        buttonText:
          type: string
          minLength: 1
          maxLength: 60
        disclaimerText:
          type: string
          maxLength: 200
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: ^[A-Za-z]{3}$
        perMonthLabel:
          type: string
          minLength: 1
          maxLength: 60
        savingsTemplate:
          type: string
          maxLength: 120
        offers:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                enum:
                - daily
                - weekly
                - monthly
                - quarterly
                - yearly
                - lifetime
              enabled:
                type: boolean
              amountCents:
                type: integer
                minimum: 0
              isDefault:
                type: boolean
              label:
                type: string
                maxLength: 60
              billingLabel:
                type: string
                maxLength: 60
              kind:
                type: string
                enum:
                - recurring
                - lifetime
              displayOrder:
                type: integer
                minimum: 0
              intervalUnit:
                type:
                - string
                - 'null'
                enum:
                - day
                - week
                - month
                - year
                - null
              intervalCount:
                type:
                - integer
                - 'null'
                exclusiveMinimum: 0
            required:
            - key
            - enabled
            - amountCents
            - isDefault
      required:
      - enabled
      - previewCount
      - lockHeading
      - lockDescription
      - buttonText
      - disclaimerText
      - currency
      - perMonthLabel
      - savingsTemplate
      - offers
      additionalProperties: false
    CandidatePaywall:
      type: object
      properties:
        object:
          type: string
          enum:
          - candidate_paywall
        enabled:
          type: boolean
        previewCount:
          type: integer
          minimum: 1
          maximum: 500
        lockHeading:
          type: string
          minLength: 1
          maxLength: 120
        lockDescription:
          type: string
          maxLength: 600
        buttonText:
          type: string
          minLength: 1
          maxLength: 60
        disclaimerText:
          type: string
          maxLength: 200
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: ^[a-z]{3}$
          description: ISO 4217 currency code, lowercase (e.g. usd).
        perMonthLabel:
          type: string
          minLength: 1
          maxLength: 60
        savingsTemplate:
          type: string
          maxLength: 120
        offers:
          type: array
          items:
            $ref: '#/components/schemas/CandidatePaywallOffer'
      required:
      - object
      - enabled
      - previewCount
      - lockHeading
      - lockDescription
      - buttonText
      - disclaimerText
      - currency
      - perMonthLabel
      - savingsTemplate
      - offers
    PlanUpgradeHint:
      type: object
      properties:
        capability:
          type: string
          enum:
          - activeJobsLimit
          - teamSeatLimit
          - canBePublic
          - canRemoveBranding
          - apiAccess
          description: The plan capability that blocked the request, named as in `GET /v1/billing/subscription` `capabilities`.
        requiredPlan:
          type: string
          enum:
          - starter
          - basic
          - grow
          - advanced
          - scale
          description: The cheapest self-serve plan that unlocks the action. Pass it as `planKey`. Omitted when it cannot be told without more information; read `GET /v1/billing/subscription` and pick a higher plan.
        checkout:
          type: object
          properties:
            method:
              type: string
              enum:
              - POST
            path:
              type: string
              enum:
              - /v1/billing/checkout
          required:
          - method
          - path
          description: Starts a hosted checkout when the board has no active subscription (for example during a trial).
        changePlan:
          type: object
          properties:
            method:
              type: string
              enum:
              - POST
            path:
              type: string
              enum:
              - /v1/billing/upgrade
          required:
          - method
          - path
          description: Starts a hosted plan change when the board already has an active subscription.
      required:
      - capability
      - checkout
      - changePlan
      description: 'Present only on Operator API errors caused by the board''s Cavuno plan. Read `GET /v1/billing/subscription` to choose between `checkout` and `changePlan`, call it with `{ "planKey": requiredPlan }`, and give the returned `url` to a person to confirm. Each `path` is relative to the API origin, not to a `/v1` base URL. Both endpoints need `billing.manage`. Board API errors never include it.'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code, such as `validation_bad_request` or `jobs_not_found`.
            message:
              type: string
              description: Human-readable explanation.
            requestId:
              type: string
              description: Unique id for this request. Include it when contacting support.
            details:
              description: Structured context for some errors, such as per-field validation issues.
            upgrade:
              $ref: '#/components/schemas/PlanUpgradeHint'
          required:
          - code
          - message
          - requestId
      required:
      - error
      description: The error envelope returned by every non-2xx response.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cavuno_live_<keyId>_<secret>
      description: Use your secret API key to authenticate. Pass it as a Bearer token in the `Authorization` header. You can view and manage your API keys in the Cavuno dashboard.
externalDocs:
  description: Cavuno API reference
  url: https://cavuno.com/docs/api