Skip to main content
POST
Redeem Credits
Redeems a specific number of credits from a subscriber’s balance after a valid request. This is typically used by builders after validating a request signature.

Example Usage

Parameters

  • planId: ID of the active payment plan
  • amount: Number of credits to redeem (BigInt)
  • proof: Signature or encoded proof provided with the query

Response

Notes

  • Credits will be deducted from the user’s plan balance
  • Will fail if credits are insufficient or the proof is invalid

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

planId
string
required

The unique identifier of the plan.

Response

200 - application/json

Redemption successful

success
boolean
creditsRedeemed
integer
remainingBalance
integer