adrianhomelab-com Billing API

openapi: 3.2.0
info:
  title: Leadgen API — Romanian business registry (ONRC) Billing API
  description: '**Send your key as the `X-API-Key` header.** Anonymous callers get 5 lookups a day; a free key (50/day) takes ten seconds at /start. Read-only JSON over Romania''s official ONRC registry: 4.2M companies, CAEN activities, legal representatives, statuses and financial statements. Search is diacritic-insensitive.'
  version: 2.0.2
tags:
- name: Billing
paths:
  /api/subscribe:
    post:
      tags:
      - Billing
      summary: Subscribe
      description: 'Start a Pro or Business subscription (`plan`: pro|business, `interval`:

        month|year). The buyer is the holder of the key in `X-API-Key`, the key named

        by a signed `upgrade_token` (the `upgrade` link of a refusal), or an `email`:

        a new address gets a free key when the payment succeeds; an address that

        already has a key gets a confirmation link by email instead (202,

        `kind: confirm_sent`). `buyer_type` company needs `cui`: a Romanian CUI

        (name and address are prefilled from the registry, 422 `company_not_found`, and not struck off, 422

        `company_closed`, checked before any Stripe call), or a company outside

        Romania gives its VAT number with the country prefix (`DE123456789`; not

        looked up: it goes on the Stripe customer and the invoice, Stripe''s page asks only the

        billing address). `consent` must carry `terms` true, plus

        `immediate_start` true for a person or `business_purchase` true for a company.

        Answers `{kind, url}`: `checkout` (Stripe''s payment page) or

        `portal_update` (the key already subscribes: change plan in the portal).

        403 `checkout_closed` while paid plans are not on sale.'
      operationId: subscribe_api_subscribe_post
      parameters:
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscribeRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/billing/intent:
    get:
      tags:
      - Billing
      summary: Billing Intent
      description: 'What a signed upgrade link names, for the checkout page: the key''s

        prefix, its plan now, the plan offered and the address (masked).'
      operationId: billing_intent_api_billing_intent_get
      parameters:
      - name: u
        in: query
        required: true
        schema:
          type: string
          maxLength: 2048
          title: U
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/billing/company/{cui:
    get:
      tags:
      - Billing
      summary: Billing Company
      description: 'A company''s invoice details from our own registry (name, address, VAT

        status) to prefill the checkout, and whether it may subscribe

        (`can_subscribe`: false for a firm struck off, `risk_level` closed). Not a

        lookup: never counted, limited per IP, and only while paid plans are on

        sale. 404 `unknown_cui`: not a firm in our (Romanian) register.'
      operationId: billing_company_api_billing_company__cui__get
      parameters:
      - name: cui
        in: path
        required: true
        schema:
          type: string
          maxLength: 16
          title: Cui
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/billing/portal:
    post:
      tags:
      - Billing
      summary: Billing Portal
      description: 'Open the Stripe Customer Portal for the subscription of the key in

        `X-API-Key`: cancel (at period end), switch plan or interval, change the

        card, billing details, invoices. Answers `{url}` (valid a few minutes).

        Open whether or not paid plans are on sale; while they are not, the portal

        cannot switch plan or interval (its sales-closed configuration), and if

        that configuration is missing the answer is 503 `portal_unavailable`.'
      operationId: billing_portal_api_billing_portal_post
      parameters:
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/PortalRequest'
              - type: 'null'
              title: Req
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/billing/portal-link:
    post:
      tags:
      - Billing
      summary: Billing Portal Link
      description: 'Email a one-time link to the subscription portal to an address that

        has a subscription. The answer is the same whether or not it has one.

        Open whether or not paid plans are on sale (a subscriber can always reach

        the portal).'
      operationId: billing_portal_link_api_billing_portal_link_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortalLinkRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/fx/eur-ron:
    get:
      tags:
      - Billing
      summary: Fx Eur Ron
      description: 'The euro in lei at the BNR reference rate and its date, for showing RON

        next to EUR prices (F100); the charge is always in EUR. `rate` and `date`

        are null when no rate is known yet: show EUR only.'
      operationId: fx_eur_ron_api_fx_eur_ron_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    PortalLinkRequest:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    SubscribeRequest:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
    PortalRequest:
      type: object
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true