Returns a specified invoice

GET 
/v1/tenants/:tenantUid/invoices/:invoiceUid

Returns a specified invoice

Request

Path Parameters

tenantUid stringrequired

Specify the tenant uid

invoiceUid stringrequired

Specify the invoice uid

Responses

200

(empty)

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

spec

Invoice specification

address

object

Tenant Address

addressLine1string

addressLine2string

citystring

countrystring

pincodestring

statestring

billingPeriod

Invoice billing period object

enddate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

startdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

credits

Invoice credits object

alloyFreeCreditsint64

Credits allocated for import clusters

pureFreeCreditsint64

Credits allocated for managed clusters

envTypestring

Environment type [Trial,MonthlyOnDemand,AnnualSubscription,OnPrem]

monthdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

paymentUnitstring

Possible values: [usd]

plan

Invoice plan object

freeCredits

undefined[]

List of free credits

Array [

planCredit

Plan Credit

cpuCoreHoursint64

creditUidstring

expirydate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

startdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

typestringrequired

Possible values: [Pure, Alloy]

totalCpuCoreHoursint64

Total used cpu core hours

]

plantypestring

Possible values: [Trial, MonthlyOnDemand, AnnualSubscription]

slaCredits

undefined[]

List of SLA credits

Array [

planCredit

Plan Credit

cpuCoreHoursint64

creditUidstring

expirydate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

startdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

typestringrequired

Possible values: [Pure, Alloy]

totalCpuCoreHoursint64

Total used cpu core hours

]

status

Invoice Status

billableAmountfloat64

Total billable amount

productInvoice

Product invoice object

alloy

Product invoice data

allocatedCreditsint64

Allocated credits

amountfloat64

Total amount

billableCreditsfloat64

Credits to be billed

breachedCreditsfloat64

Credits that are exceeds the allocated credits

discountint64

Applied discount

freeCreditsint64

Allocated free credits

overageLimitPercentageint8

Allowed overage limit in percentage

tierNamestring

Tier name

tierPricefloat64

Tier price

totalUsedCreditsfloat64

Total used credits

usedCreditsfloat64

Used credits

pure

Product invoice data

allocatedCreditsint64

Allocated credits

amountfloat64

Total amount

billableCreditsfloat64

Credits to be billed

breachedCreditsfloat64

Credits that are exceeds the allocated credits

discountint64

Applied discount

freeCreditsint64

Allocated free credits

overageLimitPercentageint8

Allowed overage limit in percentage

tierNamestring

Tier name

tierPricefloat64

Tier price

totalUsedCreditsfloat64

Total used credits

usedCreditsfloat64

Used credits

projects

undefined[]

List of project invoices

Array [

amountfloat64

Billing amount for the project

projectNamestring

Name of the project

projectUidstring

Project identifier

usage

Project usage object

alloy

Project usage data object

amountfloat64

Billing amount for the project

tierPricefloat64

Tier price based on the usage

usedCreditsfloat64

Project used credits

pure

Project usage data object

amountfloat64

Billing amount for the project

tierPricefloat64

Tier price based on the usage

usedCreditsfloat64

Project used credits

]

states

undefined[]

List of invoice states

Array [

paymentMsgstring

Payment status message

statestring

Possible values: [Paid, PaymentPending, PaymentInProgress, PaymentFailed]

timestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

]

stripeInvoiceIdstring

Stripe invoice uid

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-05-04T15:42:56.271Z",
    "deletionTimestamp": "2024-05-04T15:42:56.271Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-05-04T15:42:56.271Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "country": "string",
      "pincode": "string",
      "state": "string"
    },
    "billingPeriod": {
      "end": "2024-05-04T15:42:56.271Z",
      "start": "2024-05-04T15:42:56.271Z"
    },
    "credits": {
      "alloyFreeCredits": 0,
      "pureFreeCredits": 0
    },
    "envType": "string",
    "month": "2024-05-04T15:42:56.271Z",
    "paymentUnit": "usd",
    "plan": {
      "freeCredits": [
        {
          "planCredit": {
            "cpuCoreHours": 0,
            "creditUid": "string",
            "expiry": "2024-05-04T15:42:56.271Z",
            "name": "string",
            "start": "2024-05-04T15:42:56.271Z",
            "type": "Pure"
          },
          "totalCpuCoreHours": 0
        }
      ],
      "plantype": "Trial",
      "slaCredits": [
        {
          "planCredit": {
            "cpuCoreHours": 0,
            "creditUid": "string",
            "expiry": "2024-05-04T15:42:56.271Z",
            "name": "string",
            "start": "2024-05-04T15:42:56.271Z",
            "type": "Pure"
          },
          "totalCpuCoreHours": 0
        }
      ]
    }
  },
  "status": {
    "billableAmount": 0,
    "productInvoice": {
      "alloy": {
        "allocatedCredits": 0,
        "amount": 0,
        "billableCredits": 0,
        "breachedCredits": 0,
        "discount": 0,
        "freeCredits": 0,
        "overageLimitPercentage": 0,
        "tierName": "string",
        "tierPrice": 0,
        "totalUsedCredits": 0,
        "usedCredits": 0
      },
      "pure": {
        "allocatedCredits": 0,
        "amount": 0,
        "billableCredits": 0,
        "breachedCredits": 0,
        "discount": 0,
        "freeCredits": 0,
        "overageLimitPercentage": 0,
        "tierName": "string",
        "tierPrice": 0,
        "totalUsedCredits": 0,
        "usedCredits": 0
      }
    },
    "projects": [
      {
        "amount": 0,
        "projectName": "string",
        "projectUid": "string",
        "usage": {
          "alloy": {
            "amount": 0,
            "tierPrice": 0,
            "usedCredits": 0
          },
          "pure": {
            "amount": 0,
            "tierPrice": 0,
            "usedCredits": 0
          }
        }
      }
    ],
    "states": [
      {
        "paymentMsg": "string",
        "state": "Paid",
        "timestamp": "2024-05-04T15:42:56.271Z"
      }
    ],
    "stripeInvoiceId": "string"
  }
}

Loading...