Path parameters

• orgId string Required

  Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

  Format should match the following pattern: ^([a-f0-9]{24})$.

Query parameters

• envelope boolean

  Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

  Default value is false.

• pretty boolean

  Flag that indicates whether the response body should be in the prettyprint format.

  Default value is false.

  Prettyprint

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • links array[object]

    List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

    Web Linking Specification (RFC 5988)
    Hide links attributes Show links attributes object

    • href string

      Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • rel string

      Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

  • results array[object]

    List of returned documents that MongoDB Cloud provides when completing this request.

    Hide results attributes Show results attributes object

    • amountBilledCents integer(int64)

      Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

    • amountPaidCents integer(int64)

      Sum that the specified organization paid toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

    • created string(date-time)

      Date and time when MongoDB Cloud created this invoice. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • creditsCents integer(int64)

      Sum that MongoDB credited the specified organization toward this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

    • endDate string(date-time)

      Date and time when MongoDB Cloud finished the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • id string

      Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.

      Format should match the following pattern: ^([a-f0-9]{24})$.

    • lineItems array[object]

      List that contains individual services included in this invoice.

      One service included in this invoice.

      Hide lineItems attributes Show lineItems attributes object

      • clusterName string

        Human-readable label that identifies the cluster that incurred the charge.

        Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

      • created string(date-time)

        Date and time when MongoDB Cloud created this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

      • discountCents integer(int64)

        Sum by which MongoDB discounted this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar). The resource returns this parameter when a discount applies.

      • endDate string(date-time)

        Date and time when when MongoDB Cloud finished charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

      • groupId string

        Unique 24-hexadecimal digit string that identifies the project associated to this line item.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • groupName string

        Human-readable label that identifies the project.

      • note string

        Comment that applies to this line item.

      • percentDiscount number(float)

        Percentage by which MongoDB discounted this line item. The resource returns this parameter when a discount applies.

      • quantity number(double)

        Number of units included for the line item. These can be expressions of storage (GB), time (hours), or other units.

      • sku string

        Human-readable description of the service that this line item provided. This Stock Keeping Unit (SKU) could be the instance type, a support charge, advanced security, or another service.

        Values are CLASSIC_BACKUP_OPLOG, CLASSIC_BACKUP_STORAGE, CLASSIC_BACKUP_SNAPSHOT_CREATE, CLASSIC_BACKUP_DAILY_MINIMUM, CLASSIC_BACKUP_FREE_TIER, CLASSIC_COUPON, BACKUP_STORAGE_FREE_TIER, BACKUP_STORAGE, FLEX_CONSULTING, CLOUD_MANAGER_CLASSIC, CLOUD_MANAGER_BASIC_FREE_TIER, CLOUD_MANAGER_BASIC, CLOUD_MANAGER_PREMIUM, CLOUD_MANAGER_FREE_TIER, CLOUD_MANAGER_STANDARD_FREE_TIER, CLOUD_MANAGER_STANDARD_ANNUAL, CLOUD_MANAGER_STANDARD, CLOUD_MANAGER_FREE_TRIAL, ATLAS_INSTANCE_M0, ATLAS_INSTANCE_M2, ATLAS_INSTANCE_M5, ATLAS_AWS_INSTANCE_M10, ATLAS_AWS_INSTANCE_M20, ATLAS_AWS_INSTANCE_M30, ATLAS_AWS_INSTANCE_M40, ATLAS_AWS_INSTANCE_M50, ATLAS_AWS_INSTANCE_M60, ATLAS_AWS_INSTANCE_M80, ATLAS_AWS_INSTANCE_M100, ATLAS_AWS_INSTANCE_M140, ATLAS_AWS_INSTANCE_M200, ATLAS_AWS_INSTANCE_M300, ATLAS_AWS_INSTANCE_M40_LOW_CPU, ATLAS_AWS_INSTANCE_M50_LOW_CPU, ATLAS_AWS_INSTANCE_M60_LOW_CPU, ATLAS_AWS_INSTANCE_M80_LOW_CPU, ATLAS_AWS_INSTANCE_M200_LOW_CPU, ATLAS_AWS_INSTANCE_M300_LOW_CPU, ATLAS_AWS_INSTANCE_M400_LOW_CPU, ATLAS_AWS_INSTANCE_M700_LOW_CPU, ATLAS_AWS_INSTANCE_M40_NVME, ATLAS_AWS_INSTANCE_M50_NVME, ATLAS_AWS_INSTANCE_M60_NVME, ATLAS_AWS_INSTANCE_M80_NVME, ATLAS_AWS_INSTANCE_M200_NVME, ATLAS_AWS_INSTANCE_M400_NVME, ATLAS_AWS_INSTANCE_M10_PAUSED, ATLAS_AWS_INSTANCE_M20_PAUSED, ATLAS_AWS_INSTANCE_M30_PAUSED, ATLAS_AWS_INSTANCE_M40_PAUSED, ATLAS_AWS_INSTANCE_M50_PAUSED, ATLAS_AWS_INSTANCE_M60_PAUSED, ATLAS_AWS_INSTANCE_M80_PAUSED, ATLAS_AWS_INSTANCE_M100_PAUSED, ATLAS_AWS_INSTANCE_M140_PAUSED, ATLAS_AWS_INSTANCE_M200_PAUSED, ATLAS_AWS_INSTANCE_M300_PAUSED, ATLAS_AWS_INSTANCE_M40_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M50_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M60_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M80_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M200_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M300_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M400_LOW_CPU_PAUSED, ATLAS_AWS_INSTANCE_M700_LOW_CPU_PAUSED, ATLAS_AWS_SEARCH_INSTANCE_S20_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S30_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S40_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S50_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S60_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S70_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S80_COMPUTE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S30_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S40_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S50_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S60_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S80_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S90_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S100_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S110_MEMORY_NVME, ATLAS_AWS_SEARCH_INSTANCE_S40_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S50_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S60_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S80_STORAGE_NVME, ATLAS_AWS_SEARCH_INSTANCE_S90_STORAGE_NVME, ATLAS_AWS_STORAGE_PROVISIONED, ATLAS_AWS_STORAGE_STANDARD, ATLAS_AWS_STORAGE_STANDARD_GP3, ATLAS_AWS_STORAGE_IOPS, ATLAS_AWS_DATA_TRANSFER_SAME_REGION, ATLAS_AWS_DATA_TRANSFER_DIFFERENT_REGION, ATLAS_AWS_DATA_TRANSFER_INTERNET, ATLAS_AWS_BACKUP_SNAPSHOT_STORAGE, ATLAS_AWS_BACKUP_DOWNLOAD_VM, ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE, ATLAS_AWS_BACKUP_DOWNLOAD_VM_STORAGE_IOPS, ATLAS_AWS_PRIVATE_ENDPOINT, ATLAS_AWS_PRIVATE_ENDPOINT_CAPACITY_UNITS, ATLAS_GCP_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S30_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S70_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S120_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD, ATLAS_GCP_SEARCH_INSTANCE_S140_MEMORY_LOCALSSD, ATLAS_GCP_INSTANCE_M10, ATLAS_GCP_INSTANCE_M20, ATLAS_GCP_INSTANCE_M30, ATLAS_GCP_INSTANCE_M40, ATLAS_GCP_INSTANCE_M50, ATLAS_GCP_INSTANCE_M60, ATLAS_GCP_INSTANCE_M80, ATLAS_GCP_INSTANCE_M140, ATLAS_GCP_INSTANCE_M200, ATLAS_GCP_INSTANCE_M250, ATLAS_GCP_INSTANCE_M300, ATLAS_GCP_INSTANCE_M400, ATLAS_GCP_INSTANCE_M40_LOW_CPU, ATLAS_GCP_INSTANCE_M50_LOW_CPU, ATLAS_GCP_INSTANCE_M60_LOW_CPU, ATLAS_GCP_INSTANCE_M80_LOW_CPU, ATLAS_GCP_INSTANCE_M200_LOW_CPU, ATLAS_GCP_INSTANCE_M300_LOW_CPU, ATLAS_GCP_INSTANCE_M400_LOW_CPU, ATLAS_GCP_INSTANCE_M600_LOW_CPU, ATLAS_GCP_INSTANCE_M10_PAUSED, ATLAS_GCP_INSTANCE_M20_PAUSED, ATLAS_GCP_INSTANCE_M30_PAUSED, ATLAS_GCP_INSTANCE_M40_PAUSED, ATLAS_GCP_INSTANCE_M50_PAUSED, ATLAS_GCP_INSTANCE_M60_PAUSED, ATLAS_GCP_INSTANCE_M80_PAUSED, ATLAS_GCP_INSTANCE_M140_PAUSED, ATLAS_GCP_INSTANCE_M200_PAUSED, ATLAS_GCP_INSTANCE_M250_PAUSED, ATLAS_GCP_INSTANCE_M300_PAUSED, ATLAS_GCP_INSTANCE_M400_PAUSED, ATLAS_GCP_INSTANCE_M40_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M50_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M60_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M80_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M200_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M300_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M400_LOW_CPU_PAUSED, ATLAS_GCP_INSTANCE_M600_LOW_CPU_PAUSED, ATLAS_GCP_DATA_TRANSFER_INTERNET, ATLAS_GCP_STORAGE_SSD, ATLAS_GCP_DATA_TRANSFER_INTER_CONNECT, ATLAS_GCP_DATA_TRANSFER_INTER_ZONE, ATLAS_GCP_DATA_TRANSFER_INTER_REGION, ATLAS_GCP_DATA_TRANSFER_GOOGLE, ATLAS_GCP_BACKUP_SNAPSHOT_STORAGE, ATLAS_GCP_BACKUP_DOWNLOAD_VM, ATLAS_GCP_BACKUP_DOWNLOAD_VM_STORAGE, ATLAS_GCP_PRIVATE_ENDPOINT, ATLAS_GCP_PRIVATE_ENDPOINT_CAPACITY_UNITS, ATLAS_GCP_SNAPSHOT_COPY_DATA_TRANSFER, ATLAS_AZURE_INSTANCE_M10, ATLAS_AZURE_INSTANCE_M20, ATLAS_AZURE_INSTANCE_M30, ATLAS_AZURE_INSTANCE_M40, ATLAS_AZURE_INSTANCE_M50, ATLAS_AZURE_INSTANCE_M60, ATLAS_AZURE_INSTANCE_M80, ATLAS_AZURE_INSTANCE_M90, ATLAS_AZURE_INSTANCE_M200, ATLAS_AZURE_INSTANCE_R40, ATLAS_AZURE_INSTANCE_R50, ATLAS_AZURE_INSTANCE_R60, ATLAS_AZURE_INSTANCE_R80, ATLAS_AZURE_INSTANCE_R200, ATLAS_AZURE_INSTANCE_R300, ATLAS_AZURE_INSTANCE_R400, ATLAS_AZURE_INSTANCE_M60_NVME, ATLAS_AZURE_INSTANCE_M80_NVME, ATLAS_AZURE_INSTANCE_M200_NVME, ATLAS_AZURE_INSTANCE_M300_NVME, ATLAS_AZURE_INSTANCE_M400_NVME, ATLAS_AZURE_INSTANCE_M600_NVME, ATLAS_AZURE_INSTANCE_M10_PAUSED, ATLAS_AZURE_INSTANCE_M20_PAUSED, ATLAS_AZURE_INSTANCE_M30_PAUSED, ATLAS_AZURE_INSTANCE_M40_PAUSED, ATLAS_AZURE_INSTANCE_M50_PAUSED, ATLAS_AZURE_INSTANCE_M60_PAUSED, ATLAS_AZURE_INSTANCE_M80_PAUSED, ATLAS_AZURE_INSTANCE_M90_PAUSED, ATLAS_AZURE_INSTANCE_M200_PAUSED, ATLAS_AZURE_INSTANCE_R40_PAUSED, ATLAS_AZURE_INSTANCE_R50_PAUSED, ATLAS_AZURE_INSTANCE_R60_PAUSED, ATLAS_AZURE_INSTANCE_R80_PAUSED, ATLAS_AZURE_INSTANCE_R200_PAUSED, ATLAS_AZURE_INSTANCE_R300_PAUSED, ATLAS_AZURE_INSTANCE_R400_PAUSED, ATLAS_AZURE_SEARCH_INSTANCE_S20_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S30_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S40_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S50_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S60_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S70_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S80_COMPUTE_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S40_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S50_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S60_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S80_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S90_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S100_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S110_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S130_MEMORY_LOCALSSD, ATLAS_AZURE_SEARCH_INSTANCE_S135_MEMORY_LOCALSSD, ATLAS_AZURE_STORAGE_P2, ATLAS_AZURE_STORAGE_P3, ATLAS_AZURE_STORAGE_P4, ATLAS_AZURE_STORAGE_P6, ATLAS_AZURE_STORAGE_P10, ATLAS_AZURE_STORAGE_P15, ATLAS_AZURE_STORAGE_P20, ATLAS_AZURE_STORAGE_P30, ATLAS_AZURE_STORAGE_P40, ATLAS_AZURE_STORAGE_P50, ATLAS_AZURE_DATA_TRANSFER, ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_IN, ATLAS_AZURE_DATA_TRANSFER_REGIONAL_VNET_OUT, ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_IN, ATLAS_AZURE_DATA_TRANSFER_GLOBAL_VNET_OUT, ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_IN, ATLAS_AZURE_DATA_TRANSFER_AVAILABILITY_ZONE_OUT, ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTRA_CONTINENT, ATLAS_AZURE_DATA_TRANSFER_INTER_REGION_INTER_CONTINENT, ATLAS_AZURE_BACKUP_SNAPSHOT_STORAGE, ATLAS_AZURE_BACKUP_DOWNLOAD_VM, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P2, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P3, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P4, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P6, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P10, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P15, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P20, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P30, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P40, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_P50, ATLAS_AZURE_STANDARD_STORAGE, ATLAS_AZURE_EXTENDED_STANDARD_IOPS, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE, ATLAS_AZURE_BACKUP_DOWNLOAD_VM_STORAGE_EXTENDED_IOPS, ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE, ATLAS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_EXTENDED_IOPS, ATLAS_BI_CONNECTOR, ATLAS_ADVANCED_SECURITY, ATLAS_ENTERPRISE_AUDITING, ATLAS_FREE_SUPPORT, ATLAS_SUPPORT, ATLAS_NDS_BACKFILL_SUPPORT, STITCH_DATA_DOWNLOADED_FREE_TIER, STITCH_DATA_DOWNLOADED, STITCH_COMPUTE_FREE_TIER, STITCH_COMPUTE, CREDIT, MINIMUM_CHARGE, CHARTS_DATA_DOWNLOADED_FREE_TIER, CHARTS_DATA_DOWNLOADED, ATLAS_DATA_LAKE_AWS_DATA_RETURNED_SAME_REGION, ATLAS_DATA_LAKE_AWS_DATA_RETURNED_DIFFERENT_REGION, ATLAS_DATA_LAKE_AWS_DATA_RETURNED_INTERNET, ATLAS_DATA_LAKE_AWS_DATA_SCANNED, ATLAS_DATA_LAKE_AWS_DATA_TRANSFERRED_FROM_DIFFERENT_REGION, ATLAS_NDS_AWS_DATA_LAKE_STORAGE_ACCESS, ATLAS_NDS_AWS_DATA_LAKE_STORAGE, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_REGION, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_SAME_CONTINENT, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_DIFFERENT_CONTINENT, ATLAS_DATA_FEDERATION_AZURE_DATA_RETURNED_INTERNET, ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_SAME_REGION, ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_DIFFERENT_REGION, ATLAS_DATA_FEDERATION_GCP_DATA_RETURNED_INTERNET, ATLAS_DATA_FEDERATION_AZURE_DATA_SCANNED, ATLAS_NDS_AZURE_DATA_LAKE_STORAGE_ACCESS, ATLAS_NDS_AZURE_DATA_LAKE_STORAGE, ATLAS_DATA_FEDERATION_GCP_DATA_SCANNED, ATLAS_NDS_GCP_DATA_LAKE_STORAGE_ACCESS, ATLAS_NDS_GCP_DATA_LAKE_STORAGE, ATLAS_NDS_AWS_OBJECT_STORAGE_ACCESS, ATLAS_NDS_AWS_COMPRESSED_OBJECT_STORAGE, ATLAS_NDS_AZURE_OBJECT_STORAGE_ACCESS, ATLAS_NDS_AZURE_OBJECT_STORAGE, ATLAS_NDS_AZURE_COMPRESSED_OBJECT_STORAGE, ATLAS_NDS_GCP_OBJECT_STORAGE_ACCESS, ATLAS_NDS_GCP_OBJECT_STORAGE, ATLAS_NDS_GCP_COMPRESSED_OBJECT_STORAGE, ATLAS_ARCHIVE_ACCESS_PARTITION_LOCATE, ATLAS_NDS_AWS_PIT_RESTORE_STORAGE_FREE_TIER, ATLAS_NDS_AWS_PIT_RESTORE_STORAGE, ATLAS_NDS_GCP_PIT_RESTORE_STORAGE_FREE_TIER, ATLAS_NDS_GCP_PIT_RESTORE_STORAGE, ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE_FREE_TIER, ATLAS_NDS_AZURE_PIT_RESTORE_STORAGE, ATLAS_NDS_AZURE_PRIVATE_ENDPOINT_CAPACITY_UNITS, ATLAS_NDS_AZURE_CMK_PRIVATE_NETWORKING, ATLAS_NDS_AWS_CMK_PRIVATE_NETWORKING, ATLAS_NDS_AWS_OBJECT_STORAGE, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_UPLOAD, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_UPLOAD, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M40, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M50, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_M60, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P2, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P3, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P4, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P6, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P10, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P15, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P20, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P30, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P40, ATLAS_NDS_AZURE_SNAPSHOT_EXPORT_VM_STORAGE_P50, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M40, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M50, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_M60, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE, ATLAS_NDS_AWS_SNAPSHOT_EXPORT_VM_STORAGE_IOPS, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_UPLOAD, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M40, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M50, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_M60, ATLAS_NDS_GCP_SNAPSHOT_EXPORT_VM_STORAGE, ATLAS_NDS_AWS_SERVERLESS_RPU, ATLAS_NDS_AWS_SERVERLESS_WPU, ATLAS_NDS_AWS_SERVERLESS_STORAGE, ATLAS_NDS_AWS_SERVERLESS_CONTINUOUS_BACKUP, ATLAS_NDS_AWS_SERVERLESS_BACKUP_RESTORE_VM, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_PREVIEW, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_REGIONAL, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_CROSS_REGION, ATLAS_NDS_AWS_SERVERLESS_DATA_TRANSFER_INTERNET, ATLAS_NDS_GCP_SERVERLESS_RPU, ATLAS_NDS_GCP_SERVERLESS_WPU, ATLAS_NDS_GCP_SERVERLESS_STORAGE, ATLAS_NDS_GCP_SERVERLESS_CONTINUOUS_BACKUP, ATLAS_NDS_GCP_SERVERLESS_BACKUP_RESTORE_VM, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_PREVIEW, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_REGIONAL, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_CROSS_REGION, ATLAS_NDS_GCP_SERVERLESS_DATA_TRANSFER_INTERNET, ATLAS_NDS_AZURE_SERVERLESS_RPU, ATLAS_NDS_AZURE_SERVERLESS_WPU, ATLAS_NDS_AZURE_SERVERLESS_STORAGE, ATLAS_NDS_AZURE_SERVERLESS_CONTINUOUS_BACKUP, ATLAS_NDS_AZURE_SERVERLESS_BACKUP_RESTORE_VM, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_PREVIEW, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_REGIONAL, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_CROSS_REGION, ATLAS_NDS_AZURE_SERVERLESS_DATA_TRANSFER_INTERNET, REALM_APP_REQUESTS_FREE_TIER, REALM_APP_REQUESTS, REALM_APP_COMPUTE_FREE_TIER, REALM_APP_COMPUTE, REALM_APP_SYNC_FREE_TIER, REALM_APP_SYNC, REALM_APP_DATA_TRANSFER_FREE_TIER, REALM_APP_DATA_TRANSFER, GCP_SNAPSHOT_COPY_DISK, ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP10, ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP30, ATLAS_AWS_STREAM_PROCESSING_INSTANCE_SP50, ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP10, ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP30, ATLAS_AZURE_STREAM_PROCESSING_INSTANCE_SP50, ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER, ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER, ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING, ATLAS_AZURE_STREAM_PROCESSING_PRIVATELINK, ATLAS_AWS_STREAM_PROCESSING_PRIVATELINK, ATLAS_FLEX_AWS_100_USAGE_HOURS, ATLAS_FLEX_AWS_200_USAGE_HOURS, ATLAS_FLEX_AWS_300_USAGE_HOURS, ATLAS_FLEX_AWS_400_USAGE_HOURS, ATLAS_FLEX_AWS_500_USAGE_HOURS, ATLAS_FLEX_AZURE_100_USAGE_HOURS, ATLAS_FLEX_AZURE_200_USAGE_HOURS, ATLAS_FLEX_AZURE_300_USAGE_HOURS, ATLAS_FLEX_AZURE_400_USAGE_HOURS, ATLAS_FLEX_AZURE_500_USAGE_HOURS, ATLAS_FLEX_GCP_100_USAGE_HOURS, ATLAS_FLEX_GCP_200_USAGE_HOURS, ATLAS_FLEX_GCP_300_USAGE_HOURS, ATLAS_FLEX_GCP_400_USAGE_HOURS, ATLAS_FLEX_GCP_500_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_100_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_200_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_300_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_400_USAGE_HOURS, ATLAS_FLEX_AWS_LEGACY_500_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_100_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_200_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_300_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_400_USAGE_HOURS, ATLAS_FLEX_AZURE_LEGACY_500_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_100_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_200_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_300_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_400_USAGE_HOURS, ATLAS_FLEX_GCP_LEGACY_500_USAGE_HOURS, ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP10, ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP30, ATLAS_GCP_STREAM_PROCESSING_INSTANCE_SP50, ATLAS_GCP_STREAM_PROCESSING_DATA_TRANSFER, or ATLAS_GCP_STREAM_PROCESSING_PRIVATELINK.

      • startDate string(date-time)

        Date and time when MongoDB Cloud began charging for this line item. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

      • stitchAppName string

        Human-readable label that identifies the Atlas App Services application associated with this line item.

        Create a new Atlas App Service
      • tags object

        A map of key-value pairs corresponding to the tags associated with the line item resource.

        Hide tags attribute Show tags attribute object

        • * array[string] Additional properties

          A map of key-value pairs corresponding to the tags associated with the line item resource.

      • tierLowerBound number(double)

        Lower bound for usage amount range in current SKU tier.

        NOTE: lineItems[n].tierLowerBound appears only if your lineItems[n].sku is tiered.

      • tierUpperBound number(double)

        Upper bound for usage amount range in current SKU tier.

        NOTE: lineItems[n].tierUpperBound appears only if your lineItems[n].sku is tiered.

      • totalPriceCents integer(int64)

        Sum of the cost set for this line item. MongoDB Cloud expresses this value in cents (100ths of one US Dollar) and calculates this value as unitPriceDollars × quantity × 100.

      • unit string

        Element used to express what quantity this line item measures. This value can be elements of time, storage capacity, and the like.

      • unitPriceDollars number(double)

        Value per unit for this line item expressed in US Dollars.

    • linkedInvoices array[object]

      List that contains the invoices for organizations linked to the paying organization.
    • links array[object]

      List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

      Web Linking Specification (RFC 5988)
      Hide links attributes Show links attributes object

      • href string

        Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

      • rel string

        Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

    • orgId string

      Unique 24-hexadecimal digit string that identifies the organization charged for services consumed from MongoDB Cloud.

      Format should match the following pattern: ^([a-f0-9]{24})$.

    • payments array[object]

      List that contains funds transferred to MongoDB to cover the specified service noted in this invoice.

      Funds transferred to MongoDB to cover the specified service in this invoice.

      Hide payments attributes Show payments attributes object

      • amountBilledCents integer(int64)

        Sum of services that the specified organization consumed in the period covered in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

      • amountPaidCents integer(int64)

        Sum that the specified organization paid toward the associated invoice. This parameter expresses its value in cents (100ths of one US Dollar).

      • created string(date-time)

        Date and time when the customer made this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

      • currency string

        The currency in which payment was paid. This parameter expresses its value in 3-letter ISO 4217 currency code.

      • id string

        Unique 24-hexadecimal digit string that identifies this payment toward the associated invoice.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • salesTaxCents integer(int64)

        Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

      • statusName string

        Phase of payment processing for the associated invoice when you made this request. These phases include:

        • CANCELLED: Customer or MongoDB cancelled the payment.
        • ERROR: Issue arose when attempting to complete payment.
        • FAILED: MongoDB tried to charge the credit card without success.
        • FAILED_AUTHENTICATION: Strong Customer Authentication has failed. Confirm that your payment method is authenticated.
        • FORGIVEN: Customer initiated payment which MongoDB later forgave.
        • INVOICED: MongoDB issued an invoice that included this line item.
        • NEW: Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card.
        • PAID: Customer submitted a successful payment.
        • PARTIAL_PAID: Customer paid for part of this line item.

        Values are NEW, FORGIVEN, FAILED, PAID, PARTIAL_PAID, CANCELLED, INVOICED, FAILED_AUTHENTICATION, PROCESSING, PENDING_REVERSAL, or REFUNDED.

      • subtotalCents integer(int64)

        Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

      • unitPrice string

        The unit price applied to amountBilledCents to compute total payment amount. This value is represented as a decimal string.

      • updated string(date-time)

        Date and time when the customer made an update to this payment attempt. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • refunds array[object]

      List that contains payments that MongoDB returned to the organization for this invoice.

      One payment that MongoDB returned to the organization for this invoice.

      Hide refunds attributes Show refunds attributes object

      • amountCents integer(int64)

        Sum of the funds returned to the specified organization expressed in cents (100th of US Dollar).

      • created string(date-time)

        Date and time when MongoDB Cloud created this refund. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

      • paymentId string

        Unique 24-hexadecimal digit string that identifies the payment that the organization had made.

        Format should match the following pattern: ^([a-f0-9]{24})$.

      • reason string

        Justification that MongoDB accepted to return funds to the organization.

    • salesTaxCents integer(int64)

      Sum of sales tax applied to this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

    • startDate string(date-time)

      Date and time when MongoDB Cloud began the billing period that this invoice covers. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

    • startingBalanceCents integer(int64)

      Sum that the specified organization owed to MongoDB when MongoDB issued this invoice. This parameter expresses its value in US Dollars.

    • statusName string

      Phase of payment processing in which this invoice exists when you made this request. Accepted phases include:

      • CLOSED: MongoDB finalized all charges in the billing cycle but has yet to charge the customer.
      • FAILED: MongoDB attempted to charge the provided credit card but charge for that amount failed.
      • FORGIVEN: Customer initiated payment which MongoDB later forgave.
      • FREE: All charges totalled zero so the customer won't be charged.
      • INVOICED: MongoDB handled these charges using elastic invoicing.
      • PAID: MongoDB succeeded in charging the provided credit card.
      • PENDING: Invoice includes charges for the current billing cycle.
      • PREPAID: Customer has a pre-paid plan so they won't be charged.

      Values are PENDING, CLOSED, FORGIVEN, FAILED, PAID, FREE, PREPAID, or INVOICED.

    • subtotalCents integer(int64)

      Sum of all positive invoice line items contained in this invoice. This parameter expresses its value in cents (100ths of one US Dollar).

    • updated string(date-time)

      Date and time when MongoDB Cloud last updated the value of this payment. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

  • totalCount integer(int32)

    Total number of documents available. MongoDB Cloud omits this value if includeCount is set to false. The total number is an estimate and may not be exact.

    Minimum value is 0.

• 401 application/json

  Unauthorized.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

        A path that leads to a field in the request body.

  • detail string

    Describes the specific conditions or reasons that cause each type of error.

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 403 application/json

  Forbidden.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

        A path that leads to a field in the request body.

  • detail string

    Describes the specific conditions or reasons that cause each type of error.

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 404 application/json

  Not Found.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

        A path that leads to a field in the request body.

  • detail string

    Describes the specific conditions or reasons that cause each type of error.

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.

• 500 application/json

  Internal Server Error.

  Hide response attributes Show response attributes object

  • badRequestDetail object

    Bad request detail.

    Hide badRequestDetail attribute Show badRequestDetail attribute object

    • fields array[object]

      Describes all violations in a client request.

      Hide fields attributes Show fields attributes object

      • description string Required

        A description of why the request element is bad.

      • field string Required

        A path that leads to a field in the request body.

  • detail string

    Describes the specific conditions or reasons that cause each type of error.

  • error integer(int32) Required

    HTTP status code returned with this error.

    External documentation
  • errorCode string Required

    Application error code returned with this error.

  • parameters array[object]

    Parameters used to give more information about the error.
  • reason string

    Application error message returned with this error.