invoicepdfs-com Billing API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Billing API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged billing across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Billing
paths:
  /api/v1/billing/subscription:
    get:
      tags:
      - Billing
      summary: Get Subscription
      description: Get current subscription status (from DB, no Stripe API call).
      operationId: get_subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingSubscriptionResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/billing/plans:
    get:
      tags:
      - Billing
      summary: List Plans
      description: Purchasable plans — the ones wired to a Stripe price.
      operationId: list_plans
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingPlansListResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/billing/overage:
    patch:
      tags:
      - Billing
      summary: Update Overage Settings
      description: 'Turn overage billing on or off for this account.


        Off by default and stays off until asked: past the quota the API returns

        429, which is a limit the customer can see coming. Overage replaces that

        limit with a charge, and nobody should meet that decision on an invoice.'
      operationId: update_overage_settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingOverageRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingOverageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/billing/checkout-session:
    post:
      tags:
      - Billing
      summary: Create Checkout Session
      description: Create a Stripe Checkout session for a subscription.
      operationId: create_checkout_session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingCheckoutRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingCheckoutResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/billing/portal-session:
    post:
      tags:
      - Billing
      summary: Create Portal Session
      description: Create a Stripe Customer Portal session for self-service management.
      operationId: create_portal_session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingPortalResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
components:
  schemas:
    BillingPortalResponse:
      properties:
        data:
          $ref: '#/components/schemas/BillingPortalData'
      type: object
      required:
      - data
      title: BillingPortalResponse
    BillingCheckoutRequest:
      properties:
        price_id:
          type: string
          title: Price Id
          description: Stripe price ID for the plan
      type: object
      required:
      - price_id
      title: BillingCheckoutRequest
    BillingPortalData:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: BillingPortalData
    BillingCheckoutResponse:
      properties:
        data:
          $ref: '#/components/schemas/BillingCheckoutData'
      type: object
      required:
      - data
      title: BillingCheckoutResponse
    BillingOverageRequest:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Whether renders past the monthly quota should be billed
      type: object
      required:
      - enabled
      title: BillingOverageRequest
    BillingOverageData:
      properties:
        overage_enabled:
          type: boolean
          title: Overage Enabled
        overage_available:
          type: boolean
          title: Overage Available
        overage_price_millicents:
          anyOf:
          - type: integer
          - type: 'null'
          title: Overage Price Millicents
      type: object
      required:
      - overage_enabled
      - overage_available
      title: BillingOverageData
    BillingPlansListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/BillingPlan'
          type: array
          title: Data
      type: object
      required:
      - data
      title: BillingPlansListResponse
    BillingSubscriptionData:
      properties:
        subscription_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Subscription Id
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        plan_id:
          type: string
          title: Plan Id
        plan_name:
          type: string
          title: Plan Name
        stripe_configured:
          type: boolean
          title: Stripe Configured
          default: false
        has_billing_account:
          type: boolean
          title: Has Billing Account
          default: false
        overage_enabled:
          type: boolean
          title: Overage Enabled
          default: false
        overage_available:
          type: boolean
          title: Overage Available
          default: false
        overage_price_millicents:
          anyOf:
          - type: integer
          - type: 'null'
          title: Overage Price Millicents
        allow_branding_removal:
          type: boolean
          title: Allow Branding Removal
          default: false
      type: object
      required:
      - plan_id
      - plan_name
      title: BillingSubscriptionData
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    BillingOverageResponse:
      properties:
        data:
          $ref: '#/components/schemas/BillingOverageData'
      type: object
      required:
      - data
      title: BillingOverageResponse
    BillingPlan:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        price_id:
          type: string
          title: Price Id
        price_id_annual:
          anyOf:
          - type: string
          - type: 'null'
          title: Price Id Annual
        price_cents:
          anyOf:
          - type: integer
          - type: 'null'
          title: Price Cents
        price_cents_annual:
          anyOf:
          - type: integer
          - type: 'null'
          title: Price Cents Annual
        monthly_render_quota:
          type: integer
          title: Monthly Render Quota
        allow_branding_removal:
          type: boolean
          title: Allow Branding Removal
          default: false
        overage_price_millicents:
          anyOf:
          - type: integer
          - type: 'null'
          title: Overage Price Millicents
      type: object
      required:
      - id
      - name
      - price_id
      - monthly_render_quota
      title: BillingPlan
    BillingSubscriptionResponse:
      properties:
        data:
          $ref: '#/components/schemas/BillingSubscriptionData'
      type: object
      required:
      - data
      title: BillingSubscriptionResponse
    BillingCheckoutData:
      properties:
        session_id:
          type: string
          title: Session Id
        url:
          type: string
          title: Url
      type: object
      required:
      - session_id
      - url
      title: BillingCheckoutData
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs