GET/billing
Returns the organization's billing summary: subscriptions with their licenses, invoice-paid licenses, the
customer's default payment method, and trial eligibility. Amounts are in cents. On each subscription,
cancelAtPeriodEnd is Stripe's flag (resume eligibility reads it, not the license status), currentPeriodEnd is
when access ends if canceling, nextRenewal is the next invoice total (null while canceling, and on a
trial with no payment method, which ends at trial end), upcomingRenewal is that renewal itemized and resumeRenewal is the renewal a resume would restart (only while canceling or while a
pass removal is scheduled). A subscription's status and an invoice's status
are Stripe's own values. A license's status is Trial, Active, PastDue (a payment failed and Stripe is retrying;
fix it with PaymentMethods_SetDefaultPaymentMethod), Canceled (ends at expiry; undo with
Licenses_ResumeLicense) or Expired (no longer grants access); every status but Expired grants access. A license's
paymentType is Subscription or Invoice (invoice licenses end on their own expiry), isManaged licenses are
managed by BackOps and cannot be changed here, and isExhausted means every seat is used. A non-null
bankVerification is a bank account still waiting on microdeposits, so the trial must not be bought again, and
trialEligible is false once any subscription has had a trial. Requires OrganizationAdmin.
Response
| Field | Type | Description |
|---|
| trialEligible | boolean | |
| customer | GetBillingResponseCustomerInfo | |
| subscriptions | GetBillingResponseSubscriptionInfo[]| null | |
| invoiceLicenses | GetBillingResponseLicenseInfo[]| null | |
| invoices | GetBillingResponseInvoiceInfo[]| null | |
| bankVerification | GetBillingResponseBankVerificationInfo | |
GetBillingResponseCustomerInfo
| Field | Type | Description |
|---|
| defaultPaymentMethodId | string| null | |
| email | string| null | |
| name | string| null | |
| billingAddress | GetBillingResponseCustomerInfoBillingAddressInfo | |
GetBillingResponseSubscriptionInfo
| Field | Type | Description |
|---|
| id | string| null | |
| status | string| null | |
| currentPeriodEnd | date-time| null | |
| cancelAtPeriodEnd | boolean | |
| nextRenewal | integer| null | |
| upcomingRenewal | GetBillingResponseResumeRenewalInfo | |
| resumeRenewal | GetBillingResponseResumeRenewalInfo | |
| currency | string| null | |
| discounts | GetBillingResponseDiscountInfo[]| null | |
| licenses | GetBillingResponseLicenseInfo[]| null | |
GetBillingResponseLicenseInfo
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| productName | string| null | |
| status | string| null | |
| seats | integer | |
| seatsUsed | integer | |
| isCore | boolean | |
| isManaged | boolean | |
| isExhausted | boolean | |
| isMultiEvent | boolean | |
| paymentType | string| null | |
| expiry | date-time| null | |
| invoiceNumber | string| null | |
GetBillingResponseInvoiceInfo
| Field | Type | Description |
|---|
| invoiceId | string| null | |
| invoiceNumber | string| null | |
| invoiceStatus | string| null | |
| invoiceDate | date-time | |
| amountPaid | integer | |
| invoicePdfUrl | string| null | |
| hostedInvoiceUrl | string| null | |
GetBillingResponseBankVerificationInfo
| Field | Type | Description |
|---|
| hostedVerificationUrl | string| null | |
| arrivalDate | date-time| null | |
GetBillingResponseCustomerInfoBillingAddressInfo
| Field | Type | Description |
|---|
| line1 | string| null | |
| line2 | string| null | |
| city | string| null | |
| state | string| null | |
| postalCode | string| null | |
| country | string| null | |
GetBillingResponseResumeRenewalInfo
| Field | Type | Description |
|---|
| lines | GetBillingResponseRenewalLine[]| null | |
| other | integer | |
| discount | integer | |
| tax | integer | |
| total | integer | |
GetBillingResponseDiscountInfo
| Field | Type | Description |
|---|
| percentOff | number| null | |
| amountOff | integer| null | |
| currency | string| null | |
| endsAt | date-time| null | |
GetBillingResponseRenewalLine
| Field | Type | Description |
|---|
| licenseId | uuid | |
| amount | integer | |