Skip to main content

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​

(empty)

Schema

    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

    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

    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

    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 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

    uidstring

    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

    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

    Usage by the project

    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

Loading...