PayPro API Reference (v1)

Servers

https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Pay methods

Operations

Customers

Operations

Mandates

Operations

Subscriptions

Operations

Creates a subscription

Request

Creates a Subscription object.

After you created the subscription it will either be started immediately or at the start_date when a mandate was given. When pay_methods are given you need to redirect the customer to the checkout link in the links section.

Security
apiKey
Bodyapplication/json
customerstringrequired

ID of the customer that subscribes. Cannot be used together with a mandate.

Example: "CUW78XU8BYL8X6"
descriptionstringrequired

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

Example: "description"
mandatestring or null

Mandate that will be used for the subscription. Using this will start the subscription immediately. Cannot be used together with the pay_methods field.

currencystringrequired

The currency of the subscription. Only 'EUR' is supported

Example: "EUR"
start_atstring or null

Date when the subscription will start. When left empty, it will start at creation

Example: "2023-08-01"
cancel_atstring or null

Date at which the subscription will be canceled. When left empty, the subscription will be active until manually canceled

pay_methodsArray of strings or null

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.

Enum"bancontact""bank-transfer""creditcard""direct-debit""ideal""ideal-qr""klarna-paynow"
Example: ["creditcard","direct-debit","ideal"]
payment_detailsobject

Fields to be passed to the authorization payment.

periodobjectrequired

Settings for when new periods should be created and with which amounts

Example: {"amount":1000,"vat":21,"multiplier":1,"type":"month"}
period.​amountinteger

The amount in cents that the customer will have to pay.

Example: 1000
period.​vatnumber or null

The vat included in the amount. Accepted values: from 0 till 30

Example: 21
period.​intervalstring

The interval of each period. Accepted values: day, week, month or year

period.​multiplierinteger

The multiplier of the interval between periods. Example: interval=month and mulitplier=3 will create a new period every 3 months.

Example: 1
first_periodobject or null

Settings for when the first period should be created and with what amount

metadataobject or null

You can put in random data that you like to save alongside the subscription. When you fetch the subscription this will be returned in the metadata field.

Responses

subscription created

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"
cancel_periods_on_cancellationboolean
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",
  "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"
  }
}

Pauses a subscription

Request

Pauses a subscription. A paused subscription will no longer create new subscription periods.

You can resume the subscription by calling the /subscriptions/:id/resume endpoint.

Security
apiKey
Path
idstringrequired

Responses

subscription paused

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"
cancel_periods_on_cancellationboolean
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",
  "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"
  }
}

Resumes a paused subscription

Request

Resumes a paused subscription. The paused subscription will return to the active state and will resume creating new subscription periods.

It is not possible to resume a canceled subscription.

Security
apiKey
Path
idstringrequired

Responses

subscription resumes

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"
cancel_periods_on_cancellationboolean
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",
  "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 periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations

Payouts

Operations

Top-ups

Operations