Creates a Installment plan object.
After you have created a Installment plan, it will start immediately when mandate is given. When pay_methods are given you need to redirect the customer to the checkout link in the links
section.
ID of the customer for installment plan. Cannot be used together with a mandate
.
Description of the installment plan. This will be shown to customers
Pay methods that can be used to start the subscription. Using this creates the subscription with the authorization
flow and will start the subscription when the first payment is paid. Use the checkout link in the links
field to redirect the customer. Cannot be used together with a mandate
.
Settings for when new periods should be created and with which amounts
The vat included in the amount. Accepted values: from 0 till 30
installment plan created
{ "id": "PIV1QACRO4DSMQT0KK", "type": "installment_plan", "description": "Test installment plan", "currency": "EUR", "installment_plan_type": "direct_debit", "state": "active", "created_at": "2023-07-24T12:40:10Z", "customer": "CU7JRN6W6K3DA9", "mandate": "MDC7XX65BH42PW", "period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "first_period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "number_of_periods": 5, "payment_details": { "return_url": null, "cancel_url": null }, "metadata": {}, "_links": { "self": "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MDC7XX65BH42PW" } }
installment plan found
{ "id": "PIV1QACRO4DSMQT0KK", "type": "installment_plan", "description": "Test installment plan", "currency": "EUR", "installment_plan_type": "direct_debit", "state": "active", "created_at": "2023-07-24T12:40:10Z", "customer": "CU7JRN6W6K3DA9", "mandate": "MDC7XX65BH42PW", "period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "first_period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "number_of_periods": 5, "payment_details": { "return_url": null, "cancel_url": null }, "metadata": {}, "_links": { "self": "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MDC7XX65BH42PW" } }
Description of the installment plan. This will be shown to customers and in the PayPro dashboard
ID of the mandate for installment plan. Only approved 'direct-debit' customer's mandates are supported.
Settings for when new periods should be created and with which amounts. When the Installment plan is active updates to these settings will only affect new periods.
installment plan updated
{ "id": "PIV1QACRO4DSMQT0KK", "type": "installment_plan", "description": "Test installment plan", "currency": "EUR", "installment_plan_type": "direct_debit", "state": "active", "created_at": "2023-07-24T12:40:10Z", "customer": "CU7JRN6W6K3DA9", "mandate": "MDC7XX65BH42PW", "period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "first_period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "number_of_periods": 5, "payment_details": { "return_url": null, "cancel_url": null }, "metadata": {}, "_links": { "self": "https://api.paypro.nl/installment_plans/PIV1QACRO4DSMQT0KK", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MDC7XX65BH42PW" } }