---
name: subscriptions-routes
description: Handle 12 OpenAPI operation(s) under /v2/subscriptions for the subscriptions route group.
---

# subscriptions API Routes

Handle 12 OpenAPI operation(s) under /v2/subscriptions for the subscriptions route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### create_subscription

- Operation ID: `create_subscription`
- Route: `POST /v2/subscriptions`
- Mode: WRITE
- Summary: CreateSubscription
- Body: JSON request body accepted.

### bulk_swap_plan

- Operation ID: `bulk_swap_plan`
- Route: `POST /v2/subscriptions/bulk-swap-plan`
- Mode: WRITE
- Summary: BulkSwapPlan
- Body: JSON request body accepted.

### search_subscriptions

- Operation ID: `search_subscriptions`
- Route: `POST /v2/subscriptions/search`
- Mode: WRITE
- Summary: SearchSubscriptions
- Body: JSON request body accepted.

### retrieve_subscription

- Operation ID: `retrieve_subscription`
- Route: `GET /v2/subscriptions/{subscription_id}`
- Mode: READ
- Summary: RetrieveSubscription
- Parameters:
  - `subscription_id` in `path` required
  - `include` in `query`

### update_subscription

- Operation ID: `update_subscription`
- Route: `PUT /v2/subscriptions/{subscription_id}`
- Mode: WRITE
- Summary: UpdateSubscription
- Parameters:
  - `subscription_id` in `path` required
- Body: JSON request body accepted.

### delete_subscription_action

- Operation ID: `delete_subscription_action`
- Route: `DELETE /v2/subscriptions/{subscription_id}/actions/{action_id}`
- Mode: WRITE
- Summary: DeleteSubscriptionAction
- Parameters:
  - `subscription_id` in `path` required
  - `action_id` in `path` required

### change_billing_anchor_date

- Operation ID: `change_billing_anchor_date`
- Route: `POST /v2/subscriptions/{subscription_id}/billing-anchor`
- Mode: WRITE
- Summary: ChangeBillingAnchorDate
- Parameters:
  - `subscription_id` in `path` required
- Body: JSON request body accepted.

### cancel_subscription

- Operation ID: `cancel_subscription`
- Route: `POST /v2/subscriptions/{subscription_id}/cancel`
- Mode: WRITE
- Summary: CancelSubscription
- Parameters:
  - `subscription_id` in `path` required

### list_subscription_events

- Operation ID: `list_subscription_events`
- Route: `GET /v2/subscriptions/{subscription_id}/events`
- Mode: READ
- Summary: ListSubscriptionEvents
- Parameters:
  - `subscription_id` in `path` required
  - `cursor` in `query`
  - `limit` in `query`

### pause_subscription

- Operation ID: `pause_subscription`
- Route: `POST /v2/subscriptions/{subscription_id}/pause`
- Mode: WRITE
- Summary: PauseSubscription
- Parameters:
  - `subscription_id` in `path` required
- Body: JSON request body accepted.

### resume_subscription

- Operation ID: `resume_subscription`
- Route: `POST /v2/subscriptions/{subscription_id}/resume`
- Mode: WRITE
- Summary: ResumeSubscription
- Parameters:
  - `subscription_id` in `path` required
- Body: JSON request body accepted.

### swap_plan

- Operation ID: `swap_plan`
- Route: `POST /v2/subscriptions/{subscription_id}/swap-plan`
- Mode: WRITE
- Summary: SwapPlan
- Parameters:
  - `subscription_id` in `path` required
- Body: JSON request body accepted.