Getting Started

Introduction

The Recurrente API lets you create checkout sessions, manage your products, subscriptions, and customers, transfer money between different Recurrente accounts, and much more.

Getting Started

  • Create an account on Recurrente.
  • The API responds in JSON format. When it returns an error, the error is sent in an error key in JSON.

Base URL

https://app.recurrente.com/api

Quick Start

  1. Get your API keys from the Recurrente dashboard under Settings → API Keys
  2. Test your credentials with a simple GET request:
$curl https://app.recurrente.com/api/test \
>  -H "X-SECRET-KEY: your_secret_key"
  1. Create your first checkout:
$curl -X POST https://app.recurrente.com/api/checkouts \
>  -H "X-SECRET-KEY: your_secret_key" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "items": [{
>      "name": "T-Shirt",
>      "amount_in_cents": 15000,
>      "currency": "GTQ",
>      "quantity": 1
>    }],
>    "success_url": "https://yoursite.com/success",
>    "cancel_url": "https://yoursite.com/cancel"
>  }'

This returns a checkout_url — redirect your customer there to complete the payment.

For inline amounts, amount_in_cents must respect the currency minimum: 500 for GTQ (Q5) or 100 for USD ($1).

What can you do with the API?

FeatureDescription
CheckoutsCreate hosted payment pages
ProductsManage your catalog and pricing
SubscriptionsHandle recurring billing
CustomersTrack and manage your buyers
RefundsProcess refunds on payments
TransfersSend money between accounts
WebhooksGet notified about events

Sandbox and Test Payments

Each Sandbox is an isolated environment with its own members, TEST keys, webhooks, objects, activity, and simulated balances. You can test a subscription’s complete lifecycle—initial charge, renewal, decline, recovery, refund, and cancellation—without real money or LIVE data.

Use 4242 4242 4242 4242 for success or 4000 0000 0000 0002 for a decline. Normal events are delivered only to that Sandbox’s endpoints with live_mode: false and sandbox_id.

The complete public API is available: operations that normally contact a provider persist local simulations. To test only a webhook consumer, /test_helpers/webhook_events can emit any published event; to test behavior, use the real flow and its natural events.

See the Sandboxes guide to create an environment, use Test Clocks, and run the end-to-end scenario.

Need help?