Returns a specified invoice
GET/v1/tenants/:tenantUid/invoices/:invoiceUid
Returns a specified invoice
Request
Path Parameters
Specify the tenant uid
Specify the invoice uid
Responses
- 200
(empty)
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Array [
]
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
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.
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
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
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.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
spec
Invoice specification
address
object
Tenant Address
billingPeriod
Invoice billing period object
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.
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
Credits allocated for import clusters
Credits allocated for managed clusters
Environment type [Trial,MonthlyOnDemand,AnnualSubscription,OnPrem]
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.
Possible values: [usd
]
plan
Invoice plan object
freeCredits
undefined[]
List of free credits
planCredit
Plan Credit
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.
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.
Possible values: [Pure
, Alloy
]
Total used cpu core hours
Possible values: [Trial
, MonthlyOnDemand
, AnnualSubscription
]
slaCredits
undefined[]
List of SLA credits
planCredit
Plan Credit
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.
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.
Possible values: [Pure
, Alloy
]
Total used cpu core hours
status
Invoice Status
Total billable amount
productInvoice
Product invoice object
alloy
Product invoice data
Allocated credits
Total amount
Credits to be billed
Credits that are exceeds the allocated credits
Applied discount
Allocated free credits
Allowed overage limit in percentage
Tier name
Tier price
Total used credits
Used credits
pure
Product invoice data
Allocated credits
Total amount
Credits to be billed
Credits that are exceeds the allocated credits
Applied discount
Allocated free credits
Allowed overage limit in percentage
Tier name
Tier price
Total used credits
Used credits
projects
undefined[]
List of project invoices
Billing amount for the project
Name of the project
Project identifier
usage
Usage by the project
alloy
Project usage data object
Billing amount for the project
Tier price based on the usage
Project used credits
pure
Project usage data object
Billing amount for the project
Tier price based on the usage
Project used credits
states
undefined[]
List of invoice states
Payment status message
Possible values: [Paid
, PaymentPending
, PaymentInProgress
, PaymentFailed
]
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.
Stripe invoice uid
{
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-29T15:51:28.071Z",
"deletionTimestamp": "2024-07-29T15:51:28.071Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
"name": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"billingPeriod": {
"end": "2024-07-29T15:51:28.071Z",
"start": "2024-07-29T15:51:28.071Z"
},
"credits": {
"alloyFreeCredits": 0,
"pureFreeCredits": 0
},
"envType": "string",
"month": "2024-07-29T15:51:28.071Z",
"paymentUnit": "usd",
"plan": {
"freeCredits": [
{
"planCredit": {
"cpuCoreHours": 0,
"creditUid": "string",
"expiry": "2024-07-29T15:51:28.071Z",
"name": "string",
"start": "2024-07-29T15:51:28.071Z",
"type": "Pure"
},
"totalCpuCoreHours": 0
}
],
"plantype": "Trial",
"slaCredits": [
{
"planCredit": {
"cpuCoreHours": 0,
"creditUid": "string",
"expiry": "2024-07-29T15:51:28.071Z",
"name": "string",
"start": "2024-07-29T15:51:28.071Z",
"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-07-29T15:51:28.071Z"
}
],
"stripeInvoiceId": "string"
}
}