Docs

Get Billing

GET /billing

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

FieldTypeDescription
trialEligibleboolean
customerGetBillingResponseCustomerInfo
subscriptionsGetBillingResponseSubscriptionInfo[]| null
invoiceLicensesGetBillingResponseLicenseInfo[]| null
invoicesGetBillingResponseInvoiceInfo[]| null
bankVerificationGetBillingResponseBankVerificationInfo

GetBillingResponseCustomerInfo

FieldTypeDescription
defaultPaymentMethodIdstring| null
emailstring| null
namestring| null
billingAddressGetBillingResponseCustomerInfoBillingAddressInfo

GetBillingResponseSubscriptionInfo

FieldTypeDescription
idstring| null
statusstring| null
currentPeriodEnddate-time| null
cancelAtPeriodEndboolean
nextRenewalinteger| null
upcomingRenewalGetBillingResponseResumeRenewalInfo
resumeRenewalGetBillingResponseResumeRenewalInfo
currencystring| null
discountsGetBillingResponseDiscountInfo[]| null
licensesGetBillingResponseLicenseInfo[]| null

GetBillingResponseLicenseInfo

FieldTypeDescription
iduuid
namestring| null
productNamestring| null
statusstring| null
seatsinteger
seatsUsedinteger
isCoreboolean
isManagedboolean
isExhaustedboolean
isMultiEventboolean
paymentTypestring| null
expirydate-time| null
invoiceNumberstring| null

GetBillingResponseInvoiceInfo

FieldTypeDescription
invoiceIdstring| null
invoiceNumberstring| null
invoiceStatusstring| null
invoiceDatedate-time
amountPaidinteger
invoicePdfUrlstring| null
hostedInvoiceUrlstring| null

GetBillingResponseBankVerificationInfo

FieldTypeDescription
hostedVerificationUrlstring| null
arrivalDatedate-time| null

GetBillingResponseCustomerInfoBillingAddressInfo

FieldTypeDescription
line1string| null
line2string| null
citystring| null
statestring| null
postalCodestring| null
countrystring| null

GetBillingResponseResumeRenewalInfo

FieldTypeDescription
linesGetBillingResponseRenewalLine[]| null
otherinteger
discountinteger
taxinteger
totalinteger

GetBillingResponseDiscountInfo

FieldTypeDescription
percentOffnumber| null
amountOffinteger| null
currencystring| null
endsAtdate-time| null

GetBillingResponseRenewalLine

FieldTypeDescription
licenseIduuid
amountinteger