Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kushki Subscriptions API

Create, update, retrieve, charge, and cancel scheduled card subscriptions and one-click recurring payments. Plans support monthly, weekly, daily, biweekly, quarterly, and yearly periodicity, fixed or variable amounts, start/end dates, contact details, and Webpay OneClick on the Chile rail.

Kushki Subscriptions API is one of 12 APIs that Kushki publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Subscriptions, Recurring Payments, Payments, and One Click. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 5 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api.kushkipagos.com, https://api-uat.kushkipagos.com, https://api-stg.kushkipagos.com.

5 operations 3 paths 8 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kushkipagos.com
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Kushki Subscriptions API declares 2 security schemes for authenticating requests. An API key is passed in the header as Public-Merchant-Id (PublicMerchantId). An API key is passed in the header as Private-Merchant-Id (PrivateMerchantId). By default, every request must be authenticated.

  • PublicMerchantId — Client-side merchant key. Used by Kushki.js and mobile SDKs to tokenize cards. Never use server-side for charging.
  • PrivateMerchantId — Server-side merchant key. Required for charge, capture, void, refund, subscription, and payout calls.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 5

Recurring card subscriptions

POST
/subscriptions/v1/card
Kushki Create Subscription
createSubscription body → 2004XX
GET
/subscriptions/v1/card/{subscriptionId}
Kushki Retrieve Subscription
getSubscription 1 param → 200
PUT
/subscriptions/v1/card/{subscriptionId}
Kushki Update Subscription
updateSubscription 1 param body → 200
DELETE
/subscriptions/v1/card/{subscriptionId}
Kushki Cancel Subscription
cancelSubscription 1 param → 200
POST
/subscriptions/v1/card/{subscriptionId}/charge
Kushki Charge Subscription On Demand
chargeSubscription 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SubscriptionRequest (8 properties), SubscriptionResponse (7 properties), ContactDetails (6 properties), Amount (5 properties). Each schema is shown below with its type and property counts.

ContactDetails
object
6 properties
Amount
object
5 properties 4 required
SubscriptionRequest
object
8 properties 6 required
SubscriptionChargeResponse
object
5 properties
SubscriptionChargeRequest
object
2 properties
Error
object
2 properties
SubscriptionResponse
object
7 properties
SubscriptionUpdateRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kushki-subscriptions-api-openapi.yml Raw ↑

Other APIs Kushki publishes across the network.

Kushki Payouts API
Kushki Webhooks
Kushki Branches API
Kushki Card Present Charges API
Kushki Cash API
Kushki Charges API
Kushki Pre-Authorization API
Kushki Terminals API
Kushki Tokens API
Kushki Transfer API
Kushki Voids and Refunds API