API reference
billing
54 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| DELETE | /v1/accounting/xero | Disconnect this organization's Xero. | billing.invoice.manage |
| GET | /v1/accounting/xero | This organization's connection to its own Xero. | billing.view |
| PATCH | /v1/accounting/xero | Change what a connection syncs. | billing.invoice.manage |
| POST | /v1/accounting/xero/connect | Begin connecting this organization's Xero. | billing.invoice.manage |
| GET | /v1/accounting/xero/invoices | Which of this organization's invoices are in its Xero. | billing.view |
| GET | /v1/accounting/xero/oauth/callback | Where Xero returns the customer after they authorize us. | No API key |
| POST | /v1/accounting/xero/sync | Push outstanding invoices to Xero now. | billing.invoice.manage |
| GET | /v1/billing/adhoc-charges | The manual charges on your account, and what you have been billed. | billing.view |
| GET | /v1/billing/payment-preferences | How this account intends to pay. | billing.view |
| PUT | /v1/billing/payment-preferences | Elect (or stop) paying by crypto. | billing.payment.manage |
| GET | /v1/billing/profile | Get the organization's billing profile. | billing.view |
| PUT | /v1/billing/profile | Replace the organization's billing profile. | billing.invoice.manage |
| GET | /v1/catalog/plan-moves | For a product line I am already on, which plans can I move to? | billing.view |
| GET | /v1/cdn/credit | The account's prepaid metered-CDN balance, spend cap and top-up settings. | billing.view |
| PATCH | /v1/cdn/credit | Set the spend cap, or turn auto-top-up on or off. | billing.payment.manage |
| GET | /v1/entitlements | What this organization's plan grants, and how much of it is used. | billing.view |
| GET | /v1/first-run | Every product this organization holds, with its one next step and whether it is done. | sites.view |
| GET | /v1/invoices | List the organization's billing documents. | billing.view |
| GET | /v1/invoices/{invoiceId} | Get one billing document. | billing.view |
| GET | /v1/invoices/{invoiceId}/pdf | Download the invoice or credit note as a PDF, in a chosen language. | billing.view |
| GET | /v1/payment-methods | List the stored payment methods in scope. | billing.view |
| POST | /v1/payment-methods | Begin adding a payment method (on-session). | billing.payment.manage |
| POST | /v1/payment-methods/paypal | Begin saving a PayPal account as a payment method. | billing.payment.manage |
| POST | /v1/payment-methods/paypal/confirm | Finish saving a PayPal account after the buyer approved it. | billing.payment.manage |
| DELETE | /v1/payment-methods/{paymentMethodId} | Revoke a stored payment method. | billing.payment.manage |
| PATCH | /v1/payment-methods/{paymentMethodId} | Nominate a stored payment method as primary or backup. | billing.payment.manage |
| POST | /v1/pricing/tax-quote | What these net prices look like to this customer, after VAT. | Any API key |
| GET | /v1/pro-discounts | Your hosting-customer discount on every Pro plugin, and your code for each. | billing.view |
| POST | /v1/pro-discounts/{product}/code | Your personal code for one Pro plugin — created on first ask, the same one after. | billing.view |
| GET | /v1/sla/claims | The service credits already issued to this organisation. | billing.view |
| POST | /v1/sla/claims | Claim the service credit for one monitored site's month. | sla.claim |
| GET | /v1/sla/periods | Recent months for every monitored site, and what may be claimed. | billing.view |
| GET | /v1/sla/policy | The published uptime commitment and its service-credit ladder. | Any API key |
| GET | /v1/subscriptions | List the organization's subscriptions. | billing.view |
| POST | /v1/subscriptions/{subscriptionId}/auto-renew | Turn a subscription's renewal on or off. | billing.payment.manage |
| POST | /v1/subscriptions/{subscriptionId}/billing-rail | Choose which clock charges this subscription. | billing.payment.manage |
| GET | /v1/subscriptions/{subscriptionId}/crypto-auto-renew | Read this subscription's crypto auto-renew choice. | billing.payment.manage |
| PUT | /v1/subscriptions/{subscriptionId}/crypto-auto-renew | Turn crypto auto-renew on or off for this subscription. | billing.payment.manage |
| GET | /v1/subscriptions/{subscriptionId}/plan | List the plans this subscription could move to, priced. | billing.view |
| POST | /v1/subscriptions/{subscriptionId}/plan | Move a subscription onto a bigger or smaller plan. | billing.payment.manage |
| POST | /v1/subscriptions/{subscriptionId}/prepay | Create the order to pay for several billing periods at once. | billing.payment.manage |
| GET | /v1/subscriptions/{subscriptionId}/prepay-quote | Price paying for several billing periods at once. | billing.payment.manage |
| GET | /v1/trials | This organization's free trial, if it has one. | billing.view |
| POST | /v1/trials | Start a free trial on a plan. | billing.view |
| GET | /v1/trials/eligibility | Can this organization start a trial on this plan, and on what terms? | billing.view |
| GET | /v1/trials/lines | Every hosting line's free trial, and this organization's state on each. | billing.view |
| GET | /v1/trials/winback | The one-time 7-day extension this account may take on its ended free trial, or null. | billing.view |
| POST | /v1/trials/winback | Take the one-time 7-day extension — the ended trial runs again for 7 days. | billing.view |
| POST | /v1/trials/{trial_id}/switch | Switch a running free trial to another product, keeping its end date. | billing.view |
| GET | /v1/usage/visits | Get the organisation's metered visits and any overage charge. | billing.view |
| POST | /v1/webhooks/nowpayments | Ingest a signed NOWPayments IPN. | No API key |
| POST | /v1/webhooks/nowpayments/renewals/{autoRenewId} | Ingest a signed NOWPayments IPN for a crypto auto-renew payment. | No API key |
| POST | /v1/webhooks/paypal | Ingest a signed PayPal webhook event. | No API key |
| POST | /v1/webhooks/stripe | Ingest a signed Stripe webhook event. | No API key |