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

# Pause unpause

A merchant can temporarily suspend an **ACTIVE** subscription using the **Pause API**. During the pause period, no scheduled invoices or automatic payment collections are processed.

When the customer is ready to continue the subscription, the merchant can resume it using the **Unpause API**, which changes the subscription back to the **ACTIVE** state.

```mermaid theme={null}
flowchart LR

A[ACTIVE] -->|Pause API| B[PAUSED]
B -->|Unpause API| A
```

## Pause Subscription

The Pause API temporarily suspends an ACTIVE subscription while preserving the subscription configuration. No billing attempts are made until the subscription is resumed.

### Pause Flow

```mermaid theme={null}
sequenceDiagram

participant Merchant
participant TB as Transact Bridge
participant Subscription

Merchant->>TB: Pause Subscription API
TB->>Subscription: Validate ACTIVE subscription
Subscription-->>TB: Valid
TB->>Subscription: Change status to PAUSED
Subscription-->>TB: Status Updated
TB-->>Merchant: Success Response
```

### Common Use Cases

| Scenario                 | Illustration                                                                                       |
| ------------------------ | -------------------------------------------------------------------------------------------------- |
| Customer-requested break | A customer pauses a gym membership, meal delivery, or another subscription temporarily.            |
| Seasonal service         | Services such as pool cleaning or AC maintenance are paused during the off-season.                 |
| Payment issue            | Multiple payment failures caused by insufficient funds, expired cards, or invalid payment details. |
| Account review           | Merchant needs to complete fraud checks or customer verification before continuing billing.        |
| Temporary unavailability | Product or service is temporarily unavailable or out of stock.                                     |
| Plan transition          | Subscription is paused while an upgrade or downgrade is being processed.                           |

### Pause API

Refer to the <a href="https://docs.transactbridge.com/#e91a292e-d13c-4a27-a77e-dfbbc63447b7">Pause API</a> to pause an active subscription.

***

## Unpause Subscription

The Unpause API resumes a previously paused subscription. Once resumed, future billing cycles continue according to the subscription schedule.

### Unpause Flow

```mermaid theme={null}
sequenceDiagram

participant Merchant
participant TB as Transact Bridge
participant Subscription

Merchant->>TB: Unpause Subscription API
TB->>Subscription: Validate PAUSED subscription
Subscription-->>TB: Valid
TB->>Subscription: Change status to ACTIVE
Subscription-->>TB: Status Updated
TB-->>Merchant: Success Response
```

### Common Use Cases

| Scenario                 | Illustration                                                                      |
| ------------------------ | --------------------------------------------------------------------------------- |
| Customer resumes service | Customer wants to continue the subscription.                                      |
| Payment method updated   | Customer updates card or bank account details.                                    |
| Outstanding dues cleared | Customer clears overdue invoices that caused the pause.                           |
| Service available again  | Previously unavailable product or service becomes available.                      |
| Verification completed   | Merchant completes KYC or fraud verification.                                     |
| Pause period ends        | Subscription automatically or manually resumes after a predefined pause duration. |

### Unpause API

Refer to <a href="https://docs.transactbridge.com/#3ccbb9e0-c648-42b8-9bd8-de74c38b3743">Unpause API</a> to unpause your paused subscription.

***

## State Transition

```mermaid theme={null}
stateDiagram-v2

[*] --> ACTIVE

ACTIVE --> PAUSED : Pause API
PAUSED --> ACTIVE : Unpause API

ACTIVE --> CANCELLED : Cancel API
```

***

## Notes

* Only subscriptions in the **ACTIVE** state can be paused.
* Only subscriptions in the **PAUSED** state can be resumed.
* Pausing a subscription does **not** cancel the subscription.
* Subscription configuration, billing frequency, mandate, and customer information remain unchanged while paused.
* After resuming, billing continues according to the configured billing schedule.