Users
Billing

Retrieve a user's credit balance

Changed on

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

get/users/{user_id}/billing/credits

Request

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

Path parameters

user_idstring required

The ID of the user whose credit balance to retrieve

Response

A payer's credit balance.

objectstring required

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

Changes