Billing
Billing contains subscription, payment, and credit information for an Organisation. It includes the plan type, payment system, document send credits, user limits, and invoice history.
Accessed via Organisation.billing (requires billing permission).
Implements: Node
Fields
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier |
customerName | String! | Company name |
address1 | String | Address line 1 |
address2 | String | Address line 2 |
address3 | String | Address line 3 |
address4 | String | Address line 4 |
address5 | String | Address line 5 |
postcode | String | Postal code |
created | AWSDateTime | When billing was created |
modified | AWSDateTime | When billing was last modified |
cancelledAt | AWSDateTime | Cancellation date (past = cancelled, future = scheduled) |
billingContactEmail | AWSEmail | Primary billing contact |
billingContactEmailCc | AWSEmail | CC for billing emails |
technicalContactEmail | AWSEmail | Technical contact for error alerts |
taxRate | Float | Tax rate (e.g. 0.2 for UK VAT) |
attachInvoiceToEmails | Boolean | Attach PDF invoice to emails |
invoiceCreditDays | Int | Days to pay invoice (for invoice payment systems) |
docSendCredit | Int | Document send credit |
bulkSendCredit | Int | Bulk send credit |
userLimit | Int | Maximum users allowed (null = unlimited) |
userCount | Int | Current active user count |
alertCount | Int | Threshold for low credit alert emails |
libraryLimit | Int | Maximum templates allowed (null = unlimited) |
groupLimit | Int | Maximum groups allowed (null = unlimited) |
planName | PLANS | Subscription plan (e.g. TEAM, BUSINESS, ENTERPRISE) |
paymentSystem | PAYMENTSYSTEM | Payment method (STRIPE, GOCARDLESS, INVOICEMONTHLY, etc.) |
currency | CURRENCY | GBP, EURO, or USD |
Connections
invoiceConnection
Invoice history. Supports cursor-based pagination.
| Argument | Type | Description |
|---|---|---|
first | Int | Number of items |
after | ID | Pagination cursor |
Query
Billing is accessed through the Organisation:
query GetBilling($orgId: ID) {
organisation(id: $orgId) {
billing {
planName
paymentSystem
currency
docSendCredit
userLimit
userCount
}
}
}
Example
Full billing query with invoice history (based on the Legalesign Console app):
query GetBillingDetails($orgId: ID) {
organisation(id: $orgId) {
billing {
customerName
address1
address2
address3
address4
address5
postcode
created
modified
cancelledAt
billingContactEmail
billingContactEmailCc
technicalContactEmail
taxRate
attachInvoiceToEmails
invoiceCreditDays
docSendCredit
userCount
userLimit
alertCount
libraryLimit
groupLimit
planName
paymentSystem
currency
invoiceConnection {
invoices {
id
created
supplyDate
currency
invoiceNumber
taxRate
subTotal
totalIncTax
creditReason
customerName
}
}
}
}
}
Related
- Organisation — the parent organisation
- Invoice — individual invoices