Skip to main content

Get upcoming invoice​

Get the upcoming invoice of a billing account.

Path Parameters
    org_id string required
    billing_id string required

    ID of the billing account to get the upcoming invoice for

Responses

A successful response.

Schema
    invoice object
    id string
    customer_id string
    provider_id string
    state string
    currency string
    amount int64
    hosted_url string
    due_date date-time
    effective_at date-time

    The date when this invoice is in effect.

    period_start_at date-time
    period_end_at date-time
    metadata object
    created_at date-time
    customer object
    id string
    org_id string
    name string
    email string
    phone string
    address object
    line1 string
    line2 string
    city string
    state string
    postal_code string
    country string
    provider_id string
    provider string
    currency string
    state string
    tax_data object[]
  • Array [
    • type tax type like "vat", "gst", "sales_tax" or if it's provider specific us_ein, uk_vat, in_gst, etc
    id unique identifier provided by the tax agency
  • ]
    • metadata object
    created_at date-time
    updated_at date-time
    organization object
    id string
    name string
    title string
    metadata object
    created_at date-time

    The time the organization was created.

    updated_at date-time

    The time the organization was last updated.

    state string

    The state of the organization (enabled or disabled).

    avatar string

    The base64 encoded image string of the organization avatar. Should be less than 2MB.

GET /v1beta1/organizations/:org_id/billing/:billing_id/invoices/upcoming

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
org_id — path required
billing_id — path required
curl / cURL
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/:billing_id/invoices/upcoming' \
-H 'Accept: application/json'