Organizations
Billing

Retrieve an organization's credit balance

Changed on

Retrieves the current credit balance for the specified organization. Credits can be applied during checkout to reduce the charge or automatically applied to upcoming recurring charges.

get/organizations/{organization_id}/billing/credits

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/organizations/{organization_id}/billing/credits
  • Auth: HTTP bearer

Path parameters

organization_idstring required

The ID of the organization whose credit balance to retrieve

Response

A payer's credit balance.

objectstring required

String representing the object's type. Always "commerce_credit_balance".

Changes