---
title: "Pause, resume or cancel a recurring purchase"
method: POST
path: "/v1/offsets/subscriptions/{subscription_id}"
tags: ["Offsets"]
---

# Pause, resume or cancel a recurring purchase

`POST /v1/offsets/subscriptions/{subscription_id}`

## Request

- Base URL: `https://carbonguru.io`
- URL: `https://carbonguru.io/v1/offsets/subscriptions/{subscription_id}`
- Auth: HTTP bearer

Available to an API key once the account switched API purchasing on (403 otherwise). Pause and cancel stop future charges; resume restarts them.

## Path parameters

- `subscription_id` string, required

## Request body

- object
  - `action` 'pause' | 'resume' | 'cancel', required

## Response `200`

{subscription: {...}}

## Other responses

- `403`: API purchasing is off, or not this account's key.
- `409`: That transition is not available from the current status.

---

[API](https://skmtc.dev/carbonguru/apis/carbonguru-api.md) · [All operations](https://skmtc.dev/carbonguru/apis/carbonguru-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonguru/apis/carbonguru-api/revisions/26dcbe7a8500?raw)
