End a subscription
Ends a subscription. It cancels at the END OF THE PAID PERIOD by default, because a customer who cancels has already paid for the period they are in and…
POST /v1/billing/subscriptions/{id}/cancel
| Address | https://api.hanzo.ai/v1/billing/subscriptions/{id}/cancel |
| Method | POST |
| Operation | cancelSubscription |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Ends a subscription.
It cancels at the END OF THE PAID PERIOD by default, because a customer who
cancels has already paid for the period they are in and taking it away is
taking money for nothing. atPeriodEnd: false ends it at once, which is the
caller asking for that.
A subscription from another org is not found rather than refused, so an id cannot be probed for existence.
A named handler, not a closure, so zipdoc can lift this prose into the registry.
Request
3 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
atPeriodEnd | body | boolean | — | AtPeriodEnd cancels at the end of the paid period rather than at once. |
id | body | string | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | Subscription | ok |
200 body — 23 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
cancelAtPeriodEnd | body | boolean | — | |
canceledAt | body | string | — | |
createdAt | body | string | — | |
currentPeriodEnd | body | string | — | |
currentPeriodStart | body | string | — | |
defaultPaymentMethod | body | string | — | |
endedAt | body | string | — | |
id | body | string | — | |
mrrCents | body | integer | — | MRRCents is what this subscription contributes per month — commerce's own figure, interval-normalized and multiplied by its seats, so no reader re-derives it… |
plan | body | SubscriptionPlan | — | |
plan.currency | body | string | — | |
plan.id | body | string | — | |
plan.interval | body | string | — | |
plan.name | body | string | — | |
plan.price | body | integer | — | |
planId | body | string | — | |
providerType | body | string | — | |
quantity | body | integer | — | |
status | body | string | — | |
trialEnd | body | string | — | |
trialStart | body | string | — | |
updatedAt | body | string | — | |
userId | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo billing subscriptions cancel <id>import { Configuration, BillingApi } from 'hanzoai';
const api = new BillingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.cancelSubscription({ id: 'id', atPeriodEnd: false, id: "<id>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import BillingApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BillingApi(client).cancel_subscription(id='id', at_period_end=False, id="<id>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.BillingAPI.CancelSubscription(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, billing_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = billing_api::cancel_subscription(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.BillingApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new BillingApi(client).cancelSubscription();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/billing/subscriptions/<id>/cancel \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"atPeriodEnd": false,
"id": "<id>"
}'The door reaches billing through the billing tool, which names its 9 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_billing_balance"
}
}
}'How is this guide?