---
title: "Block a subscription"
method: POST
path: "/1.0/kb/subscriptions/{subscriptionId}/block"
tags: ["Subscription"]
---

# Block a subscription

`POST /1.0/kb/subscriptions/{subscriptionId}/block`

## Path parameters

- `subscriptionId` string, uuid, required

## Query parameters

- `requestedDate` string, date
- `pluginProperty` string[]

## Headers

- `X-Killbill-CreatedBy` string, required
- `X-Killbill-Reason` string
- `X-Killbill-Comment` string

## Request body

- BlockingState
  - `blockedId` string, uuid
  - `stateName` string
  - `service` string
  - `isBlockChange` boolean
  - `isBlockEntitlement` boolean
  - `isBlockBilling` boolean
  - `effectiveDate` string, date-time
  - `type` 'SUBSCRIPTION' | 'SUBSCRIPTION_BUNDLE' | 'ACCOUNT'
  - `auditLogs` AuditLog[]
    - `changeType` string
    - `changeDate` string, date-time
    - `objectType` 'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'
    - `objectId` string, uuid
    - `changedBy` string
    - `reasonCode` string
    - `comments` string
    - `userToken` string
    - `history` Entity
      - `id` string, uuid
      - `updatedDate` string, date-time
      - `createdDate` string, date-time

## Response `201`

Blocking state created successfully

## Other responses

- `400` — Invalid subscription id supplied
- `404` — Subscription not found

---

[API](https://skmtc.net/killbill/apis/kill-bill.md) · [All operations](https://skmtc.net/killbill/apis/kill-bill/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/killbill/kill-bill/versions/0fb95d23caf5/schema)