Updates a Subscription object. Returns the updated Subscription
Description of the subscription. This will be shown to customers and in the PayPro dashboard
ID of the mandate for subscription. Only approved 'direct-debit' customer's mandates are supported.
Date at which the subscription will be canceled. When left empty, the subscription will be active until manually canceled
If true
, canceling a subscription will also cancel any open and reversed periods.
Settings for when new periods should be created and with which amounts. When the Subscription is active updates to these settings will only affect new periods.
subscription updated
{ "id": "PSV1QACRO4DSMQT0KK", "type": "subscription", "description": "Test subscription", "currency": "EUR", "subscription_type": "direct_debit", "state": "active", "start_at": null, "created_at": "2023-07-24T12:40:10Z", "cancel_at": null, "customer": "CU7JRN6W6K3DA9", "mandate": "MD6ULYXJ4HP9RJ", "scheduling": "automatic", "cancel_periods_on_cancellation": false, "period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "first_period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "payment_details": { "return_url": null, "cancel_url": null }, "metadata": {}, "_links": { "self": "https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ" } }
subscription canceled
{ "id": "PSV1QACRO4DSMQT0KK", "type": "subscription", "description": "Test subscription", "currency": "EUR", "subscription_type": "direct_debit", "state": "active", "start_at": null, "created_at": "2023-07-24T12:40:10Z", "cancel_at": null, "customer": "CU7JRN6W6K3DA9", "mandate": "MD6ULYXJ4HP9RJ", "scheduling": "automatic", "cancel_periods_on_cancellation": false, "period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "first_period": { "amount": "1000", "vat": "21", "multiplier": 1, "interval": "month" }, "payment_details": { "return_url": null, "cancel_url": null }, "metadata": {}, "_links": { "self": "https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK", "customer": "https://api.paypro.nl/customers/CU7JRN6W6K3DA9", "mandate": "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ" } }
subscriptions found
{ "type": "list", "data": [ { … } ], "count": 0, "_links": { "self": "http://example.com", "next": "http://example.com", "prev": "http://example.com" } }