Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
import { createOakClient, createSubscriptionService } from '@oaknetwork/payments-sdk'; const client = createOakClient({ ... }); const subscriptions = createSubscriptionService(client);
subscribe(request)
cancel(subscriptionId)
list(query?)
get(subscriptionId)
pay(subscriptionId, request)
const result = await subscriptions.subscribe({ plan_id: 'plan_abc123', customer_id: 'cus_abc123', payment_method_id: 'pm_xyz789', }); if (result.ok) { console.log('Subscription ID:', result.value.data.id); console.log('Status:', result.value.data.status); }
plan_id
string
customer_id
payment_method_id
const result = await subscriptions.cancel('sub_abc123'); if (result.ok) { console.log('Subscription cancelled'); }
const result = await subscriptions.list({ limit: 20, offset: 0, }); if (result.ok) { for (const sub of result.value.data) { console.log(`${sub.id} — ${sub.status}`); } }
const result = await subscriptions.get('sub_abc123'); if (result.ok) { const sub = result.value.data; console.log('Plan:', sub.plan_id); console.log('Status:', sub.status); console.log('Next billing:', sub.next_billing_date); }
const result = await subscriptions.pay('sub_abc123', { amount: 2999, payment_method_id: 'pm_xyz789', }); if (result.ok) { console.log('Payment processed:', result.value.data); }
id
status
Status
next_billing_date
created_at
updated_at