Subscriptions API
Create, retrieve, and cancel subscriptions
llms.txtCreate, retrieve, and cancel subscriptions
Create subscription
POST /v1/subscriptions
Body (createSubscriptionSchema):
| Field | Type | Required |
|---|---|---|
customerId | string | Yes |
productId | string | Yes |
authorizedTransactionId | string | No |
startAt | string (ISO) | No |
discountId | string | No |
metadata | object | No |
Response 201. Errors: 404 if customer/product missing.
Get subscription
GET /v1/subscriptions/:id
Response 200 or 404.
Cancel subscription
POST /v1/subscriptions/:id/cancel
Body (cancelSubscriptionSchema):
| Field | Type | Description |
|---|---|---|
atPeriodEnd | boolean | Cancel at period end instead of immediately |
Response 200 - updated subscription.
await kwit.subscriptions.cancel(subscriptionId, { atPeriodEnd: true });