Skip to main content
POST
/
subscriptions
/
{id}
/
pause
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

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

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

  console.log(result);
}

run();
{
  "id": "<string>",
  "object": "<string>",
  "status": "<string>",
  "quantity": 123,
  "current_period_start": "2023-11-07T05:31:56Z",
  "current_period_end": "2023-11-07T05:31:56Z",
  "trial_ends_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "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

Subscription paused

​
id
string
required
​
object
string
required
​
status
string | null
required
​
quantity
integer
required
​
current_period_start
string<date-time> | null
required
​
current_period_end
string<date-time> | null
required
​
trial_ends_at
string<date-time> | null
required
​
ends_at
string<date-time> | null
required
​
created_at
string<date-time> | null
required
​
updated_at
string<date-time> | null
required
​
canceled
boolean
required
​
paused
boolean
required