PayPro API Reference (v1)

Servers
https://api.paypro.nl/

Payments

Operations

Refunds

Operations

Chargebacks

Operations

Pay methods

Operations

Customers

Operations

Retrieves a list of subscriptions that belong to this customer

Request

Retrieves a list of subscriptions that belong to this customer.

Path
idstringrequired

Responses

subscriptions found

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

Retrieves a list of mandates that belong to this customer

Request

Retrieves a list of mandates that belong to this customer.

Path
idstringrequired

Responses

mandates found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(mandate)required
Example: [{"id":"MDQVT0CGB8Z5JK","type":"mandate","state":"pending","customer":"CUWSWVVPTL94VX","pay_method":"direct-debit","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK","customer":"https://api.paypro.nl/customers/CUWSWVVPTL94VX"}}]
data[].​idstringrequired
Example: "MDQVT0CGB8Z5JK"
data[].​typestringrequired
Value"mandate"
Example: "mandate"
data[].​statestringrequired
Example: "pending"
data[].​customerstringrequired
Example: "CUWSWVVPTL94VX"
data[].​pay_methodstringrequired
Example: "direct-debit"
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK","customer":"https://api.paypro.nl/customers/CUWSWVVPTL94VX"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/mandates/MDQVT0CGB8Z5JK"
data[].​_links.​customerstring(uri)required
Example: "https://api.paypro.nl/customers/CUWSWVVPTL94VX"
countintegerrequired
_linksobjectrequired
_links.​selfstring(uri)required
_links.​nextstring(uri)
_links.​prevstring(uri)
Response
application/json
{
  "type": "list",
  "data": [
    { … }
  ],
  "count": 0,
  "_links": {
    "self": "http://example.com",
    "next": "http://example.com",
    "prev": "http://example.com"
  }
}

Mandates

Operations

Subscriptions

Operations

Subscription periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations