Skip to main content
POST
billing.credit.record

Authorizations

Authorization
string
header
required

A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.

Headers

Idempotency-Key
string

Replays the stored response for the same key and input; refuses different input.

Body

application/json
amountCents
integer
required
Required range: x <= 100000000
kind
enum<string>
required

credit: off a future invoice. refund: money already taken, returned. adjustment: a correction to what was counted.

Available options:
credit,
refund,
adjustment
reason
string
required
Required string length: 3 - 500
period
string

The month it belongs to. Omitted means the next invoice, which is what most goodwill credits mean.

Pattern: ^\d{4}-\d{2}$

Response

{ activityId, result }. activityId is empty for reads.

activityId
string
required

The activity this call created, or empty for a read.

result
object
required
Last modified on September 13, 2026