Sign in
Users
Billing

Adjust a user's credit balance

Increases or decreases the credit balance for the specified user. Each adjustment is recorded as a ledger entry. The idempotency_key parameter ensures that duplicate requests are safely handled.

post/users/{user_id}/billing/credits

Path parameters

user_idstring required

The ID of the user whose credit balance to adjust

Request body

amountinteger required

The credit amount in cents. Must be greater than zero.

action'increase' | 'decrease' required

Whether to increase or decrease the credit balance.

currencystring

The currency code (e.g. "USD"). Defaults to USD if not provided.

idempotency_keystring required

A unique key to ensure the adjustment is applied only once. Repeated requests with the same key return the original ledger entry.

notestring

An optional note to attach to the ledger entry.

Response

A credit ledger entry.

objectstring required

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

idstring required

Unique identifier for the ledger entry.

payer_idstring required

The ID of the payer whose balance was adjusted.

source_typestring required

The type of source that originated the adjustment (e.g. "grant").

source_idstring required

The ID of the source that originated the adjustment.

notestring nullable

An optional note attached to the ledger entry.

created_atstring date-time required

Timestamp when the ledger entry was created.

Changes

Changed in 1 of the 15 revisions of this API.24

  • f0c01578648924See the full diff
    • ▲

      the amount response's property type/format changed from integer/int64 to object/ for status 200

      response-property-type-changed

    • ▲

      removed the required property currency from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property amount/amount to the response with the 200 status

      response-required-property-added

    • ○

      added the required property amount/amount_formatted to the response with the 200 status

      response-required-property-added

    • ○

      added the required property amount/currency to the response with the 200 status

      response-required-property-added

    • ○

      added the required property amount/currency_symbol to the response with the 200 status

      response-required-property-added