API reference
API reference
Every endpoint of the RCUR API, generated from the source code. All requests go to
https://rcur.app
and need an API key.
Customers
The people and companies you collect payments from.
Payment Links
Shareable links where customers pay once or sign up for a subscription.
Subscriptions
Recurring payments on a schedule, charged through Mollie.
- get /api/v2/subscriptions List subscriptions
- post /api/v2/subscriptions Create subscription
- get /api/v2/subscriptions/{id} Show subscription
- put /api/v2/subscriptions/{id} Update subscription
- del /api/v2/subscriptions/{id} Cancel subscription
- post /api/v2/subscriptions/{subscriptionId}/discount Apply discount to subscription
- del /api/v2/subscriptions/{subscriptionId}/discount Remove discount from subscription
Follow-ups
Automatic retries and reminders for payments that failed.
Orders
Orders placed through payment links and subscriptions.
Payments
Individual payments, including one-off charges on a mandate.
Mandates
Permissions to charge a customer's bank account or card.
Products
The products you sell, with their price and VAT.
Organization
Your own RCUR account and its Mollie profiles.
Subscription groups
- get /api/v2/subscription-groups List subscription groups
- post /api/v2/subscription-groups Create subscription group
- get /api/v2/subscription-groups/{id} Show subscription group
- put /api/v2/subscription-groups/{id} Update subscription group
- del /api/v2/subscription-groups/{id} Delete subscription group
- get /api/v2/subscription-templates List subscription templates
- get /api/v2/subscription-templates/{id} Show subscription template
- get /api/v2/subscriptions/{subscriptionId}/plan Show the plans a subscription can switch to
- post /api/v2/subscriptions/{subscriptionId}/plan Switch a subscription to another plan
- del /api/v2/subscriptions/{subscriptionId}/plan Withdraw a planned switch
Custom fields
Discount codes
Objects
The resources the API returns, with all their fields.
CustomField
CustomFieldValue
Customer
Discount
Error
Followup
Link
Mandate
MollieProfile
Order
OrderProduct
Organization
Payment
PaymentCreated
Product
Subscription
SubscriptionDiscount
SubscriptionGroup
SubscriptionPlanChange
SubscriptionPlanOptions
SubscriptionRule
SubscriptionTemplate
ValidationError