Ga naar inhoud

Abonnementen

Accountscope vereist; voeg de header X-Auth-Account toe met je Account-ID. Scope: billing:read.

Abonnementen opvragen

Dit geeft momenteel alle actieve of opgeschorte abonnementen terug.

GET /api/subscriptions

sites toont alleen actieve WordPress-sites. Domeinen, mail en cPanel-hosting worden op hun eigen abonnement gefactureerd en geven sites: [] terug; gebruik product om ze uit elkaar te houden. Voor verwijderde sites gebruik je Sites opvragen.

Params (optioneel)
  • page: Integer | paginanummer (standaard: 1)
  • per_page: Integer | records per pagina (standaard: 50, max: 100)
Teruggegeven params
  • subscriptions: Array
    • id: String
    • status: String
    • created_at: DateTime
    • updated_at: DateTime
    • price: Object
      • amount_cents: Integer
      • term: String
    • run_rate: Object | verouderd, gebruik annual_run_rate. De hostingprijs voor één termijn, als money-object; 0 voor domeinen en mail
      • cents: Integer
      • currency_iso: String | uit het facturatieplan van het account
    • annual_run_rate: Object | de jaarlijkse kosten tegen de huidige catalogusprijs, voor hosting, domeinen en mail. Promotiecodes worden niet toegepast
      • cents: Integer
      • currency_iso: String
    • sites: Array
      • id: String
      • name: String
      • created_at: DateTime
      • updated_at: DateTime
      • primary_domain: String
      • location: String
      • package: String
      • dunning_suspended: Boolean
      • pending_delete: Boolean | hier altijd false — sites die op verwijdering wachten, zitten niet in sites
      • delete_scheduled_at: DateTime | hier altijd null, om dezelfde reden
    • product: Object
      • id: String
      • name: String

Abonnement bekijken

GET /api/subscriptions/:id

Teruggegeven params
  • subscription: Object
    • id: String
    • status: String
    • created_at: DateTime
    • updated_at: DateTime
    • price: Object
      • amount_cents: Integer
      • term: String
    • run_rate: Object | verouderd, gebruik annual_run_rate. De hostingprijs voor één termijn, als money-object; 0 voor domeinen en mail
      • cents: Integer
      • currency_iso: String | uit het facturatieplan van het account
    • annual_run_rate: Object | de jaarlijkse kosten tegen de huidige catalogusprijs, voor hosting, domeinen en mail. Promotiecodes worden niet toegepast
      • cents: Integer
      • currency_iso: String
    • sites: Array
      • id: String
      • name: String
      • created_at: DateTime
      • updated_at: DateTime
      • primary_domain: String
      • location: String
      • package: String
      • dunning_suspended: Boolean
      • pending_delete: Boolean | hier altijd false — sites die op verwijdering wachten, zitten niet in sites
      • delete_scheduled_at: DateTime | hier altijd null, om dezelfde reden
    • product: Object
      • id: String
      • name: String

Komende kosten

Wat er op de volgende factuur van de workspace komt. Vereist X-Auth-Account en de scope billing:read.

GET /api/billing/upcoming_charges

Wat je krijgt hangt af van je rol:

  • Een facturatiebeheerder van de facturatieworkspace (degene die betaalt) ziet de kosten van elke workspace die via die workspace wordt gefactureerd, plus headroom en payment.
  • Een facturatiebeheerder van een workspace die via een andere wordt gefactureerd ziet alleen de eigen regels van die workspace. headroom en payment zijn null en warnings is leeg.
  • Anderen krijgen 403 not_authorized.
Teruggegeven params
  • currencies: Array | één item per valuta met kosten, gesorteerd op valuta
    • currency: String
    • subtotal_cents: Integer | het netto van lines en credits samen
    • tax_estimate_cents: Integer | alleen lines en credits; regels waarvan de prijs al btw bevat tellen niet mee
    • total_cents: Integer
    • estimated_invoice_on: String | datum, of null als estimate_reason after_setup is
    • estimate_reason: String | now (er wordt nu een factuur aangemaakt), bank_transfer, payment_method_missing, next_run (gefactureerd bij de volgende geplande run) of after_setup (er is nog niets klaar om te factureren)
    • sections: Object
      • lines: Array | kosten op de volgende factuur
      • credits: Array | tegoeden op de volgende factuur
      • waiting: Array | kosten die wachten tot hun bestelling klaar is met instellen
      • under_review: Array | kosten die ter controle zijn vastgehouden
      • invoicing_now: Array | kosten die al op een factuur staan die wordt aangemaakt
  • headroom: Object | null tenzij je de facturatieworkspace ziet, of als de workspace nu niet op factuur kan bestellen
    • currency: String
    • available_cents: Integer | de ruimte die nog over is om op factuur te bestellen, nooit lager dan 0
  • payment: Object | null in de weergave van een onderliggende workspace
    • mode: String | card of bank_transfer
    • default_payment_method_present: Boolean
    • payable_days: Integer | dagen om een factuur te betalen; null bij card
  • warnings: Array<String> | payment_method_missing: een kaartbetaler heeft kosten om te factureren en geen standaardbetaalmethode

Elk item in een sections-array heeft deze structuur. Alleen lines en credits tellen mee in de totalen.

Kostenregel
  • account: Object | de workspace waartoe de kosten behoren
    • id: String
    • name: String
  • description: String
  • currency: String
  • amount_cents: Integer | negatief bij een tegoed
  • discount_cents: Integer
  • net_cents: Integer | amount_cents min discount_cents
  • tax_estimate_cents: Integer
  • tax_behavior: String | null als die niet is ingesteld
  • quantity: Integer
  • period_start: DateTime
  • period_end: DateTime
  • order_id: String
  • kind: String | order_line, seat_change, seat_credit, early_cancellation of reversal
  • state: String | pending, of batching in invoicing_now
  • created_at: DateTime
Fouten
  • 400 missing_account | geen X-Auth-Account
  • 403 not_authorized | je bent geen facturatiebeheerder van deze workspace