v1
latestOpenAPI 3.1.02026-07-26580123.9 KBIndividual invoices
get/invoices/{invoiceNumber}
Path parameters
invoiceNumberstring required
The invoice number for the invoice you'd like to retrieve
Response
200
Example response
{
"invoiceId": "0",
"customerEmail": "mary.rose@msn.com",
"customerFirstName": "Mary",
"customerLastName": "Rose",
"customerUniqueId": "8MJ7XU07D9",
"addressLine1": "31 Long Avenue",
"addressLine2": "Rickmansworth",
"addressPostCode": "HA94WD",
"addressCity": "Buckinghamshire",
"addressState": "Buckinghamshire",
"addressCountry": "United Kingdom",
"addressCountryCode": "GBR",
"invoiceNumber": "0WX1VTRPWY-1",
"createdOn": "2020-04-29T00:14:57.297Z",
"formattedAmount": "9",
"amount": "10",
"currency": "gbp",
"status": "active",
"subTotal": "400",
"taxTotal": "200",
"prorationAdjustment": "£0",
"invoiceType": "renewal",
"subscriptions": [
{
"subscriptionUniqueId": "Y4EDK80W71",
"planName": "premium",
"billingPeriodStart": "2020-04-29T00:14:57.297Z",
"billingPeriodEnd": "2020-04-29T00:14:57.297Z",
"subscriptionItems": [
{
"description": "test",
"units": "3",
"unitPrice": "2",
"discounts": "1",
"amount": "7"
}
]
}
],
"companyName": "flowers",
"companyEmail": "flowers@flowers.com",
"companyTaxNumber": "12345678",
"companyDomain": "flowers",
"companyPhoneNumberDialCountry": "0044",
"companyPhoneNumberDialCode": "0044",
"companyPhoneNumber": "02088671028",
"companyAddressLine1": "wework, 1 fore street",
"companyAddressLine2": "moorgate",
"companyCity": "london",
"companyState": "london",
"companyPostCode": "ec2y9dt",
"companyCountry": "united kingdom",
"brandingLogo": "logo.jpg",
"brandingLogoBackgroundColor": "black",
"brandingHighlightColor": "pink",
"supportUrl": "support@flowers.co.uk",
"cardType": "mastercard",
"cardLast4Digits": "8972",
"cardExpiryMonth": "07",
"cardExpiryYear": "23",
"refundableAmount": "10",
"footerCompanyName": "flowers",
"footerAddressLine1": "wework, 1 fore street",
"footerAddressLine2": "moorgate",
"footerAddressState": "moorgate",
"footerAddressCity": "london",
"footerAddressPostCode": "ec2y9dt",
"footerAddressCountryISO3": "united kingdom",
"footerEmailAddress": "flowers@flowers.com",
"footerPhoneNumberDialCountry": "0044",
"footerPhoneNumberDialCode": "0044",
"footerPhoneNumber": "02088671028",
"supportContactHeading": "support",
"supportContactContent": "mary rose",
"supportContactSupportUrl": "support@flowers.com",
"supportContactSupportUrlButtonText": "support",
"isAdvertEnabled": "true",
"advertImageUrl": "advert.com",
"advertLinkToUrl": "advert.com"
}