Billing
Cancel subscription
POST
/api/billing/subscriptions/{subscriptionId}/cancelSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, BillingApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const billing = new BillingApi(configuration);import { Configuration, BillingApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const billing = new BillingApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await billing.cancelSubscription(
"5e93:d8f1:4e6d:e391:fc31:5c64:10fd:2199",
{
cancelImmediately: false
}
);const { data: result } = await billing.cancelSubscription(
"5e93:d8f1:4e6d:e391:fc31:5c64:10fd:2199",
{
cancelImmediately: false
}
);Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | string | Yes | — |
Request Body
json
{
"cancelImmediately": false
}{
"cancelImmediately": false
}Responses
200Subscription cancelled
json
{
"message": "Subscription cancelled successfully"
}{
"message": "Subscription cancelled successfully"
}401—
404—
500—
Errors
| Code | Meaning |
|---|---|
401 | — |
404 | — |
500 | — |