> ## 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. # Pause a subscription > Pause an active subscription. Creates a SubscriptionPause record and optionally extends the subscription end date if a scheduled resume date is provided. If `scheduled_resume_at` is provided, the subscription end date (`ends_at`) will be extended by the number of days between `paused_at` and `scheduled_resume_at`. If `scheduled_resume_at` is not provided, the pause is open-ended and the extension will be calculated when the subscription is resumed based on the actual pause duration. ## OpenAPI ````yaml https://api.salesbricks.com/api/v2/openapi.yaml post /subscriptions/{subscription_id}/pause 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}/pause: post: tags: - Subscriptions summary: Pause a subscription description: >- Pause an active subscription. Creates a SubscriptionPause record and optionally extends the subscription end date if a scheduled resume date is provided. If `scheduled_resume_at` is provided, the subscription end date (`ends_at`) will be extended by the number of days between `paused_at` and `scheduled_resume_at`. If `scheduled_resume_at` is not provided, the pause is open-ended and the extension will be calculated when the subscription is resumed based on the actual pause duration. operationId: pauseSubscription parameters: - in: path name: subscription_id schema: type: string pattern: ^([a-zA-Z\d\-]+)$ required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionPauseInput' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionPauseInput' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionPauseInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionPauseOutput' 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: SubscriptionPauseInput: type: object description: Input serializer for pausing a subscription. properties: paused_at: type: string format: date-time description: When the pause starts (ISO 8601 datetime). scheduled_resume_at: type: string format: date-time nullable: true description: >- Optional scheduled resume date (ISO 8601 datetime). If provided, the subscription end date will be extended by the pause duration. If not provided, the pause is open-ended and extension happens at resume time. Note: If no scheduled_resume_at is provided and the subscription remains paused past its end date, the subscription will be terminated. pause_reason: type: string default: '' description: Optional reason for pausing the subscription. notify_customer: type: boolean default: false description: Whether to send the customer a notification about the pause. required: - paused_at SubscriptionPauseOutput: type: object description: Output serializer for pause 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). extension_days: type: integer description: Number of days the subscription end date was extended. is_active: type: boolean description: Whether the pause is currently active. required: - extension_days - is_active - 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) - [Setup](/integrations/stripe/setup.md)