Postiz

Postiz Billing API

The Billing API from Postiz — 20 operation(s) for billing.

GitHub OpenAPI
Business capability
Subscription Billing & Revenue Management BC-4250

Operations 20

GET /billing/check/{id} Billing controller check id #
GET /billing/check-discount Billing controller check discount #
POST /billing/apply-discount Billing controller apply discount #
POST /billing/finish-trial Billing controller finish trial #
GET /billing/is-trial-finished Billing controller is trial finished #
POST /billing/embedded Billing controller embedded #
POST /billing/subscribe Billing controller subscribe #
GET /billing/portal Billing controller modify payment #
GET /billing Billing controller get current billing #
POST /billing/cancel Billing controller cancel #
POST /billing/prorate Billing controller prorate #
GET /billing/charges Billing controller get charges #
POST /billing/refund-charges Billing controller refund charges #
POST /billing/cancel-subscription Billing controller cancel subscription #
GET /billing/coupon-info Billing controller coupon info #
POST /billing/apply-coupon Billing controller apply coupon #
POST /billing/cancel-coupon Billing controller cancel coupon #
GET /billing/chatbase-refund/preview Billing controller chatbase refund preview #
POST /billing/chatbase-refund Billing controller chatbase refund #
POST /billing/add-subscription Billing controller add subscription #

Documentation

📖
Documentation
https://docs.postiz.com/public-api
📖
APIReference
https://docs.postiz.com/public-api/introduction
📖
Documentation
https://api.postiz.com/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postiz/refs/heads/main/openapi/postiz-billing-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postiz-billing-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postiz-billing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postiz Swagger file Billing API
  description: API description
  version: '1.0'
  contact: {}
servers: []
tags:
- name: Billing
paths:
  /billing/check/{id}:
    get:
      operationId: BillingController_checkId
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller check id
      x-summary-source: derived
  /billing/check-discount:
    get:
      operationId: BillingController_checkDiscount
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller check discount
      x-summary-source: derived
  /billing/apply-discount:
    post:
      operationId: BillingController_applyDiscount
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller apply discount
      x-summary-source: derived
  /billing/finish-trial:
    post:
      operationId: BillingController_finishTrial
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller finish trial
      x-summary-source: derived
  /billing/is-trial-finished:
    get:
      operationId: BillingController_isTrialFinished
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller is trial finished
      x-summary-source: derived
  /billing/embedded:
    post:
      operationId: BillingController_embedded
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingSubscribeDto'
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller embedded
      x-summary-source: derived
  /billing/subscribe:
    post:
      operationId: BillingController_subscribe
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingSubscribeDto'
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller subscribe
      x-summary-source: derived
  /billing/portal:
    get:
      operationId: BillingController_modifyPayment
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller modify payment
      x-summary-source: derived
  /billing:
    get:
      operationId: BillingController_getCurrentBilling
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller get current billing
      x-summary-source: derived
  /billing/cancel:
    post:
      operationId: BillingController_cancel
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller cancel
      x-summary-source: derived
  /billing/prorate:
    post:
      operationId: BillingController_prorate
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingSubscribeDto'
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller prorate
      x-summary-source: derived
  /billing/charges:
    get:
      operationId: BillingController_getCharges
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller get charges
      x-summary-source: derived
  /billing/refund-charges:
    post:
      operationId: BillingController_refundCharges
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller refund charges
      x-summary-source: derived
  /billing/cancel-subscription:
    post:
      operationId: BillingController_cancelSubscription
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller cancel subscription
      x-summary-source: derived
  /billing/coupon-info:
    get:
      operationId: BillingController_couponInfo
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller coupon info
      x-summary-source: derived
  /billing/apply-coupon:
    post:
      operationId: BillingController_applyCoupon
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminApplyCouponDto'
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller apply coupon
      x-summary-source: derived
  /billing/cancel-coupon:
    post:
      operationId: BillingController_cancelCoupon
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller cancel coupon
      x-summary-source: derived
  /billing/chatbase-refund/preview:
    get:
      operationId: BillingController_chatbaseRefundPreview
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Billing
      summary: Billing controller chatbase refund preview
      x-summary-source: derived
  /billing/chatbase-refund:
    post:
      operationId: BillingController_chatbaseRefund
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller chatbase refund
      x-summary-source: derived
  /billing/add-subscription:
    post:
      operationId: BillingController_addSubscription
      parameters: []
      responses:
        '201':
          description: ''
      tags:
      - Billing
      summary: Billing controller add subscription
      x-summary-source: derived
components:
  schemas:
    BillingSubscribeDto:
      type: object
      properties: {}
    AdminApplyCouponDto:
      type: object
      properties: {}