Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.khaime.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Subscriptions

Khaime handles the full subscription lifecycle: creation, billing, renewals, dunning, and cancellation.

​
Creating a Subscription

Add subscription_frequency_key to your charge or session request: 
curl -X POST https://api.khaime.com/api/v1/partner/payments/charge \
  -H "X-API-Key: pk_sandbox_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 4999,
    "currency": "USD",
    "subscription_frequency_key": "monthly",
    "customer": {
      "email": "subscriber@example.com",
      "country": "US"
    }
  }'

​
Frequencies

KeyBilling Cycle
dailyEvery day
weeklyEvery 7 days
biweeklyEvery 14 days
monthlyEvery month
3_monthsEvery 3 months
6_monthsEvery 6 months
yearlyEvery year

​
Managing Subscriptions

​
List subscriptions

GET /subscriptions?status=active&limit=20

​
Get details

GET /subscriptions/{subscription_id}

​
Cancel

PATCH /subscriptions/{subscription_id}/cancel

​
Webhook Events

  • subscription.created — First payment succeeded, subscription active
  • subscription.renewed — Recurring payment succeeded
  • subscription.cancelled — Subscription cancelled