# Pause Subscription

Pause a subscription to temporarily stop charge generation

Endpoint: POST /subscriptions/{subscriptionId}/pause
Version: 1.0.0
Security: OAuth2

## Path parameters:

  - `subscriptionId` (string, required)
    Unique identifier for the subscription

## Response 200 fields (application/json):

  - `id` (string, required)

  - `entityId` (string, required)

  - `billableEntityId` (string, required)
    Reference to BillableEntity in Profile Service

  - `rateId` (string, required)

  - `allocationConfigId` (string, required)

  - `discountRateIds` (array)
    Discount rates to apply

  - `billingFrequency` (string, required)
    Billing frequency for subscriptions
    Enum: "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY"

  - `billingAnchorDay` (integer, required)
    Day of week (1-7) for WEEKLY/BIWEEKLY, day of month (1-31) for MONTHLY

  - `billingTimezone` (string, required)
    IANA timezone for billing calculations
    Example: "America/New_York"

  - `startDate` (string, required)

  - `endDate` (string,null)

  - `status` (string, required)
    Status of subscription
    Enum: "ACTIVE", "PAUSED", "CANCELLED"

  - `version` (integer, required)
    Business version number for change tracking (subscription configuration history)

  - `optimisticLockVersion` (integer)
    Optimistic locking version (managed by Hibernate @Version). Prevents concurrent update conflicts.

  - `createdAt` (string, required)

  - `updatedAt` (string)

## Response 401 fields (application/json):

  - `result` (object, required)

  - `result.status` (string, required)
    Response status (always ERROR for error responses)
    Enum: "ERROR"

  - `error` (object, required)

  - `error.responseCode` (string, required)
    Response code (numeric or contains numbers, e.g., "404", "409", "500", "ERR001")
    Example: "404"

  - `error.responseMessage` (array, required)
    Array of error message strings for multiple error details
    Example: ["Charge not found","The requested charge ID does not exist in the system"]

## Response 404 fields (application/json):

  - `result` (object, required)

  - `result.status` (string, required)
    Response status (always ERROR for error responses)
    Enum: "ERROR"

  - `error` (object, required)

  - `error.responseCode` (string, required)
    Response code (numeric or contains numbers, e.g., "404", "409", "500", "ERR001")
    Example: "404"

  - `error.responseMessage` (array, required)
    Array of error message strings for multiple error details
    Example: ["Charge not found","The requested charge ID does not exist in the system"]

## Response 409 fields (application/json):

  - `result` (object, required)

  - `result.status` (string, required)
    Response status (always ERROR for error responses)
    Enum: "ERROR"

  - `error` (object, required)

  - `error.responseCode` (string, required)
    Response code (numeric or contains numbers, e.g., "404", "409", "500", "ERR001")
    Example: "404"

  - `error.responseMessage` (array, required)
    Array of error message strings for multiple error details
    Example: ["Charge not found","The requested charge ID does not exist in the system"]