Abrechnung

Basis-URL: https://app.neuroflash.com/api/workspace-service

Verwalten Sie Abrechnungskontakte und greifen Sie auf das Stripe-Abrechnungsportal zu.

POST/v1/workspaces/{workspaceId}/billing-contacts/{billingContactId}/stripe-checkout-sessions

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`billingContactId`	string	Ja	Abrechnungskontakt-ID

Anfrage-Body

callbackUrlstringJaURL, zu der nach erfolgreichem Checkout umgeleitet werden soll

languagestringNeinSprache, in der die Checkout-Sitzung geöffnet werden soll. Standardmäßig die Sprache des authentifizierten Kunden

legacyPricingPlanIdintegerNeinveraltete ID des Preisplans, für den ein Abonnement erstellt werden soll

pricingPlanIdstringNein

Antwort

_embeddedobject

couponobject

_embeddedobject

pricingPlanobject

activebooleanauf true gesetzt, wenn dieser Tarif in bestehenden und neuen Abonnements konfiguriert werden kann

billingIntervalstring

categoryIdstringID der Kategorie, zu der dieser Tarif gehört

displayNamestringName für interne Zwecke wie die Admin-Benutzeroberfläche oder Hubspot. Sollte nicht für Kunden angezeigt werden

idstringID des Tarifs

importedFromLegacyIdinteger

isDefaultbooleanIst dies der Standard-Tarif für neue Kunden?

priceInEuronumberwie viel der Kunde für dieses Abonnement bezahlen muss

pricePerCurrencyobjectEine Zuordnung von Zeichenkettenschlüsseln zu Gleitkommawerten

stripeBillingPortalEnabledbooleantrue, wenn Abonnements mit diesem Tarif im Stripe-Abrechnungsportal selbst verwaltet werden können

stripePriceIdstringID des Preises in Stripe

stripeTrackUsagebooleanwenn true, sollte die Nutzung für Abonnements mit diesem Tarif in Stripe nachverfolgt werden

tierinteger

trialDaysintegerwie viele Testtage für diesen Tarif zulässig sind

pricingPlanCategoryobject

displayNamestring

idstring

translationKeystring

discountPercentagenumber

legacyPricingPlanIdinteger

pricingPlanIdstring

translationKeystring

callbackUrlstringURL, zu der nach erfolgreichem Checkout umgeleitet werden soll

languagestringSprache, in der die Checkout-Sitzung geöffnet werden soll. Standardmäßig die Sprache des authentifizierten Kunden

legacyPricingPlanIdintegerveraltete ID des Preisplans, für den ein Abonnement erstellt werden soll

pricingPlanIdstring

statusstring

stripeClientSecretstringClient Secret für diese Checkout-Sitzung. Wird nur direkt nach der Erstellung gesetzt

stripePriceIdstringStripe ID des Preises aus dem neuen Abonnement, das ausgecheckt wird

stripeSubscriptionIdstringID des Stripe-Abonnements, das in diesem Checkout abonniert wird

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}/stripe-checkout-sessions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "callbackUrl": "string",
      "language": "string",
      "legacyPricingPlanId": 0,
      "pricingPlanId": "string"
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}/stripe-checkout-sessions",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "callbackUrl": "string",
        "language": "string",
        "legacyPricingPlanId": 0,
        "pricingPlanId": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/billing-contacts/${billingContactId}/stripe-checkout-sessions`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "callbackUrl": "string",
          "language": "string",
          "legacyPricingPlanId": 0,
          "pricingPlanId": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"callbackUrl": "string",
		"language": "string",
		"legacyPricingPlanId": 0,
		"pricingPlanId": "string",
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/billing-contacts/"+billingContactID+"/stripe-checkout-sessions", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "coupon": {
      "_embedded": {
        "pricingPlan": {
          "active": "...",
          "billingInterval": "...",
          "categoryId": "...",
          "displayName": "...",
          "id": "...",
          "importedFromLegacyId": "...",
          "isDefault": "...",
          "priceInEuro": "...",
          "pricePerCurrency": "...",
          "stripeBillingPortalEnabled": "...",
          "stripePriceId": "...",
          "stripeTrackUsage": "...",
          "tier": "...",
          "trialDays": "..."
        },
        "pricingPlanCategory": {
          "displayName": "...",
          "id": "...",
          "translationKey": "..."
        }
      },
      "discountPercentage": 0,
      "legacyPricingPlanId": 0,
      "pricingPlanId": "string",
      "translationKey": "string"
    }
  },
  "callbackUrl": "https://app.neuroflash.com/payment-callback?session_id={CHECKOUT_SESSION_ID}",
  "language": "de",
  "legacyPricingPlanId": 150,
  "pricingPlanId": "string",
  "status": "complete",
  "stripeClientSecret": "string",
  "stripePriceId": "string",
  "stripeSubscriptionId": "string"
}

Aktuellen Abrechnungskontakt für einen Arbeitsbereich abrufen

GET/v1/workspaces/{workspaceId}/billing-contacts/{billingContactId}

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID

Antwort

activeDiscountstringschreibgeschützt von Stripe synchronisiert: true, wenn ein Rabatt für diesen Stripe-Kunden aktiv ist

addressLine1stringschreibgeschützt von Stripe synchronisiert: erste Zeile der Adressen des Abrechnungskontakts

addressLine2stringschreibgeschützt von Stripe synchronisiert: zweite Zeile der Adressen des Abrechnungskontakts

citystringschreibgeschützt von Stripe synchronisiert: Stadt des Abrechnungskontakts

countrystringschreibgeschützt von Stripe synchronisiert: Land des Abrechnungskontakts

createdAtstring

createdByUserIdstring

defaultPaymentCardNumberLastFourDigitsstring

defaultPaymentMethodstring

defaultPaymentMethodCardBrandstring

emailstringE-Mail-Adresse des Abrechnungskontakts

idstring

importedFromLegacyCustomerIdintegerVeraltet: nur erforderlich, während der Import aus der Legacy-API noch aktiv ist

namestringName des Abrechnungskontakts

postalCodestringschreibgeschützt von Stripe synchronisiert: Postleitzahl des Abrechnungskontakts

statestringschreibgeschützt von Stripe synchronisiert: Bundesland des Abrechnungskontakts

stripeCustomerIdstringStripe-Kunden-ID für Abrechnungszwecke. Könnte optional werden, wenn wir weitere Zahlungsanbieter hinzufügen

updatedAtstring

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/billing-contacts/${billingContactId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/billing-contacts/"+billingContactID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "activeDiscount": "string",
  "addressLine1": "123 Main St",
  "addressLine2": "123 Main St",
  "city": "Berlin",
  "country": "DE",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "defaultPaymentCardNumberLastFourDigits": "1234",
  "defaultPaymentMethod": "acss_debit",
  "defaultPaymentMethodCardBrand": "amex",
  "email": "max.mustermann@neuroflash.com",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "importedFromLegacyCustomerId": 12345,
  "name": "Max Mustermann",
  "postalCode": "12345",
  "state": "Schleswig-Holstein",
  "stripeCustomerId": "cus_12345abcdef",
  "updatedAt": "2025-01-14T16:20:59Z"
}

erstellt eine Checkout-Sitzung in Stripe. Checkout-Sitzungen können verwendet werden, um einem Kunden den Wechsel von Preisplänen mit einer eingebetteten Ansicht zu ermöglichen, was praktischer ist als eine Umleitung zum Stripe-Portal

GET/v1/workspaces/{workspaceId}/billing-contacts/{billingContactId}/stripe-checkout-sessions/{sessionId}

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`workspaceId`	string	Ja	Arbeitsbereichs-ID
`billingContactId`	string	Ja	Abrechnungskontakt-ID
`sessionId`	string	Ja	Stripe Session ID

Antwort

_embeddedobject

couponobject

_embeddedobject

pricingPlanobject

activebooleanauf true gesetzt, wenn dieser Tarif in bestehenden und neuen Abonnements konfiguriert werden kann

billingIntervalstring

categoryIdstringID der Kategorie, zu der dieser Tarif gehört

displayNamestringName für interne Zwecke wie die Admin-Benutzeroberfläche oder Hubspot. Sollte nicht für Kunden angezeigt werden

idstringID des Tarifs

importedFromLegacyIdinteger

isDefaultbooleanIst dies der Standard-Tarif für neue Kunden?

priceInEuronumberwie viel der Kunde für dieses Abonnement bezahlen muss

pricePerCurrencyobjectEine Zuordnung von Zeichenkettenschlüsseln zu Gleitkommawerten

stripeBillingPortalEnabledbooleantrue, wenn Abonnements mit diesem Tarif im Stripe-Abrechnungsportal selbst verwaltet werden können

stripePriceIdstringID des Preises in Stripe

stripeTrackUsagebooleanwenn true, sollte die Nutzung für Abonnements mit diesem Tarif in Stripe nachverfolgt werden

tierinteger

trialDaysintegerwie viele Testtage für diesen Tarif zulässig sind

pricingPlanCategoryobject

displayNamestring

idstring

translationKeystring

discountPercentagenumber

legacyPricingPlanIdinteger

pricingPlanIdstring

translationKeystring

callbackUrlstringURL, zu der nach erfolgreichem Checkout umgeleitet werden soll

languagestringSprache, in der die Checkout-Sitzung geöffnet werden soll. Standardmäßig die Sprache des authentifizierten Kunden

legacyPricingPlanIdintegerveraltete ID des Preisplans, für den ein Abonnement erstellt werden soll

pricingPlanIdstring

statusstring

stripeClientSecretstringClient Secret für diese Checkout-Sitzung. Wird nur direkt nach der Erstellung gesetzt

stripePriceIdstringStripe ID des Preises aus dem neuen Abonnement, das ausgecheckt wird

stripeSubscriptionIdstringID des Stripe-Abonnements, das in diesem Checkout abonniert wird

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}/stripe-checkout-sessions/{session_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}/stripe-checkout-sessions/{session_id}",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/billing-contacts/${billingContactId}/stripe-checkout-sessions/${sessionId}`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/billing-contacts/"+billingContactID+"/stripe-checkout-sessions/"+sessionID+"", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "_embedded": {
    "coupon": {
      "_embedded": {
        "pricingPlan": {
          "active": "...",
          "billingInterval": "...",
          "categoryId": "...",
          "displayName": "...",
          "id": "...",
          "importedFromLegacyId": "...",
          "isDefault": "...",
          "priceInEuro": "...",
          "pricePerCurrency": "...",
          "stripeBillingPortalEnabled": "...",
          "stripePriceId": "...",
          "stripeTrackUsage": "...",
          "tier": "...",
          "trialDays": "..."
        },
        "pricingPlanCategory": {
          "displayName": "...",
          "id": "...",
          "translationKey": "..."
        }
      },
      "discountPercentage": 0,
      "legacyPricingPlanId": 0,
      "pricingPlanId": "string",
      "translationKey": "string"
    }
  },
  "callbackUrl": "https://app.neuroflash.com/payment-callback?session_id={CHECKOUT_SESSION_ID}",
  "language": "de",
  "legacyPricingPlanId": 150,
  "pricingPlanId": "string",
  "status": "complete",
  "stripeClientSecret": "string",
  "stripePriceId": "string",
  "stripeSubscriptionId": "string"
}

Abrechnungskontakt aktualisieren

PUT/v1/workspaces/{workspaceId}/billing-contacts/{billingContactId}

Abrechnungskontakt aktualisieren

Anfrage-Body

activeDiscountstringNeinschreibgeschützt von Stripe synchronisiert: true, wenn ein Rabatt für diesen Stripe-Kunden aktiv ist

addressLine1stringNeinschreibgeschützt von Stripe synchronisiert: erste Zeile der Adressen des Abrechnungskontakts

addressLine2stringNeinschreibgeschützt von Stripe synchronisiert: zweite Zeile der Adressen des Abrechnungskontakts

citystringNeinschreibgeschützt von Stripe synchronisiert: Stadt des Abrechnungskontakts

countrystringNeinschreibgeschützt von Stripe synchronisiert: Land des Abrechnungskontakts

defaultPaymentCardNumberLastFourDigitsstringNein

defaultPaymentMethodstringNein

defaultPaymentMethodCardBrandstringNein

emailstringJaE-Mail-Adresse des Abrechnungskontakts

namestringJaName des Abrechnungskontakts

postalCodestringNeinschreibgeschützt von Stripe synchronisiert: Postleitzahl des Abrechnungskontakts

statestringNeinschreibgeschützt von Stripe synchronisiert: Bundesland des Abrechnungskontakts

Antwort

activeDiscountstringschreibgeschützt von Stripe synchronisiert: true, wenn ein Rabatt für diesen Stripe-Kunden aktiv ist

addressLine1stringschreibgeschützt von Stripe synchronisiert: erste Zeile der Adressen des Abrechnungskontakts

addressLine2stringschreibgeschützt von Stripe synchronisiert: zweite Zeile der Adressen des Abrechnungskontakts

citystringschreibgeschützt von Stripe synchronisiert: Stadt des Abrechnungskontakts

countrystringschreibgeschützt von Stripe synchronisiert: Land des Abrechnungskontakts

createdAtstring

createdByUserIdstring

defaultPaymentCardNumberLastFourDigitsstring

defaultPaymentMethodstring

defaultPaymentMethodCardBrandstring

emailstringE-Mail-Adresse des Abrechnungskontakts

idstring

importedFromLegacyCustomerIdintegerVeraltet: nur erforderlich, während der Import aus der Legacy-API noch aktiv ist

namestringName des Abrechnungskontakts

postalCodestringschreibgeschützt von Stripe synchronisiert: Postleitzahl des Abrechnungskontakts

statestringschreibgeschützt von Stripe synchronisiert: Bundesland des Abrechnungskontakts

stripeCustomerIdstringStripe-Kunden-ID für Abrechnungszwecke. Könnte optional werden, wenn wir weitere Zahlungsanbieter hinzufügen

updatedAtstring

Beispiel

cURL
Python
Node.js
Go

curl -X PUT "https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "activeDiscount": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "country": "string",
      "defaultPaymentCardNumberLastFourDigits": "string",
      "defaultPaymentMethod": "string",
      "defaultPaymentMethodCardBrand": "string",
      "email": "string",
      "name": "string",
      "postalCode": "string",
      "state": "string"
  }'

import requests

response = requests.put(
    f"https://app.neuroflash.com/api/workspace-service/v1/workspaces/{workspace_id}/billing-contacts/{billing_contact_id}",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "activeDiscount": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "defaultPaymentCardNumberLastFourDigits": "string",
        "defaultPaymentMethod": "string",
        "defaultPaymentMethodCardBrand": "string",
        "email": "string",
        "name": "string",
        "postalCode": "string",
        "state": "string"
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/workspace-service/v1/workspaces/${workspaceId}/billing-contacts/${billingContactId}`,
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "activeDiscount": "string",
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "country": "string",
          "defaultPaymentCardNumberLastFourDigits": "string",
          "defaultPaymentMethod": "string",
          "defaultPaymentMethodCardBrand": "string",
          "email": "string",
          "name": "string",
          "postalCode": "string",
          "state": "string"
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"activeDiscount": "string",
		"addressLine1": "string",
		"addressLine2": "string",
		"city": "string",
		"country": "string",
		"defaultPaymentCardNumberLastFourDigits": "string",
		"defaultPaymentMethod": "string",
		"defaultPaymentMethodCardBrand": "string",
		"email": "string",
		"name": "string",
		"postalCode": "string",
		"state": "string",
	})

req, _ := http.NewRequest("PUT", "https://app.neuroflash.com/api/workspace-service/v1/workspaces/"+workspaceID+"/billing-contacts/"+billingContactID+"", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "activeDiscount": "string",
  "addressLine1": "123 Main St",
  "addressLine2": "123 Main St",
  "city": "Berlin",
  "country": "DE",
  "createdAt": "2025-01-14T16:20:59Z",
  "createdByUserId": "b0920767-2e30-48d3-80ce-268810bc433a",
  "defaultPaymentCardNumberLastFourDigits": "1234",
  "defaultPaymentMethod": "acss_debit",
  "defaultPaymentMethodCardBrand": "amex",
  "email": "max.mustermann@neuroflash.com",
  "id": "113c0b32-ed6c-4421-b7da-d1faf238eb56",
  "importedFromLegacyCustomerId": 12345,
  "name": "Max Mustermann",
  "postalCode": "12345",
  "state": "Schleswig-Holstein",
  "stripeCustomerId": "cus_12345abcdef",
  "updatedAt": "2025-01-14T16:20:59Z"
}

Erstellt eine Stripe-Checkout-Sitzung, mit der ein Kunde das Abonnement seines Arbeitsbereichs in einem eingebetteten Modal auf einen anderen Preis aktualisieren kann​

Pfadparameter​

Anfrage-Body​

Antwort​

Beispiel​

Aktuellen Abrechnungskontakt für einen Arbeitsbereich abrufen​

Pfadparameter​

Antwort​

Beispiel​

erstellt eine Checkout-Sitzung in Stripe. Checkout-Sitzungen können verwendet werden, um einem Kunden den Wechsel von Preisplänen mit einer eingebetteten Ansicht zu ermöglichen, was praktischer ist als eine Umleitung zum Stripe-Portal​

Pfadparameter​

Antwort​

Beispiel​

Abrechnungskontakt aktualisieren​

Anfrage-Body​

Antwort​

Beispiel​

Erstellt eine Stripe-Checkout-Sitzung, mit der ein Kunde das Abonnement seines Arbeitsbereichs in einem eingebetteten Modal auf einen anderen Preis aktualisieren kann

Pfadparameter

Anfrage-Body

Antwort

Beispiel

Aktuellen Abrechnungskontakt für einen Arbeitsbereich abrufen

Pfadparameter

Antwort

Beispiel

erstellt eine Checkout-Sitzung in Stripe. Checkout-Sitzungen können verwendet werden, um einem Kunden den Wechsel von Preisplänen mit einer eingebetteten Ansicht zu ermöglichen, was praktischer ist als eine Umleitung zum Stripe-Portal

Pfadparameter

Antwort

Beispiel

Abrechnungskontakt aktualisieren

Anfrage-Body

Antwort

Beispiel