API Reference
  1. PhotoEditAPI
  2. Credits

Add credits

post
https://api.photoeditapi.com/v1/credits/add

Add credits to an end-user's balance. Designed for crediting purchases, trial grants, or promotions.

Idempotency: Each reference_id can only be applied once per tenant. Submitting the same reference_id a second time returns { "added": false, "reason": "already_added" } — safe to retry without risk of double-crediting.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 1

Number of credits to add. Must be greater than 0.

string
required

A unique identifier for this credit transaction — for example, your payment provider's charge ID or order ID. Used for idempotency and audit trails.

string
Defaults to Credit top-up

Optional label attached to the ledger entry.

Headers
string
required
^[a-zA-Z0-9_\-~]+$

A stable, unique identifier for the end-user making the request. Accepts alphanumeric characters, dashes (-), underscores (_), and tildes (~). This maps the request to the correct credit balance and output history.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?