Skip to main content

cpBillingCreditOverbill

Operator only. Close an over-billed charge (an I3 finding: its priced total fell below what was billed and written off). The billed part of the difference is credited to the payer (a wallet credit and a CREDIT event); a written-off part (an exempt org) was never paid, so no money moves and a WRITE_OFF event of the opposite sign (reason OVERBILL_REVERSAL) offsets it. creditedMicrousd is the wallet credit only. Idempotent per charge state.

cpBillingCreditOverbill(
appId: BigInt!
chargeId: String!
reason: String!
): BillingCreditResult!

Arguments​

cpBillingCreditOverbill.appId ● BigInt! non-null scalar​

App the charge was billed under.

cpBillingCreditOverbill.chargeId ● String! non-null scalar​

The HELD or SETTLED charge to credit, from billingCharges / the invariant detail.

cpBillingCreditOverbill.reason ● String! non-null scalar​

Operator note recorded on the credit; visible in billingWriteOffs.

Type​

BillingCreditResult object​