> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/prism/python/recurring-payment-service/charge.md).

# Charge

## Overview

The `charge` method processes a recurring payment using an existing mandate. Once a customer has authorized recurring billing, use this method to charge their stored payment method without requiring their interaction.

**Business Use Case:** Your SaaS subscription renews monthly. The customer already authorized recurring payments during signup. On the renewal date, you call `charge` to process their subscription payment automatically.

## Purpose

**Why use recurring payment charges?**

| Scenario                 | Benefit                                   |
| ------------------------ | ----------------------------------------- |
| **Subscription billing** | Automate monthly/yearly recurring charges |
| **Membership dues**      | Process club/organization membership fees |
| **Installment plans**    | Collect scheduled payments automatically  |
| **Utility billing**      | Automate recurring service payments       |

**Key outcomes:**

* No customer interaction required for repeat payments
* Consistent cash flow for subscription businesses
* Reduced payment friction improves retention

## Request Fields

| Field                     | Type   | Required | Description                                           |
| ------------------------- | ------ | -------- | ----------------------------------------------------- |
| `merchant_transaction_id` | string | Yes      | Your unique transaction reference                     |
| `amount`                  | Money  | Yes      | Amount to charge in minor units (e.g., 1000 = $10.00) |
| `mandate_id`              | string | Yes      | The mandate ID from setup\_recurring                  |
| `description`             | string | No       | Description shown on customer's statement             |
| `metadata`                | dict   | No       | Additional data (max 20 keys)                         |
| `webhook_url`             | string | No       | URL for async webhook notifications                   |

## Response Fields

| Field                      | Type          | Description                                |
| -------------------------- | ------------- | ------------------------------------------ |
| `merchant_transaction_id`  | string        | Your transaction reference (echoed back)   |
| `connector_transaction_id` | string        | Connector's transaction ID                 |
| `status`                   | PaymentStatus | Current status: SUCCEEDED, PENDING, FAILED |
| `error`                    | ErrorInfo     | Error details if status is FAILED          |
| `status_code`              | int           | HTTP-style status code (200, 402, etc.)    |

## Example

### SDK Setup

```python
from hyperswitch_prism import RecurringPaymentClient

recurring_client = RecurringPaymentClient(
    connector='stripe',
    api_key='YOUR_API_KEY',
    environment='SANDBOX'
)
```

### Request

```python
request = {
    "merchant_transaction_id": "txn_sub_monthly_001",
    "amount": {
        "minor_amount": 2900,
        "currency": "USD"
    },
    "mandate_id": "mandate_xxx",
    "description": "Monthly Pro Plan Subscription"
}

response = await recurring_client.charge(request)
```

### Response

```python
{
    "merchant_transaction_id": "txn_sub_monthly_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "status": "SUCCEEDED",
    "status_code": 200
}
```

## Common Patterns

### Subscription Renewal Flow

```mermaid
sequenceDiagram
    participant App as Your App
    participant CS as Prism
    participant PP as Payment Provider

    Note over App: Renewal date reached
    App->>CS: 1. charge with mandate_id
    CS->>PP: Process recurring payment
    PP-->>CS: Return result: SUCCEEDED
    CS-->>App: Return status: SUCCEEDED
    Note over App: Subscription renewed
```

**Flow Explanation:**

1. **Check renewal** - On the scheduled date, call `charge` with the stored `mandate_id`.
2. **Process payment** - The charge is processed using the customer's stored payment method.
3. **Handle result** - If successful, extend the subscription period. If failed, initiate dunning workflow.

## Error Handling

| Error Code | Meaning               | Action                                 |
| ---------- | --------------------- | -------------------------------------- |
| `402`      | Payment failed        | Insufficient funds, expired card, etc. |
| `404`      | Mandate not found     | Verify mandate\_id is correct          |
| `409`      | Duplicate transaction | Use unique merchant\_transaction\_id   |

## Best Practices

* Call `charge` on the expected renewal date
* Handle failures gracefully with retry logic
* Notify customers of failed payments with update payment method link
* Store successful transaction IDs for reporting

## Next Steps

* [setup\_recurring](/integrations/prism/python/payment-service/setup-recurring.md) - Create initial mandate
* [revoke](/integrations/prism/python/recurring-payment-service/revoke.md) - Cancel recurring payments
* [Payment Service](/integrations/prism/python/payment-service.md) - Handle failed payment retries


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hyperswitch.io/integrations/prism/python/recurring-payment-service/charge.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.