Pinch

Pinch Subscriptions API

The Subscriptions API from Pinch — 3 operation(s) for subscriptions.

GitHub OpenAPI

Operations 4

GET /subscriptions List subscriptions (paged) #
POST /subscriptions Create a subscription #
GET /subscriptions/payer/{payerid} List subscriptions for a payer #
GET /subscriptions/plan/{planid} List subscriptions for a plan (paged) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/pinch/openapi/pinch-subscriptions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/pinch/json-schema/pinch-post-subscriptions-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/pinch/json-schema/pinch-post-calculate-fees-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/pinch/json-schema/pinch-post-refunds-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/pinch/json-schema/pinch-post-merchants-merchantid-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/pinch/json-schema/pinch-post-plans-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/pinch/json-schema/pinch-post-refunds-response-schema.json

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/pinch:pinch-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

pinch-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pinch Subscriptions API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 41 operation(s) read from 30 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Pinch has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 27
    documentation: 14
    pages-with-code: 22
    pages-read: 30
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.getpinch.com.au/reference/tokens.md
  - https://docs.getpinch.com.au/reference/tokenise.md
  - https://docs.getpinch.com.au/reference/save-payer.md
  - https://docs.getpinch.com.au/reference/get-payment.md
  - https://docs.getpinch.com.au/reference/list-payers.md
  - https://docs.getpinch.com.au/reference/delete-payer.md
  - https://docs.getpinch.com.au/reference/save-payment.md
  - https://docs.getpinch.com.au/reference/realtime-payment.md
  - https://docs.getpinch.com.au/reference/delete-payment-source.md
  - https://docs.getpinch.com.au/reference/list-payments-for-payer.md
  - https://docs.getpinch.com.au/reference/list-processed-payments.md
  - https://docs.getpinch.com.au/reference/list-scheduled-payments.md
  - https://docs.getpinch.com.au/docs/application-authentication
  - https://docs.getpinch.com.au/docs/credit-card-payments
  - https://docs.getpinch.com.au/docs/direct-debit-payments
  - https://docs.getpinch.com.au/docs/capturejs-tokenisation
  - https://docs.getpinch.com.au/docs/plans-and-subscriptions
  - https://docs.getpinch.com.au/docs/payment-links
  - https://docs.getpinch.com.au/docs/transfers-in-pinch-payments
  - https://docs.getpinch.com.au/docs/refunds
  - https://docs.getpinch.com.au/docs/metadata
  - https://docs.getpinch.com.au/docs/surcharging-fees-in-pinch
  - https://docs.getpinch.com.au/docs/managed-merchants
  - https://docs.getpinch.com.au/docs/managed-merchants-payments-guide
  - https://docs.getpinch.com.au/docs/xero-invoice-automation
  - https://docs.getpinch.com.au/docs/preview-fees-before-charging
  - https://docs.getpinch.com.au/docs/vault-payment-source
  - https://docs.getpinch.com.au/docs/handle-dishonoured-direct-debit
  - https://docs.getpinch.com.au/docs/full-subscription-lifecycle
  - https://docs.getpinch.com.au/docs/managed-merchant-onboarding
servers:
- url: https://api.getpinch.com.au
security:
- apiKey: []
tags:
- name: Subscriptions
paths:
  /subscriptions:
    get:
      operationId: get_subscriptions
      tags:
      - Subscriptions
      summary: List subscriptions (paged)
      x-source: https://docs.getpinch.com.au/docs/plans-and-subscriptions
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: Page number
      - name: pageSize
        in: query
        required: false
        schema:
          type: string
        description: Number of items per page
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_subscriptions
      tags:
      - Subscriptions
      summary: Create a subscription
      x-source: https://docs.getpinch.com.au/docs/plans-and-subscriptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSubscriptionsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSubscriptionsResponse'
      x-evidence:
        kind: documentation
  /subscriptions/payer/{payerid}:
    get:
      operationId: get_subscriptions_payer_payerid
      tags:
      - Subscriptions
      summary: List subscriptions for a payer
      x-source: https://docs.getpinch.com.au/docs/plans-and-subscriptions
      parameters:
      - name: payerid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionsPayerPayeridResponse'
      x-evidence:
        kind: documentation
  /subscriptions/plan/{planid}:
    get:
      operationId: get_subscriptions_plan_planid
      tags:
      - Subscriptions
      summary: List subscriptions for a plan (paged)
      x-source: https://docs.getpinch.com.au/docs/plans-and-subscriptions
      parameters:
      - name: planid
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: Page number
      - name: pageSize
        in: query
        required: false
        schema:
          type: string
        description: Number of items per page
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSubscriptionsPlanPlanidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetSubscriptionsPlanPlanidResponse:
      type: object
      properties:
        subscriptions:
          type: array
          description: Subscriptions attached to the plan
    PostSubscriptionsRequest:
      type: object
      properties:
        planId:
          type: string
          description: Identifier of the plan to subscribe to
        payerId:
          type: string
          description: Identifier of the payer (customer)
        totalAmount:
          type: string
          description: Total amount in cents when required by the plan
        startDate:
          type: string
          description: Start date of the subscription
        currency:
          type: string
          description: Currency code
        sourceId:
          type: string
          description: Payment source identifier
      required:
      - planId
      - payerId
    GetSubscriptionsResponse:
      type: object
      properties:
        subscriptions:
          type: array
          description: Paginated list of subscriptions
    PostSubscriptionsResponse:
      type: object
      properties:
        subscription:
          type: object
          description: Created subscription instance
    GetSubscriptionsPayerPayeridResponse:
      type: object
      properties:
        subscriptions:
          type: array
          description: Subscriptions belonging to the payer
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization