API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · course_charges

Course Charge Schema

Schema-ID
course_charge
Collection
course_charges
Permissions
  • Lesencourse_charge_view
  • Anlegencourse_charge_view
  • Änderncourse_charge_refund
  • Löschencourse_charge_refund
Beziehungen

Felder

Course Charge Schema

course_charges4 Permissions

Billing record for one cross-tenant enrollment in a paid shared course

enrollmentIduuiderforderlich
read-only
courseIduuiderforderlich→ course
read-only
shareIduuiderforderlich
read-only
consumerTenantIduuiderforderlich

Customer-tenant the learner belongs to (the bill recipient).

read-only
consumerUserIduuiderforderlich

User in the customer-tenant who triggered the enrollment.

read-only
grossAmountCentsintegererforderlich

Gross charge in EUR cents (or `currency` cents) — what the customer owes.

≥ 0read-only
netAmountCentsintegeroptional

Net of VAT.

≥ 0read-only
taxAmountCentsintegeroptional

VAT amount.

≥ 0read-only
taxRatePercentnumberoptional
0 – 100Default: 19
currencystringerforderlich
Default: "EUR"
mspNetAmountCentsintegererforderlich

What the MSP keeps after Codemeta platform fee.

≥ 0read-only
codemetaPlatformFeeCentsintegererforderlich

Codemeta platform fee deducted from the charge.

≥ 0read-only
codemetaPlatformFeePercentnumberoptional

Percentage of gross taken as platform fee at charge creation time.

0 – 100Default: 10read-only
statusstringerforderlich
Werte
pendinginvoicedpaidrefundedfailed
Default: "pending"
billingModestringerforderlich

wholesale: aggregated into customer wholesale invoice. direct_stripe: paid in real-time via Stripe Connect.

Werte
wholesaledirect_stripe
read-only
occurredAtdatetimeerforderlich

When the charge became applicable (= enrollment creation time).

read-only
invoicedAtdatetimeoptional
nullable
invoiceIduuidoptional

Wholesale invoice the charge has been bundled into.

nullable
paidAtdatetimeoptional
nullable
refundedAtdatetimeoptional
nullable
refundReasonstringoptional
max 500 Zeichennullable
stripePaymentIntentIdstringoptional
read-onlynullable
stripeChargeIdstringoptional
nullable
stripeRefundIdstringoptional
nullable
stripeAccountIdstringoptional

MSP Stripe Connect account that received the destination charge.

nullable
notesstringoptional
max 2000 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/course_charges — Liste, paginiert + filterbar
  • GET /api/v1/course_charges/<id> — Einzelne Entity
  • POST /api/v1/course_charges — Anlegen
  • PATCH /api/v1/course_charges/<id> — Teil-Update
  • DELETE /api/v1/course_charges/<id> — Soft-Delete
  • GET /api/v1/course_charges/<id>/timeline — Audit + Aktivitäten

Suche