Individual invoices

Returned variables

Variable nameDescription
invoiceIdThe unique identifier of the invoice in Billsby
customerEmailThe customer's registered email address
customerFirstNameThe customer's first name
customerLastNameThe customer's last name
customerUniqueIdThe alphanumeric unique identifier of the customer in the Billsby platform
addressLine1First line of the address
addressline2Second line of the address
addressPostCodeCustomer's postcode
addressCityCustomer's city
addressStateCustomer's state
addressCountryCustomer's country
addressCountryCodeCustomer's country iso-3 code
invoiceNumberThe unique ID for invoices
createdOnThe date on which the customer account was created
formattedAmountThe formatted amount of the invoice (i.e. £10 will show as 10.00)
amountThe amount of the invoice shown without decimals (i.e. £10 will show as 1000)
currencyThe currency the invoice was issued in
statusThe status of the customer; active or inactive
prorationAdjustmentThe formatted amount of the proration (i.e. £10 will show as £10.00). This value can also be null.
prorationFactorThe percentage amount of the proration represented as a value between 0.0 and 1.0 (where 0.0 represents 0% and 1.0 represents 100%). This value can also be null.
subTotalTotal value of the invoice
taxTotalTotal value of tax associated with the invoice
taxesTaxes applied to the subscription
invoiceTypeFour types of invoice:
- Renewal
- OneTimeCharge
- Refund
- OneTimeCredit
subscriptionUniqueIdThe uniques identifier of the subscription in the Billsby platform amount
planNameThe name of the plan
billingPeriodStartStart date of the billing period
billingPeriodEndEnd date of the billing period
unitsThe number of units included in the subscription
companyNameName of the company
companyEmailEmail of the company
companyTaxNumberTax number set-up in your Billsby tax configuration.
companyDomainDomain name set-up when creating your Billsby account.
companyPhoneNumberDialCountryCompany number dial country (eg United Kingdom)
companyPhoneNumberDialCodeCompany number dial code (eg 0044)
companyPhoneNumberCompany's phone number
companyAddressLine1First line of the company's address
companyAddressLine2Second line of the company's address
companyCityCompany's city
companyStateCompany's state
companyPostCodeCompany postcode
companyCountryCompany's country
brandingLogo
brandingLogoBackgroundColor
brandingHighlightColor
Branding settings configured in Billsby
supportUrlSupport URL on the invoice
cardTypeType of card
cardLast4DigitsLast 4 digits of the Card Number
cardExpiryMonthExpiry month of the Card Number
cardExpiryYearExpiry year of the Card Number
refundableAmountThe amount that is currently refundable on the invoice. So if the invoice amount is £10 and £5 has already been refunded, this will be £5 and will show as 500.
footerCompanyName
footerAddressLine1
footerAddressLine2
footerAddressState
footerAddressCity
footerAddressPostCode
footerAddressCountryISO3
footerEmailAddress
footerPhoneNumberDialCountry
footerPhoneNumberDialCode
footerPhoneNumber
Company information that is located on the footer of the invoice
supportContactHeading
supportContactContent
supportContactSupportUrl
supportContactSupportUrlButtonText
Company support contact information that is located on the invoice.
isAdvertEnabled
advertImageUrl
advertLinkToUrl
Advertisement enablement and details on the invoice.
Language
Authentication
Header
Click Try It! to start a request and see the response here!