Billing admin

GET /api/billing/admin/subscriptions

All subscriptions, filterable

• Access: Administrator

GET /api/billing/admin/subscriptions/{id}

One subscription with its timeline, invoices and order

• Access: Administrator
• Path parameters: id

POST /api/billing/admin/subscriptions/{id}/cancel

Cancel a subscription now or at period end

• Access: Administrator
• Path parameters: id
• Body: when?

POST /api/billing/admin/subscriptions/{id}/change

Move a subscription to another plan or interval

• Access: Administrator
• Path parameters: id
• Body: planId, cycle

POST /api/billing/admin/subscriptions/{id}/extend

Change the end date of a complimentary subscription

• Access: Administrator
• Path parameters: id
• Body: endsAt

POST /api/billing/admin/subscriptions/{id}/hold

Keep the server stopped regardless of payment, or release it

• Access: Administrator
• Path parameters: id
• Body: on, note?

POST /api/billing/admin/subscriptions/{id}/note

Set a private note

• Access: Administrator
• Path parameters: id
• Body: note

POST /api/billing/admin/subscriptions/{id}/refund

Refund an invoice, fully or partly

• Access: Administrator
• Path parameters: id
• Body: invoiceId, amount?, cancel?

POST /api/billing/admin/subscriptions/{id}/refund-cancel

Refund the last payment and end the subscription

• Access: Administrator
• Path parameters: id

POST /api/billing/admin/subscriptions/{id}/resume

Resume a subscription set to end

• Access: Administrator
• Path parameters: id

POST /api/billing/admin/subscriptions/{id}/retry-fulfilment

Try to create the paid server again

• Access: Administrator
• Path parameters: id

POST /api/billing/admin/subscriptions/{id}/sync

Read the subscription from the payment provider again

• Access: Administrator
• Path parameters: id

POST /api/billing/admin/subscriptions/{id}/terminate

Delete (after a final backup) the server of a suspended or cancelled subscription

• Access: Administrator
• Path parameters: id
• Body: confirm

GET /api/billing/events

Received payment events and their processing result

• Access: Administrator

POST /api/billing/events/{id}/retry

Process a payment event again

• Access: Administrator
• Path parameters: id

POST /api/billing/grants

Give a customer a plan without payment

• Access: Administrator
• Body: userId, planId, cycle?, endsAt?, note?, serverName?, location?

GET /api/billing/health

Provider connection, webhook inbox, failed fulfilments, drift

• Access: Administrator

GET /api/billing/invoices

Mirror of the provider invoices

• Access: Administrator

GET /api/billing/invoices.csv

Invoices as a spreadsheet

• Access: Administrator

GET /api/billing/overview

Recurring revenue, subscriptions by status, churn

• Access: Administrator

POST /api/billing/provider/check

Test the connection to the payment provider

• Access: Administrator

GET /api/billing/readiness

What must work before the store can open

• Access: Administrator

POST /api/billing/test-data/reset

Remove test-mode records once the provider is in live mode

• Access: Administrator
• Body: confirm