Subscriptions
Cancel subscription
https://rcur.app/api/v2/subscriptions/{id}
Requires your API key as Authorization: Bearer <key>. See authentication.
Path parameters
-
idstring required
Request body
application/jsonCancellation data
-
cancel_atstringDate to cancel at (Y-m-d). If omitted or in the past, cancels immediately.
Responses
200 Subscription details Subscription object
-
idstring required -
namestring required -
statusstring requiredOne of
draftactivepausedcancelledcompleted -
start_datestring required -
mollie_mandate_idstring -
mollie_profile_idstring -
next_payment_atstring nullable -
next_amountstring nullable -
last_payment_created_atstring nullable -
resume_atstring nullable -
cancel_atstring nullable -
customer_portalstringCan the customer pause and cancel this subscription in the customer portal: inherit follows the customer portal settings, allow and deny overrule them
One of
inheritallowdeny -
created_atstring required -
rulesarray of SubscriptionRules8 child attributes · SubscriptionRule
-
idstring required -
amountstring required -
currencystring requiredOne of
AEDAUDBGNBRLCADCHFCZKDKKEURGBPHKDHUFILSISKJPYMXNMYRNOKNZDPHPPLNRONSEKSGDTHBTWDUSDZAR -
intervalstring requiredOne of
dayweekmonthyear -
interval_amountinteger required -
dayinteger required -
timesinteger nullable -
times_doneinteger required
-
-
customerobject
404 Resource not found Error object
-
statusinteger required -
errorstring required