Converly Subscription API

The Subscription API from Converly — 2 operation(s) for subscription.

GitHub OpenAPI

Operations 4

GET /subscription Get subscription #
POST /subscription Create subscription #
PATCH /subscription Update subscription #
POST /subscription/cancel Create subscription cancel #

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/converly-io:converly-io-subscription-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.

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

OpenAPI Specification

converly-io-subscription-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Converly Io Subscription API
  version: 1.0.0
  description: 'Operations tagged Subscription across 2 of this provider''s published API definitions: converly-io-openapi.json, converly-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.converly.io/api/v1
tags:
- name: Subscription
paths:
  /subscription:
    get:
      description: Get the account's subscription. Returns 404 when there is no subscription (not an error — treat as 'unsubscribed').
      security:
      - BearerAuth: []
      responses:
        '200':
          description: The subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '404':
          description: No subscription on this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      tags:
      - Subscription
      summary: Get subscription
      x-summary-source: derived
      operationId: getSubscription
      x-operation-id-source: derived
    post:
      description: Create a subscription. Payment method MUST already be attached to the account's Stripe customer — use /billing/setup-intents to collect one via Stripe Elements first. Fresh subs start in 'trialing' for 14 days. 400 `subscription_exists` if one already exists — use PATCH to change plan.
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionBody'
      responses:
        '201':
          description: The new subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '400':
          description: invalid_plan | subscription_exists | no_stripe_customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: stripe_error — raw Stripe message in `message`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      tags:
      - Subscription
      summary: Create subscription
      x-summary-source: derived
      operationId: postSubscription
      x-operation-id-source: derived
    patch:
      description: Change plan in-place. Stripe handles proration automatically.
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSubscriptionBody'
      responses:
        '200':
          description: The updated subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '400':
          description: invalid_plan | no_active_subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: stripe_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      tags:
      - Subscription
      summary: Update subscription
      x-summary-source: derived
      operationId: patchSubscription
      x-operation-id-source: derived
    servers:
    - url: https://app.converly.io/api/v1
  /subscription/cancel:
    post:
      description: Cancel subscription IMMEDIATELY (not grace-period). User loses access on response. Body is optional — reason/details stored for internal analysis.
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSubscriptionBody'
      responses:
        '200':
          description: The cancelled subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '400':
          description: no_active_subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: stripe_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      tags:
      - Subscription
      summary: Create subscription cancel
      x-summary-source: derived
      operationId: postSubscriptionCancel
      x-operation-id-source: derived
    servers:
    - url: https://app.converly.io/api/v1
components:
  schemas:
    CreateSubscriptionBody:
      type: object
      properties:
        plan_id:
          type: string
          minLength: 1
          maxLength: 50
        payment_method_id:
          type: string
          minLength: 1
          maxLength: 255
          description: Stripe PaymentMethod id. MUST be already attached to the account's Stripe customer. See /v1/billing/setup-intents for the attach flow.
      required:
      - plan_id
      - payment_method_id
    Subscription:
      type: object
      properties:
        id:
          type: string
          description: Stripe-shaped id, prefixed `sub_`
        plan_id:
          type: string
        plan_name:
          type: string
        price:
          type: number
          description: Cents USD
        status:
          type: string
          enum:
          - trialing
          - active
          - past_due
          - canceled
          - trial_expired
          description: 'Normalized Converly subscription status (NOT raw Stripe passthrough). Stripe statuses are mapped on sync: unpaid / incomplete_expired → canceled; incomplete / paused → no state change. `trial_expired` is Converly-internal — set by the cardless-trial expiry cron when a cardless trial lapses without a card. Mutations (publish/create flow, test-event) are gated to `trialing`/`active`; any other status returns 402 entitlement_required.'
        cancel_at_period_end:
          type: boolean
          description: Always false in practice — /v1 does immediate cancel.
        trial_ends_at:
          type:
          - string
          - 'null'
          format: date-time
        trial_type:
          type:
          - string
          - 'null'
          enum:
          - cardless
          - carded
          - null
          description: '`cardless` | `carded` | null. Cardless trials (plugin install-prep, or `/v1/signup` with start_cardless_trial) have NO Stripe subscription and expire via cron — plugin/extension surfaces should show an ''Add card'' prompt during the trial and lock the UI once status is `trial_expired`. `carded` trials are Stripe-managed (no banner). null = legacy pre-column rows (treat as carded).'
        current_period_end:
          type:
          - string
          - 'null'
          format: date-time
        flows_limit:
          type: number
        conversions_limit:
          type: number
        flows_unlimited:
          type: boolean
          description: True when flows_limit is unlimited (mirrors -1) — read this rather than interpreting -1.
        conversions_unlimited:
          type: boolean
          description: True when conversions_limit is unlimited (mirrors -1).
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - id
      - plan_id
      - plan_name
      - price
      - status
      - cancel_at_period_end
      - trial_ends_at
      - trial_type
      - current_period_end
      - flows_limit
      - conversions_limit
      - flows_unlimited
      - conversions_unlimited
      - created_at
      - updated_at
    ChangeSubscriptionBody:
      type: object
      properties:
        plan_id:
          type: string
          minLength: 1
          maxLength: 50
      required:
      - plan_id
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - invalid_request_error
              - authentication_error
              - permission_error
              - not_found_error
              - rate_limit_error
              - delivery_service_error
              - internal_error
              - idempotency_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
          required:
          - type
          - code
          - message
      required:
      - error
    CancelSubscriptionBody:
      type: object
      properties:
        reason:
          type: string
          maxLength: 50
        details:
          type: string
          maxLength: 2000
      description: Body is optional. Reason/details stored for internal analysis only.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_live_...
    InternalBearer:
      type: http
      scheme: bearer
      bearerFormat: JOBS_SECRET
      description: Shared internal secret. This is NOT an sk_live_* API key. Used by /v1/signup and internal job endpoints.
x-refined-from:
- converly-io-openapi.json
- converly-io-openapi.yml