v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB

Billing

Get Prepaid Credits Billing

Retrieves prepaid credits information for the organization, including credit details, usage, and remaining amounts.

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

Organization Owner

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

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

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

Response

Successfully retrieved the prepaid credits billing information.

Example response

{
  "data": [
    {
      "id": "sfdc-credit-id-12345",
      "creditName": "CN-12345",
      "supportPlan": "Plan: Developer Pro",
      "startDate": "2024-01-01T00:00:00Z",
      "expirationDate": "2024-12-31T23:59:59Z",
      "total": 1000,
      "used": 350.5,
      "remaining": 649.5,
      "remainingPercent": 64.95
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}