Abonnementen en facturering
Verkoop, wijzig en beëindig de abonnementen van je klanten, en houd bij wat er op je kaart in rekening wordt gebracht.
Elke klantworkspace kan één abonnement hebben op een tier die je verkoopt. Je resellerkaart betaalt de facturen van elke workspace. Het huidige abonnement van een workspace staat in het veld subscription van workspaces.list, samen met has_payment_issue.
Wijs een abonnement toe
Abonneer een workspace die nog geen abonnement heeft. billing_period is monthly_period (de standaardwaarde) of annual_period.
Stuur bij elke toewijzing of wijziging een zelf gegenereerde idempotency_key. Als een request een time-out krijgt, kun je deze met dezelfde sleutel opnieuw proberen zonder dat de workspace twee keer wordt geabonneerd of belast.
Het toewijzen of wijzigen van een abonnement wordt geweigerd zolang has_payment_issue true is. Toon de onbetaalde factuur aan je klant, of betaal deze via de bijbehorende pay_url, voordat je het opnieuw probeert.
Wijzig een abonnement
subscriptions.change gebruikt dezelfde body als assign.
- Een upgrade gaat onmiddellijk in.
- Een downgrade of overstap naar een tier op hetzelfde niveau gaat in aan het einde van de factureringsperiode. Tot die tijd toont het abonnement de nieuwe tier in
pending_downgrade_tieren de datum inpending_downgrade_at_unix.
Om de workspace op de huidige tier te houden, verwijder je de geplande downgrade met subscriptions.cancel_pending_downgrade.
Wanneer een downgrade ingaat, worden receptionistes en telefoonnummers boven de limieten van het nieuwe abonnement gedeactiveerd, en worden teamleden boven de teamgrootte ervan geschorst.
Beëindig een abonnement
subscriptions.unassign beëindigt het abonnement aan het einde van de huidige factureringsperiode. Tot die tijd toont cancel_at_unix wanneer het eindigt, en met subscriptions.restore maak je de annulering ongedaan zodat het abonnement normaal wordt verlengd.
Facturen
Elke afschrijving op je kaart betaalt de factuur van één workspace. billing.list_invoices retourneert deze van nieuw naar oud, één pagina tegelijk. De status van een factuur is een van de volgende:
billing.get_invoice voegt de lines van de factuur toe. Een regel met een negatieve amount_cents is een verrekeningscredit en de regels tellen altijd op tot de afschrijving.
Aankomende betalingen
billing.list_upcoming_payments schat de volgende verlenging van elke workspace, met de eerstvolgende bovenaan. plan_usd is het abonnement dat vooraf bij de verlenging in rekening wordt gebracht: bij een geplande downgrade is dit de prijs van de downgraded tier. overage_so_far_usd is het gebruik in deze periode boven de inbegrepen minuten tot nu toe. Dit wordt bij de verlenging in rekening gebracht en blijft tot dan oplopen.