Skip to main content
Use these endpoints when an integration needs to identify the active API key, check whether enough credits are available, show current pricing, or send a user to Stripe checkout or the billing portal.

​
Endpoints

MethodPathPurpose
GET/meFetch the account identity for the active API key.
GET/creditsFetch available balance and credit package data.
GET/billing/catalogFetch subscription and top-up pricing.
POST/billing/checkoutCreate a Stripe checkout URL.
GET/billing/manageCreate a billing portal URL.
Full request and response schemas are in API reference.

​
Account identity

curl https://api.youka.io/api/v1/me \
  -H "Authorization: Bearer yk_..."
The response includes email, userId, and apiKeyId. Use it at startup to verify that an automation is running under the intended account.

​
Credits

curl https://api.youka.io/api/v1/credits \
  -H "Authorization: Bearer yk_..."
The response includes availableBalance, upcoming renewal dates, top-up credit packages, and subscription renewal metadata.

​
Billing catalog

curl https://api.youka.io/api/v1/billing/catalog \
  -H "Authorization: Bearer yk_..."
Use the catalog response to display current unit credits, allowed quantities, subscription pricing, top-up eligibility, and active subscription state.

​
Checkout

curl -X POST https://api.youka.io/api/v1/billing/checkout \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "productType": "subscription",
    "cycle": "monthly",
    "quantity": 1,
    "platform": "api"
  }'
For top-ups, pass "productType": "topup" and a positive quantity. Subscriptions also require cycle as monthly or yearly.

​
Billing portal

curl "https://api.youka.io/api/v1/billing/manage?platform=api" \
  -H "Authorization: Bearer yk_..."
The returned URL is short-lived and should be opened by the account owner.

​
What’s next

  • Projects - quote credits before creating a project
  • Exports - quote credits before rendering
  • Errors - handle authentication and billing errors