Cancel subscription

Cancels a subscription. Metered and past-due subscriptions are canceled immediately. Others cancel at the end of the current billing period.

POST /subscriptions/{id}/cancel

Typescript (SDK)

TypeScript

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.subscriptions.cancel({
    id: "<id>",
  });

  console.log(result);
}

run();

200

{
  "id": "<string>",
  "object": "<string>",
  "status": {},
  "quantity": {},
  "current_period_start": {},
  "current_period_end": {},
  "trial_ends_at": {},
  "ends_at": {},
  "created_at": {},
  "updated_at": {},
  "canceled": true,
  "paused": true
}

Authorizations

Authorization · string · header · required

API key in the format: Bearer {api_token}

Path Parameters

id · string · required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

200

application/json

Subscription canceled

id · string · required

object · string · required

status · object · required

quantity · object · required

current_period_start · object · required

current_period_end · object · required

trial_ends_at · object · required

ends_at · object · required

created_at · object · required

updated_at · object · required

canceled · boolean · required

paused · boolean · required