Kushki Subscriptions API

openapi: 3.1.0
info:
  title: Kushki Card Payments Branches Subscriptions API
  description: 'Card-not-present REST API for the Kushki regional non-banking acquirer.

    Card numbers are tokenized client-side by Kushki.js Hosted Fields or the

    iOS / Android SDKs and the resulting `transactionToken` is exchanged

    server-side for a charge, pre-authorization, capture, or void.

    '
  version: 1.0.0
  contact:
    name: Kushki
    url: https://kushkipagos.com/
    email: dev@kushkipagos.com
  license:
    name: Kushki API Terms
    url: https://kushkipagos.com/legal
servers:
- url: https://api.kushkipagos.com
  description: Production
- url: https://api-uat.kushkipagos.com
  description: UAT / Sandbox
- url: https://api-stg.kushkipagos.com
  description: Staging
security:
- PublicMerchantId: []
- PrivateMerchantId: []
tags:
- name: Subscriptions
  description: Recurring card subscriptions
paths:
  /subscriptions/v1/card:
    post:
      summary: Kushki Create Subscription
      description: Create a scheduled card subscription. Returns a subscription identifier used for subsequent updates and on-demand charges.
      operationId: createSubscription
      tags:
      - Subscriptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
            example:
              token: 0aabF1aae450476cb7547bda5bdfc11d
              planName: Pro Monthly
              amount:
                subtotalIva: 0
                subtotalIva0: 2990
                ice: 0
                iva: 0
                currency: USD
              startDate: '2026-06-01'
              periodicity: monthly
              contactDetails:
                firstName: Juan
                lastName: Perez
                email: juan@example.com
                phoneNumber: '+593999999999'
      responses:
        '200':
          description: Subscription created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        4XX:
          $ref: '#/components/responses/ErrorResponse'
  /subscriptions/v1/card/{subscriptionId}:
    get:
      summary: Kushki Retrieve Subscription
      description: Retrieve the current state of a subscription.
      operationId: getSubscription
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: Subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
    put:
      summary: Kushki Update Subscription
      description: Update plan name, amount, periodicity, or contact details on an existing subscription.
      operationId: updateSubscription
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionUpdateRequest'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
    delete:
      summary: Kushki Cancel Subscription
      description: Cancel an active subscription. No further scheduled charges will be initiated.
      operationId: cancelSubscription
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: Cancelled
  /subscriptions/v1/card/{subscriptionId}/charge:
    post:
      summary: Kushki Charge Subscription On Demand
      description: Trigger an on-demand charge against the card stored on the subscription (one-click flow).
      operationId: chargeSubscription
      tags:
      - Subscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionChargeRequest'
      responses:
        '200':
          description: Charge approved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionChargeResponse'
components:
  schemas:
    ContactDetails:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        phoneNumber:
          type: string
        documentType:
          type: string
        documentNumber:
          type: string
    Amount:
      type: object
      required:
      - subtotalIva
      - subtotalIva0
      - iva
      - currency
      properties:
        subtotalIva:
          type: number
        subtotalIva0:
          type: number
        ice:
          type: number
          default: 0
        iva:
          type: number
        currency:
          type: string
          enum:
          - USD
          - COP
          - PEN
          - CLP
          - MXN
          - BRL
    SubscriptionRequest:
      type: object
      required:
      - token
      - planName
      - amount
      - startDate
      - periodicity
      - contactDetails
      properties:
        token:
          type: string
        planName:
          type: string
        amount:
          $ref: '#/components/schemas/Amount'
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        periodicity:
          type: string
          enum:
          - daily
          - weekly
          - biweekly
          - monthly
          - bimonthly
          - quarterly
          - halfYearly
          - yearly
          - custom
        contactDetails:
          $ref: '#/components/schemas/ContactDetails'
        metadata:
          type: object
          additionalProperties: true
    SubscriptionChargeResponse:
      type: object
      properties:
        ticketNumber:
          type: string
        transactionReference:
          type: string
        approvedTransactionAmount:
          type: number
        currencyCode:
          type: string
        responseText:
          type: string
    SubscriptionChargeRequest:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        metadata:
          type: object
          additionalProperties: true
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    SubscriptionResponse:
      type: object
      properties:
        subscriptionId:
          type: string
        planName:
          type: string
        amount:
          $ref: '#/components/schemas/Amount'
        periodicity:
          type: string
        startDate:
          type: string
          format: date
        status:
          type: string
          enum:
          - active
          - pending
          - cancelled
          - expired
          - suspended
        contactDetails:
          $ref: '#/components/schemas/ContactDetails'
    SubscriptionUpdateRequest:
      type: object
      properties:
        planName:
          type: string
        amount:
          $ref: '#/components/schemas/Amount'
        periodicity:
          type: string
        contactDetails:
          $ref: '#/components/schemas/ContactDetails'
  responses:
    ErrorResponse:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    SubscriptionId:
      name: subscriptionId
      in: path
      required: true
      schema:
        type: string
      description: Kushki subscription identifier.
  securitySchemes:
    PublicMerchantId:
      type: apiKey
      in: header
      name: Public-Merchant-Id
      description: Client-side merchant key. Used by Kushki.js and mobile SDKs to tokenize cards. Never use server-side for charging.
    PrivateMerchantId:
      type: apiKey
      in: header
      name: Private-Merchant-Id
      description: Server-side merchant key. Required for charge, capture, void, refund, subscription, and payout calls.