Creates a new subscription (otherwise known as a regular donation) in Raisely. External applications may use this endpoint to import regular donations created offline into Raisely, as long as you have tokenised card details in Stripe.
To create a new subscription, you need to have a customer and card in Stripe, then set the source to OFFLINE. If you omit the nextPayment date, a payment will be taken immediately, otherwise it will be taken after the date specified.
Where preferred day scheduling is enabled, you may supply preferredDay for Stripe and Aplos Pay recurring gifts. When you supply preferredDay, also supply chargeToday. chargeToday is not required on its own. If you omit it while sending preferredDay, it defaults to true: Raisely attempts the first charge immediately and replaces any future nextPayment in the request. chargeToday: false defers the first charge to the next preferred day, which is always at least 7 days away.
You may also send chargeToday: true without preferredDay. Raisely attempts the first charge immediately, whether or not you send nextPayment, and replaces any future nextPayment in the request. Sending chargeToday: false without preferredDay returns HTTP 422, because there is no preferred day to defer the first charge to.
PayPal recurring gifts take their preferred day through POST /subscriptions/paypal/setup-complete, which anchors the PayPal subscription's start_time to the chosen day (again at least 7 days away). chargeToday is ignored there, because PayPal cannot take a payment separately from that anchor. Supplying preferredDay to this endpoint with method: PAYPAL still returns HTTP 422: that path imports a PayPal subscription whose billing cycle already exists and Raisely cannot move.
This endpoint must be authenticated.
Note: Raisely charges processing fees for imported subscriptions. Contact us for more information.
For custom components:
RaiselyComponents.api.all('subscriptions').post(data = {}, params = {}, headers = {}) => Promise<{result}>
See Restie Response Data for a more detailed overview of responses through the client wrapper
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||