PayPro API Reference (v1)

Servers
https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Pay methods

Operations

Customers

Operations

Mandates

Operations

Subscriptions

Operations

Retrieves a subscription

Request

Retrieves a single subscription based on the id.

Path
idstringrequired

Responses

subscription found

Bodyapplication/json
idstringrequired
Example: "PSV1QACRO4DSMQT0KK"
typestringrequired
Value"subscription"
Example: "subscription"
descriptionstringrequired
Example: "Test subscription"
subscription_typestring or nullrequired
Value"direct_debit"
Example: "direct_debit"
statestringrequired
Example: "active"
currencystringrequired
Value"EUR"
Example: "EUR"
created_atstring(date-time)required
Example: "2023-07-24T12:40:10Z"
start_atstring or null(date)required
cancel_atstring or null(date)required
customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
schedulingstring or null
Enum"manual""automatic"
Example: "automatic"
periodobject or nullrequired
Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}
period.​amountintegerrequired
Example: "1000"
period.​vatnumber[ 0 .. 100 ]required
Example: "21"
period.​multiplierintegerrequired
Example: 1
period.​intervalstringrequired
Enum"day""week""month""year"
Example: "month"
first_periodobject or nullrequired
Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}
first_period.​amountintegerrequired
Example: "1000"
first_period.​vatnumber[ 0 .. 100 ]required
Example: "21"
first_period.​multiplierinteger
Example: 1
first_period.​intervalstring
Enum"day""week""month""year"
Example: "month"
payment_detailsobjectrequired
Example: {"return_url":null,"cancel_url":null}
payment_details.​return_urlstring or null(uri)required
payment_details.​cancel_urlstring or null(uri)required
metadataobjectrequired
Example: {}
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK"
_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
_links.​checkoutstring(uri)
Response
application/json
{ "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", "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" } }

Updates a subscription

Request

Updates a Subscription object. Returns the updated Subscription

Path
idstringrequired
Bodyapplication/json
descriptionstring

Description of the subscription. This will be shown to customers and in the PayPro dashboard

Example: "description"
mandatestring

ID of the mandate for subscription. Only approved 'direct-debit' customer's mandates are supported.

periodobject

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.

Example: {"amount":1000}
first_periodobject or null

Settings for when the first period should be created and with what amount. These settings can only be updated if the Subscription has not started yet.

Responses

subscription updated

Bodyapplication/json
idstringrequired
Example: "PSV1QACRO4DSMQT0KK"
typestringrequired
Value"subscription"
Example: "subscription"
descriptionstringrequired
Example: "Test subscription"
subscription_typestring or nullrequired
Value"direct_debit"
Example: "direct_debit"
statestringrequired
Example: "active"
currencystringrequired
Value"EUR"
Example: "EUR"
created_atstring(date-time)required
Example: "2023-07-24T12:40:10Z"
start_atstring or null(date)required
cancel_atstring or null(date)required
customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
schedulingstring or null
Enum"manual""automatic"
Example: "automatic"
periodobject or nullrequired
Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}
period.​amountintegerrequired
Example: "1000"
period.​vatnumber[ 0 .. 100 ]required
Example: "21"
period.​multiplierintegerrequired
Example: 1
period.​intervalstringrequired
Enum"day""week""month""year"
Example: "month"
first_periodobject or nullrequired
Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}
first_period.​amountintegerrequired
Example: "1000"
first_period.​vatnumber[ 0 .. 100 ]required
Example: "21"
first_period.​multiplierinteger
Example: 1
first_period.​intervalstring
Enum"day""week""month""year"
Example: "month"
payment_detailsobjectrequired
Example: {"return_url":null,"cancel_url":null}
payment_details.​return_urlstring or null(uri)required
payment_details.​cancel_urlstring or null(uri)required
metadataobjectrequired
Example: {}
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK"
_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
_links.​checkoutstring(uri)
Response
application/json
{ "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", "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" } }

Cancels a subscription

Request

Cancels a subscription. A canceled subscription will no longer create new subscription periods.

It is not possible to resume a canceled subscription.

Path
idstringrequired

Responses

subscription canceled

Bodyapplication/json
idstringrequired
Example: "PSV1QACRO4DSMQT0KK"
typestringrequired
Value"subscription"
Example: "subscription"
descriptionstringrequired
Example: "Test subscription"
subscription_typestring or nullrequired
Value"direct_debit"
Example: "direct_debit"
statestringrequired
Example: "active"
currencystringrequired
Value"EUR"
Example: "EUR"
created_atstring(date-time)required
Example: "2023-07-24T12:40:10Z"
start_atstring or null(date)required
cancel_atstring or null(date)required
customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
schedulingstring or null
Enum"manual""automatic"
Example: "automatic"
periodobject or nullrequired
Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}
period.​amountintegerrequired
Example: "1000"
period.​vatnumber[ 0 .. 100 ]required
Example: "21"
period.​multiplierintegerrequired
Example: 1
period.​intervalstringrequired
Enum"day""week""month""year"
Example: "month"
first_periodobject or nullrequired
Example: {"amount":"1000","vat":"21","multiplier":1,"interval":"month"}
first_period.​amountintegerrequired
Example: "1000"
first_period.​vatnumber[ 0 .. 100 ]required
Example: "21"
first_period.​multiplierinteger
Example: 1
first_period.​intervalstring
Enum"day""week""month""year"
Example: "month"
payment_detailsobjectrequired
Example: {"return_url":null,"cancel_url":null}
payment_details.​return_urlstring or null(uri)required
payment_details.​cancel_urlstring or null(uri)required
metadataobjectrequired
Example: {}
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscriptions/PSV1QACRO4DSMQT0KK"
_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
_links.​checkoutstring(uri)
Response
application/json
{ "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", "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 periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations