OCT-103 Gumlet outreach
GET/mixed/billing/invoice/upcoming

Get upcoming invoice details

Retrieves invoice details for the upcoming billing period. Use this endpoint to review current-month usage, invoice dates, and the upcoming invoice amount and line items. The response also includes the trial end date when one applies.

5 status codes
200Returns the invoice start and end dates, next invoice date, current-month usage, upcoming invoice subtotal and line items, and trial end date when applicable.
current_month_usagestringrequired

Current month total amount in given currency. This amount includes taxes.

invoice_last_datestringrequired

Invoice end date in DD MMM YYYY format

invoice_start_datestringrequired

Invoice start date in DD MMM YYYY format

next_invoice_datestringrequired

Next invoice date in DD MMM format

trial_end_datestringoptional

Trial end date

upcoming_invoiceobjectrequired

Upcoming invoice details

400Returned when the account has no active subscription.

One documented failure

  • no_active_subscription

    No active subscription found for this user.

errorobjectrequired
401Returned when the request omits or supplies an invalid API key or bearer token.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
500Returned when an internal server error occurs.

One documented failure

  • internal_server_error

    We have encountered some server error. We have been notified and will fix it soon.

errorobjectrequired

Error handling

A 400 is returned when there is no active subscription. A 401 is returned when the request omits or supplies an invalid API key or bearer token. A 403 is returned for an unpaid account or insufficient role permissions, and a 500 indicates an internal server error. Ensure the account has an active subscription and provide valid authentication credentials.