Skip to main content

get invoice

GET 
/org/:orgId/invoice/:invoiceId

Get the invoice by ID

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    invoiceId stringrequired

    Invoice ID

Responses​

OK

Schema

    buyerID string

    Possible values: <= 36 characters

    creationTime date-time
    endDate date-time
    entitlementID string

    Possible values: <= 36 characters

    id string

    Possible values: <= 36 characters

    info

    object

    addFixedFees

    object[]

    Adjust charge fields The fixed fees to be added to the invoice.

  • Array [

    • endDate date-time
    quantity integer
    rate number
    reason string
    startDate date-time

  • ]

    • addonDetail

    object

    amount number
    chargeOn date-time
    description string
    id string
    name string

    adjustDiscountByDimensions

    object[]

    add or adjust discount for a specific dimension

  • Array [

    • dimensionKey string

    discount

    object

    discountType BillingDiscountType (string)

    Possible values: [PERCENTAGE, ABSOLUTE]

    value number
    reason string

  • ]

    • adjustMinimumSpendByDimensions

    object[]

    add or adjust minimum spend for a specific dimension

  • Array [

    • dimensionKey string
    minimumSpend number
    reason string

  • ]

    • adjustOverallDiscount

    object

    discount

    object

    discountType BillingDiscountType (string)

    Possible values: [PERCENTAGE, ABSOLUTE]

    value number
    reason string

    adjustOverallMinimumSpend

    object

    minimumSpend number
    reason string

    billableDimensionDetails

    object[]

  • Array [

    • amount number

    Amount is the amount that is calculated based on the FeeExpression

    billableMetricKey

    object

    groupBysExpression string

    GroupBysExpression is string expression of array of group bys.

    id string

    ID is billableMetric ID (Key)

    category PriceModelCategory (string)

    Possible values: [basic, tiered, bulk, volume, percentage, tiered-percentage, matrix]

    details

    object[]

    Details is the details of the pricing model that is used to show what the amount is for.

  • Array [

    • descriptions string

    Description of the pricing model that is used to show what the amount is for. like 'Bulk pricing: 0-100 units', 'Tiered pricing: 0-100 units'

    feeExpressions string

    FeeExpression is the expression used to calculate the fee that is used to show how the amount is calculated. like '211 × $0.03'

  • ]

    • discount

    object

    discountType BillingDiscountType (string)

    Possible values: [PERCENTAGE, ABSOLUTE]

    value number
    discountExpression string

    DiscountExpression is the expression used to calculate the discount that is used to show how the discount is calculated.

    isTrial boolean

    Flag to indicate if this period is a trial period.

    minimumCommit number

    MinimumCommit is the minimum commit amount that is used to show the minimum commit amount. Will be ignored if the value is 0 or less.

    minimumCommitScope BillingMinimumCommitScope (string)

    Possible values: [``, DIMENSION, DIMENSION_GROUP_BY]

    name string

    Name of this billable dimension.

    quantity number

    Final quantity of the billable dimension in the invoice period, which calculates the fee in price model. It may be the sum value of count/sum/unique_count or latest/max value according to different aggregation type.

  • ]

    • commitsRevenueDetails

    object[]

    Recurring flat fee for the invoice. There should be only one type fee for each invoice, commits, or usage.

  • Array [

    • amount number

    The total amount of the commit revenue.

    description string
    expression string
    key string
    name string
    quantity integer

    The quantity of the commit dimension. Default is 1.

    rate number

    The unit price of the commit dimension.

  • ]

    • creationDate date-time

    The creation date of the invoice when the status of the invoice may be draft or issued. It may be different from the issue date.

    currency string
    deductedCommitAmount number

    The amount of the committed amount that has been deducted from the usage. It works only when IsMeteringOverageCommit is true.

    deductedCommitInvoiceID string

    The ID of the commit invoice that has been deducted from the usage. It works only when IsMeteringOverageCommit is true.

    description string
    dueAmount number

    Due amount = SubtotalAmount + TaxAmount - AdjustOverallDiscount

    dueDate date-time

    DueDate = IssueDate + NetTerm

    gracePeriodInDays integer

    Grace Period in number of days

    isMeteringOverageCommit boolean

    Whether the usage metering is charged for the amount that exceeds the committed amount from the entitlement.

    issueDate date-time

    IssueDate, issue invoice automatically when CreationDate + GracePeriod, or issue invoice manually IssueDate >= CreationDate && IssueDate <= CreationDate + GracePeriod

    memo string
    netTermsInDays integer

    Net Terms period in number of days

    paymentInstallmentsDetail

    object

    amount number
    chargeOn date-time
    description string
    periodTotalDays integer

    PeriodTotalDays is the total number of days among the whole periods. e.g. 61 days for a 2-month invoice.

    receiptUrl string

    Invoice receipt url, it only exists when there are transactions.

    spaUrl string

    SPA url with JWT.

    subtotalAmount number

    Subtotal amount calculated from the user usage.

    taxAmount number
    trialPeriodInDays integer

    Trial period in number of days

    usageDailyRevenues

    object[]

    Billable dimension fees for the invoice.

  • Array [

    • billableMetricKey

    object

    groupBysExpression string

    GroupBysExpression is string expression of array of group bys.

    id string

    ID is billableMetric ID (Key)

    date string
    quantity number

    uniquePropertyItems

    object

    property name* any

  • ]

    • invoiceURL string

    The invoice file URL, provided as AWS S3 presigned URL with expiration time. Output only.

    lastUpdateTime date-time
    organizationID string
    paymentStatus BillingPaymentStatus (string)

    Possible values: [PENDING, PROCESSING, SUCCESS, FAILED]

    startDate date-time
    status BillingInvoiceStatus (string)

    Possible values: [DRAFT, FINALIZED, CANCELED, DELETED, ``]

    type BillingInvoiceType (string)

    Possible values: [COMMIT, USAGE, ADDON, INSTALLMENT]

Loading...