Account
Buy credits
Create a Stripe Checkout link for a one-time credit pack purchase.
POST
https://api.rankparse.com/v1/checkoutFreeAPI keyCreates a Stripe Checkout session for a one-time credit purchase and returns its URL. Open the URL in a browser to pay. The credits are added to the workspace as purchased credits, which never expire, once the payment is confirmed. Only owners and admins can start a purchase. Credit packs are available on every plan.
Body parameters
creditsintegerrequiredNumber of credits to buy. A whole number of at least 100. Anything else returns 400 invalid_credits.
Response
urlstringThe Stripe Checkout URL.
Behavior
- Price: the whole purchase is priced at the tier for its size from Get pricing, in US dollars.
- When credits arrive: card payments add the credits as soon as Stripe confirms the payment. Delayed payment methods (bank debits, transfers) add them when the payment settles, not when the checkout completes.
- After paying, Stripe sends the buyer to
https://rankparse.com/dashboard?checkout=success; cancelling returns to the pricing page. - For hands-off top-ups, turn on auto recharge in the dashboard. See Credits.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | invalid_credits | credits is missing, not an integer, or below 100. |
| 401 | invalid_api_key | Missing, invalid or revoked API key. |
| 403 | capability_missing | Only owners and admins can buy credits. |
| 404 | user_not_found | The person the key acts as no longer exists. |
| 500 | checkout_failed | Stripe could not create the session. |