Billing

Endpoints related to credits, credit balance, and credit purchases.

Get credit balance and pricing

get

Fetches the authenticated account's remaining credits, the account email the credentials belong to, and current credit purchase pricing. Confirm the account email before purchasing credits, since credits are non-transferable between accounts.

Authorizations

blotato-api-keystringRequired

Responses

200

Credit balance, the account email, and credit purchase pricing

application/json

Credit balance, the account email, and credit purchase pricing

creditsRemainingintegerRequired

accountEmailstringRequired

pricePer1000CreditsUsdnumberRequired

401

Unauthorized

application/json

403

Forbidden

application/json

500

Default Response

application/json

get/v2/credits

GET /v2/credits HTTP/1.1
Host: backend.blotato.com
blotato-api-key: YOUR_API_KEY
Accept: */*

{
  "creditsRemaining": 54688,
  "accountEmail": "[e-mail]",
  "purchaseQuantityRange": {
    "min": 1000,
    "max": 10000
  },
  "pricePer1000CreditsUsd": 6
}

Buy credits

post

Creates a Stripe Checkout link the account owner opens in a browser to buy credits (quantity between 1000 and 10000). Creating a link never charges anything; payment happens only when a human completes checkout in the browser, and the purchased credits always land on this account.

Authorizations

blotato-api-keystringRequired

Body

quantityinteger · min: 1000 · max: 10000Required

referralstring · nullableOptional

Responses

201

A Stripe Checkout link to buy credits.

application/json

A Stripe Checkout link to buy credits.

checkoutUrlstringRequired

Stripe Checkout URL. The account owner opens this in a browser to complete payment. No charge occurs until checkout is completed.

400

Default Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Rate limit exceeded

application/json

500

Default Response

application/json

post/v2/credits

POST /v2/credits HTTP/1.1
Host: backend.blotato.com
blotato-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "quantity": 1,
  "referral": "text"
}

{
  "checkoutUrl": "https://checkout.stripe.com/c/pay/cs_test_123"
}