> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resume a paused subscription

> Resume a paused subscription. The resume date is automatically set to today in the subscription's timezone. This will adjust the subscription end date based on actual pause duration.

- If resumed early (before scheduled `scheduled_resume_at`): reduces `ends_at` by unused days
- If resumed on schedule: no change to `ends_at`



## OpenAPI

````yaml https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/resume
openapi: 3.0.3
info:
  title: Salesbricks REST API
  version: 2.0.0
  description: API reference for external integrations
servers:
  - url: https://api.salesbricks.com/api/v2
    description: Production
  - url: https://api.staging.salesbricks.com/api/v2
    description: Staging
security:
  - ApiKeyAuth: []
tags:
  - name: Subscriptions
    description: >-
      Operations related to subscription management, including creation,
      updates, and retrieving subscription details. Subscriptions can be
      upgraded to add / remove add-ons by using the POST
      /subscriptions/{subscription_id}/upgrade endpoint and can be recasted for
      replacing the current agreement using the POST
      /subscriptions/{subscription_id}/recast endpoint
  - name: Customers
    description: >-
      Operations related to customer management, including creation, updates,
      and managing customer person objects.
  - name: Invoices
    description: Operations related to subscription's invoicing details.
  - name: Plans
    description: >-
      Operations related to listing and getting plan details including bricks in
      the plan.
  - name: Payment Methods
    description: Operations related to subscription's payment method.
paths:
  /subscriptions/{subscription_id}/resume:
    post:
      tags:
        - Subscriptions
      summary: Resume a paused subscription
      description: >-
        Resume a paused subscription. The resume date is automatically set to
        today in the subscription's timezone. This will adjust the subscription
        end date based on actual pause duration.


        - If resumed early (before scheduled `scheduled_resume_at`): reduces
        `ends_at` by unused days

        - If resumed on schedule: no change to `ends_at`
      operationId: resumeSubscription
      parameters:
        - in: path
          name: subscription_id
          schema:
            type: string
            pattern: ^([a-zA-Z\d\-]+)$
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionResumeInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SubscriptionResumeInput'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SubscriptionResumeInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResumeOutput'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                BadRequestResponse:
                  value:
                    error:
                      code: ERR_BAD_REQUEST
                      message: >-
                        Bad request — the input payload is malformed, missing
                        required fields, or contains invalid data.
                      details:
                        fields:
                          paused_at:
                            - This field is required.
                  summary: Bad Request Response
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                NotFoundResponse:
                  value:
                    error:
                      code: ERR_NOT_FOUND
                      message: >-
                        Subscription not found — no subscription matches the
                        given `subscription_id`.
                  summary: Not Found Response
          description: ''
components:
  schemas:
    SubscriptionResumeInput:
      type: object
      description: Input serializer for resuming a paused subscription.
      properties:
        should_notify_customer:
          type: boolean
          default: false
          description: Whether to notify the customer about the subscription resumption.
    SubscriptionResumeOutput:
      type: object
      description: Output serializer for resume subscription response.
      properties:
        subscription_id:
          type: string
          format: uuid
          description: ID of the subscription.
        pause_id:
          type: string
          format: uuid
          description: ID of the pause record.
        paused_at:
          type: string
          format: date-time
          description: When the pause started.
        scheduled_resume_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the subscription is scheduled to automatically resume (set at
            pause time).
        resumed_at:
          type: string
          format: date-time
          nullable: true
          description: When the subscription was actually resumed (null if still paused).
        pause_duration_days:
          type: integer
          description: Actual number of days the subscription was paused.
        ends_at:
          type: string
          format: date
          description: The subscription end date (adjusted based on pause duration).
      required:
        - ends_at
        - pause_duration_days
        - pause_id
        - paused_at
        - resumed_at
        - scheduled_resume_at
        - subscription_id
    ErrorResponse:
      type: object
      description: >-
        Standardizes API error responses with a consistent structure containing
        error code and message.
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
    Error:
      type: object
      description: >-
        Represents individual error details with a standardized code and
        descriptive message.
      properties:
        code:
          enum:
            - ERR_NOT_FOUND
            - ERR_BAD_REQUEST
            - ERR_SERVER_ERROR
          type: string
          x-spec-enum-id: dc5a5d6feae1b697
          description: >-
            Error code indicating the type of error: NOT_FOUND for missing
            resources, BAD_REQUEST for invalid input, SERVER_ERROR for internal
            server issues


            * `ERR_NOT_FOUND` - ERR_NOT_FOUND

            * `ERR_BAD_REQUEST` - ERR_BAD_REQUEST

            * `ERR_SERVER_ERROR` - ERR_SERVER_ERROR
        message:
          type: string
        error_id:
          type: string
          format: uuid
          description: >-
            Correlation handle for SERVER_ERROR responses — quote this when
            contacting support; it joins to the structured server log line for
            the failure. Not present on 4xx responses.
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-SALESBRICKS-KEY
      description: API key for authentication

````

## Related topics

- [Customer email notifications](/documentation/customer-email-notifications.md)
- [subscription.inactive](/api-reference/webhooks/subscription/inactive.md)
- [Subscription Inactive Payload](/api-reference/webhooks/subscription/payload.md)
