路径参数

• orgId 字符串 必需

  唯一的 24-十六进制数字字符串，用于标识包含项目的组织。 使用 /orgs 端点检索身份验证的用户有权访问权限的所有组织。

  格式应符合以下模式：^([a-f0-9]{24})$。

• invoiceId 字符串 必需

  唯一的 24 位十六进制数字字符串，用于标识提交给指定组织的发票。收费一般在第二天发出。

  格式应符合以下模式：^([a-f0-9]{24})$。

查询参数

• envelope 布尔

  指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

  默认值为false 。

• pretty 布尔

  指示响应正文是否应采用 prettyprint 格式的标记。

  默认值为false 。

  Prettyprint

响应

• 200

  application/vnd.atlas.2023-01-01+csv

  application/vnd.atlas.2023-01-01+csv application/vnd.atlas.2023-01-01+json

  正常

  隐藏响应属性 显示响应属性 对象

  • amountBilledCents integer(int64)

    100指定组织在此发票所涉期间消耗的服务总和。此参数以美分（一美元的十分之一）为单位表示其值。

  • amountPaidCents integer(int64)

    100指定组织为此发票支付的总和。此参数以美分（一美元的十分之一）为单位表示其值。

  • 已创建 string(date-time)

    MongoDB Cloud 创建此发票的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

  • CreditsCents integer(int64)

    MongoDB将此发票贷记给指定组织的总和。此参数以美分（一美元的十分之一）为单位表示其值。100

  • endDate string(date-time)

    MongoDB Cloud 完成此发票涵盖的计费周期的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

  • id 字符串

    唯一的 24 位十六进制数字字符串，用于标识提交给指定组织的发票。收费一般在第二天发出。

    格式应符合以下模式：^([a-f0-9]{24})$。

  • lineItems 大量[对象]

    包含此发票所含各项服务的列表。

    此发票包含一项服务。

    隐藏 lineItems 属性 显示 lineItems 属性 对象

    • 集群名称 字符串

      人类可读标签，用于标识产生费用的集群。

      格式应符合以下模式：^[a-zA-Z0-9][a-zA-Z0-9-]*$。

    • 已创建 string(date-time)

      MongoDB Cloud 创建此行项目的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • 折扣美分 integer(int64)

      MongoDB对此行项目的折扣总和。 MongoDB Cloud100 以美分（一美元的几分之一）表示该值。应用折扣时，资源会返回此参数。

    • endDate string(date-time)

      MongoDB Cloud 完成对此订单项收费的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • groupId 字符串

      唯一的 24-十六进制数字字符串，用于标识与此行项目关联的项目。

      格式应符合以下模式：^([a-f0-9]{24})$。

    • groupName 字符串

      用于标识项目的人类可读标签。

    • 注意 字符串

      适用于该订单项的注释。

    • percentDiscount number(float)

      MongoDB对此订单项的折扣百分比。应用折扣时，资源会返回此参数。

    • 数量 number(double)

      行项目包含的单位数。这些可以是存储(GB)、时间（小时）或其他单位的表达式。

    • sku 字符串

      此订单项提供的服务的人类可读描述。此库存单位 (SKU) 可以是实例类型、支持费用、高级安全性或其他服务。

      要了解如何列出所有可能的...
    • startDate string(date-time)

      MongoDB Cloud 开始对此行项目收费的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • StitchAppName 字符串

      人类可读标签，用于标识与此行项目关联的Atlas App Services应用程序。

      创建新的Atlas App Service
    • 标记 对象

      与行项目资源关联的标签相对应的键值对映射。

      Hide tags attribute Show tags attribute 对象

      • * array[string] additionalProperties

        与行项目资源关联的标签相对应的键值对映射。

    • tierLowerBound number(double)

      当前 SKU层级中使用量范围的下限。

      注意：仅当 lineItems[n].sku 是分层的时，lineItems[n].tierLowerBound 才会出现。

    • tierUpperBound number(double)

      当前 SKU层级中使用量范围的上限。

      注意：仅当 lineItems[n].sku 是分层的时，lineItems[n].tierUpperBound 才会出现。

    • totalPriceCents integer(int64)

      为此行项目设立的费用总和。 MongoDB Cloud 以美分（一美元的100 ）表示该值，并按如下方式计算该值：unitPriceDollars × quantity ×100 。

    • 单位 字符串

      用于表示此订单项测量的数量的元素。该值可以是时间、存储容量等元素。

    • unitPriceDollars number(double)

      此订单项的单位价值，以美元表示。

  • LinkedInvoices 大量[对象]

    包含与付款组织关联的组织的发票的列表。
  • 链接 大量[对象]

    点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。

    Web 链接规范 (RFC...
    隐藏链接属性 显示链接属性 对象

    • href 字符串

      统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

    • rel 字符串

      统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。

  • orgId 字符串

    唯一的 24-十六进制数字字符串，用于标识对使用MongoDB Cloud 的服务收费的组织。

    格式应符合以下模式：^([a-f0-9]{24})$。

  • 付款 大量[对象]

    列表，其中包含为支付此发票中注明的指定服务而转移到MongoDB 的资金。

    转入MongoDB以支付此发票中指定服务的资金。

    隐藏付款属性 显示付款属性 对象

    • amountBilledCents integer(int64)

      100指定组织在此发票所涉期间消耗的服务总和。此参数以美分（一美元的十分之一）为单位表示其值。

    • amountPaidCents integer(int64)

      100指定组织为关联发票支付的总和。此参数以美分（一美元的十分之一）为单位表示其值。

    • 已创建 string(date-time)

      客户尝试付款的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • 货币 字符串

      付款所使用的币种。此参数以 3 字母 ISO 4217 货币代码表示其值。

    • id 字符串

      唯一的 24-十六进制数字字符串，用于标识针对关联发票的这笔付款。

      格式应符合以下模式：^([a-f0-9]{24})$。

    • salesTaxCents integer(int64)

      100应用于此发票的销售税总和。此参数以美分（一美元的十分之一）为单位表示其值。

    • statusName 字符串

      当您提出此请求时，关联发票的付款处理阶段。这些阶段包括：

      • CANCELLED：客户数或MongoDB取消了付款。
      • ERROR：尝试完成付款时出现问题。
      • FAILED： MongoDB尝试向信用收费，但未成功。
      • FAILED_AUTHENTICATION：强客户数身份验证失败。确认您的付款方式已通过身份验证。
      • FORGIVEN：客户数发起付款，但MongoDB后来予以宽恕。
      • INVOICED： MongoDB开具了包含此行项目的发票。
      • NEW：客户数提供了付款方式，但MongoDB尚未尝试从信用收费。
      • PAID：客户数提交了成功的付款信息。
      • PARTIAL_PAID：客户数支付了该订单项的部分费用。

      取值为 NEW、FORGIVEN、FAILED、PAID、PARTIAL_PAID、CANCELLED、INVOICED、FAILED_AUTHENTICATION、PROCESSING、PENDING_REVERSAL 或 REFUNDED。

    • subtotalCents integer(int64)

      100此发票中包含的所有正发票行项目的总和。此参数以美分（一美元的十分之一）为单位表示其值。

    • unitPrice 字符串

      应用于 amountBilledCents 以计算总付款金额的单价。该值表示为十进制字符串。

    • Updated string(date-time)

      客户更新本次付款尝试的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

  • 退款 大量[对象]

    列表，其中包含MongoDB为该发票返回给组织的付款。

    MongoDB就此发票向组织退还的一笔付款。

    隐藏退款属性 显示退款属性 对象

    • amountCents integer(int64)

      退还给指定组织的资金总和，以美分（美元的100）表示。

    • 已创建 string(date-time)

      MongoDB Cloud 创建此退款的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

    • PaymentId 字符串

      唯一的 24-十六进制数字字符串，用于标识组织已进行的付款。

      格式应符合以下模式：^([a-f0-9]{24})$。

    • 原因 字符串

      MongoDB接受向组织返还资金的理由。

  • salesTaxCents integer(int64)

    100应用于此发票的销售税总和。此参数以美分（一美元的十分之一）为单位表示其值。

  • startDate string(date-time)

    MongoDB Cloud 开始此发票所涵盖的计费周期的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

  • startupBalanceCents integer(int64)

    当MongoDB开具此发票时，指定组织欠MongoDB的金额。此参数以美元表示其值。

  • statusName 字符串

    当您提出此请求时，此发票已存在的付款处理阶段。已接受的阶段包括：

    • CLOSED： MongoDB最终确定了计费周期内的所有费用，但尚未向客户收费。
    • FAILED： MongoDB尝试从所提供的信用扣款，但扣款失败。
    • FORGIVEN：客户数发起付款，但MongoDB后来予以宽恕。
    • FREE：所有费用总计为零，因此不会向客户收费。
    • INVOICED： MongoDB使用弹性发票处理这些费用。
    • PAID： MongoDB已成功向所提供的信用收费。
    • PENDING：发票包括当前计费周期的费用。
    • PREPAID：客户数有预付费计划，因此无需付费。

    取值为 PENDING、CLOSED、FORGIVEN、FAILED、PAID、FREE、PREPAID 或 INVOICED。

  • subtotalCents integer(int64)

    100此发票中包含的所有正发票行项目的总和。此参数以美分（一美元的十分之一）为单位表示其值。

  • Updated string(date-time)

    MongoDB Cloud 上次更新此付款金额的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。

• 401 application/json

  未经授权。

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。

• 403 application/json

  Forbidden.

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。

• 404 application/json

  未找到。

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。

• 500 application/json

  内部服务器错误。

  隐藏响应属性 显示响应属性 对象

  • badRequestDetail 对象

    错误请求详情。

    隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象

    • 字段 大量[对象]

      描述客户端请求中的所有违规行为。

      隐藏字段属性 显示字段属性 对象

      • 描述 字符串 必需

        关于请求元素错误的原因的描述。

      • 字段 字符串 必需

        指向请求正文中字段的路径。

  • 详细信息 字符串

    描述导致每种错误类型的具体条件或原因。

  • 错误 integer(int32) 必需

    与此错误一起返回的 HTTP 状态代码。

    外部文档
  • 错误代码 字符串 必需

    返回此错误时附带应用程序错误代码。

  • 参数 大量[对象]

    用于提供更多错误信息的参数。
  • 原因 字符串

    随此错误返回的应用程序错误消息。