Recharge

Diese Anleitung zeigt, wie du dich mit der Recharge API verbindest, einen API-Schlüssel generierst und gängige Use Cases wie das Abrufen von Kunden, Bestellungen, Abonnements oder Adressen umsetzt.

---

🔐 1. Authentifizierung & Autorisierung

Recharge verwendet API-Schlüssel zur Authentifizierung. Jede API-Anfrage muss den folgenden Header enthalten: X-Recharge-Access-Token: store_api_token

Ersetze store_api_token durch deinen eigenen API-Schlüssel.

⚠️ Ohne gültigen API-Schlüssel wird deine Anfrage mit einem 401-Fehler (Unauthorized) abgelehnt.

---

🧭 Woher bekomme ich den API-Schlüssel?

1. Melde dich im Recharge Merchant Portal an.

2. Navigiere zu Apps → API Tokens.

3. Klicke auf Create an API Token.

1. Gib im Abschnitt Details einen Namen und eine Kontakt-E-Mail an.

2. Lege die Berechtigungen fest:

   • 🔒 Kein Zugriff

   • 👁️ Nur Lesen

   • ✏️ Lesen & Schreiben

3. Aktiviere die benötigten API-Scopes, um den Zugriff auf bestimmte Endpunkte zu erlauben.

4. Klicke auf Speichern, um dein Token zu erstellen.

Scopes definieren, welche Operationen dein API-Token ausführen darf – z. B. nur Kunden lesen oder Bestellungen bearbeiten.

---

🚀 2. Use Cases – Häufige API-Abfragen

Alle Anfragen benötigen folgende Header:

Content-Type: application/json X-Recharge-Access-Token: your_api_token X-Recharge-Version: 2021-11

👤 Get Customer Details (nach E-Mail-Adresse)

Type: GET URL: https://api.rechargeapps.com/customers/[email protected]

Beispiel-Response:

{
  "customers": [
    {
      "id": 99697523,
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Doe",
      "billing_city": "Berlin",
      "billing_phone": "[phone]",
      "created_at": "2022-11-24T06:53:40",
      "updated_at": "2024-06-10T06:10:59"
    }
  ]
}

---

🆔 Get Customer Details (nach Customer ID)

Type: GET URL: https://api.rechargeapps.com/customers/12345678

Beispiel-Response:

{
  "customer": {
    "id": 99697523,
    "email": "[email protected]",
    "first_name": "Isabella",
    "last_name": "Fiedler",
    "phone": "[phone]",
    "subscriptions_active_count": 2,
    "subscriptions_total_count": 5,
    "created_at": "2022-11-24T11:53:40+00:00"
  }
}

---

📦 Get All Orders (nach Customer ID)

Type: GET URL: https://api.rechargeapps.com/orders/?customer_id=12345678

Beispiel-Response (gekürzt):

{
  "orders": [
    {
      "id": 745749332,
      "created_at": "2024-06-02T05:09:09+00:00",
      "currency": "EUR",
      "customer": {
        "id": 99697523,
        "email": "[email protected]"
      },
      "discounts": [
        { "code": "BELLA-EMPL-PERK", "value": 100.0, "value_type": "percentage" }
      ],
      "line_items": [
        {
          "title": "Mobiliser Q",
          "quantity": 1,
          "unit_price": "138.28",
          "images": {
            "large": "https://cdn.shopify.com/.../product_large.png"
          }
        }
      ]
    }
  ]
}

📌Du kannst optional Parameter wie status, created_at_min oder limit anhängen, um Ergebnisse zu filtern.

---

🔁 Retrieve a List of Subscriptions (nach Customer ID)

Type: GET URL:

https://api.rechargeapps.com/subscriptions/?customer_id=12345678

Beispiel-Response:

{
  "subscriptions": [
    {
      "id": 430704100,
      "customer_id": 12345678,
      "product_title": "Cell Primer A",
      "price": "571.42",
      "status": "cancelled",
      "cancelled_at": "2024-06-10T09:39:06+00:00"
    }
  ]
}

📌 Das Feld status kann z. B. ACTIVE, CANCELLED oder EXPIRED enthalten.

---

🏠 Get All Addresses of a Customer

Type: GET URL: https://api.rechargeapps.com/addresses?customer_id=12345678

Beispiel-Response:

{
  "addresses": [
    {
      "id": 987654321,
      "customer_id": 12345678,
      "first_name": "John",
      "last_name": "Doe",
      "address1": "Karlsruher Straße 5",
      "city": "Berlin",
      "zip": "10711",
      "country_code": "DE"
    }
  ]
}

---

✏️ Update an Address

Type: PUT URL: https://api.rechargeapps.com/addresses/0987654321

Body (Beispiel):

{
  "address1": "Böttnerstraße 33A",
  "city": "Berlin",
  "zip": "13125",
  "country_code": "DE"
}

Nur die im Body angegebenen Felder werden geändert – andere bleiben unverändert.

---

📍 Retrieve a Single Address

Type: GET URL: https://api.rechargeapps.com/addresses/109327740

Beispiel-Response:

{
  "address": {
    "id": 987654321,
    "customer_id": 12345678,
    "address1": "Karlsruher Straße 5",
    "city": "Berlin",
    "zip": "10711",
    "country_code": "DE",
    "created_at": "2022-11-24T11:53:40+00:00"
  }
}

---

✅ Ergebnis

Nach Abschluss dieser Schritte kannst du:

• Einen Recharge API-Schlüssel erstellen

• Über HTTP-Anfragen auf Kundendaten, Bestellungen und Abos zugreifen

• Adressen abrufen oder aktualisieren

• Eigene Automatisierungen oder Integrationen entwickeln

Deine Recharge-API-Integration ist nun bereit! Verwende deinen Token sicher und halte deine Version (z. B. X-Recharge-Version: 2021-11) immer aktuell.