API ReferenceReference
Adjust a subscription's bonus credits
Grant (positive) or claw back (negative) bonus credits on the end user's subscription to this plan. Bonus credits sit outside the period allowance, survive the monthly reset, and are floored at zero.
Requires the end_users:write scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Storefront's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
endUserId*string
Format
uuidtierPlanId*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/end-users/497f6eca-6276-4993-bfeb-53cbbbba6f08/tier-plans/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "bonusCreditsDelta": -1000000 }'{ "ok": true, "bonusCredits": 0}