COcouchbase
Billing

Get Pay As You Go Billing

Retrieves pay-as-you-go billing information for the organization within the specified date range, broken down by support plan type.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Billing Admin
  • Billing Viewer

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/billing/payAsYouGo

Request

Query parameters

startDatestring date

The start date of the billing period in YYYY-MM-DD format.

endDatestring date

The end date of the billing period in YYYY-MM-DD format.

Response

Successfully retrieved the pay-as-you-go billing information.

Example response

{
  "data": {
    "periods": [
      {
        "startDate": "2025-04-01",
        "endDate": "2025-04-30",
        "cost": {
          "basic": 100,
          "devPro": 316.62,
          "enterprise": 150
        },
        "total": 466.62
      }
    ],
    "total": {
      "startDate": "2025-04-01",
      "endDate": "2025-05-31",
      "cost": {
        "basic": 100,
        "devPro": 316.62,
        "enterprise": 150
      },
      "total": 1216.87
    },
    "billingCurrency": "USD"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.