Recurly API

What authentication does the Recurly API use?

The Recurly API uses Bearer token authentication. Pass your private API key in the Authorization header as 'Bearer {api_key}'. Keys are site-specific and can be generated in the Recurly admin console. Through Jentic, your Recurly API key is stored encrypted in your Jentic One instance - agents authenticate without seeing the raw token.

Can I handle failed payment retries with the Recurly API?

Yes. Recurly's dunning system automatically retries failed payments on a configurable schedule. You can list past-due subscriptions via GET /subscriptions filtering by state, retrieve their invoices via GET /invoices/{invoice_id}, and trigger manual collection attempts. The subscription state transitions through active > past_due > canceled based on dunning outcomes.

What are the rate limits for the Recurly API?

Recurly applies rate limits of 2000 requests per minute per site for API v3. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response. If exceeded, the API returns HTTP 429 with a Retry-After header indicating when to retry.

How do I create a subscription through the Recurly API via Jentic?

Search Jentic for 'create a Recurly subscription' to find the POST /subscriptions operation. Required fields are plan_code (identifying the billing plan) and account (with account_code and billing_info). Optional fields include coupon_codes, starts_at for future-dated subscriptions, and trial_ends_at. Jentic loads the full schema automatically. Run it through Jentic One, the self-hosted execution layer.

Does the Recurly API support multi-currency billing?

Yes. Plans can be configured with pricing in multiple currencies. When creating a subscription, the currency is determined by the account's billing info or can be explicitly set. Invoices are generated in the subscription's currency with appropriate tax calculations. The GET /plans endpoint returns all configured currency amounts for each plan.

Can I cancel and reactivate subscriptions through the API?

Yes. PUT /subscriptions/{subscription_id}/cancel cancels a subscription at the end of the current billing period (the subscriber retains access until period end). PUT /subscriptions/{subscription_id}/reactivate restores a canceled subscription before it expires. Both endpoints return the updated subscription object with the new state.

Can I limit what my agent is allowed to do with the Recurly API?

Yes. Because you run Jentic One yourself, your own rules decide which Recurly operations the agent may call and which credentials it may use, so you can allow read-only calls like GET /invoices/{invoice_id} while withholding state changes such as PUT /subscriptions/{subscription_id}/cancel or POST /subscriptions. Since Recurly puts the subscription id in the URL path, a rule can also pin the agent to specific subscriptions rather than the whole account. Cancellation and reactivation are only available to the agent if you explicitly add those operations.