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 list subscription periods that belong to this subscription

Request

Retrieves a list of subscription periods that belong to this subscription.

Path
idstringrequired

Responses

subscription periods found

Bodyapplication/json
typestringrequired
Value"list"
dataArray of objects(subscription_period)required
Example: [{"id":"SPD344S1PDY8XX","type":"subscription_period","amount":1500,"period_number":1,"subscription":"PSUJDW4VCMG9JS","state":"paid","payments":{"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}],"count":1,"_links":{"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"}},"created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX","subscription":"https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS"}}]
data[].​idstringrequired
Example: "SPD344S1PDY8XX"
data[].​typestringrequired
Value"subscription_period"
Example: "subscription_period"
data[].​amountintegerrequired
Example: 1500
data[].​period_numberintegerrequired
Example: 1
data[].​subscriptionstringrequired
Example: "PSUJDW4VCMG9JS"
data[].​statestringrequired
Enum"open""pending""paid""canceled""reversed""refunded"
Example: "paid"
data[].​paymentsobjectrequired
Example: {"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}],"count":1,"_links":{"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"}}
data[].​payments.​typestringrequired
Value"list"
Example: "list"
data[].​payments.​dataArray of objects(payment)required
Example: [{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}]
data[].​payments.​data[].​idstringrequired
Example: "PPH25H07JYWLR7PA82"
data[].​payments.​data[].​typestringrequired
Value"payment"
Example: "payment"
data[].​payments.​data[].​amountintegerrequired
Example: 1000
data[].​payments.​data[].​descriptionstringrequired
Example: "Test Payment"
data[].​payments.​data[].​currencystringrequired
Value"EUR"
Example: "EUR"
data[].​payments.​data[].​pay_methodpay_method (object) or null_type (any)required
Example: {"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}}
Any of:
data[].​payments.​data[].​pay_method.​idstringrequired
Example: "ideal"
data[].​payments.​data[].​pay_method.​typestringrequired
Value"pay_method"
Example: "pay_method"
data[].​payments.​data[].​pay_method.​namestringrequired
Example: "iDEAL"
data[].​payments.​data[].​pay_method.​currenciesArray of strings
Items Value"EUR"
Example: ["EUR"]
data[].​payments.​data[].​pay_method.​minimum_amountinteger
Example: 10
data[].​payments.​data[].​pay_method.​maximum_amountinteger
Example: 5000000
data[].​payments.​data[].​pay_method.​detailsobject
Example: {"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}
data[].​payments.​data[].​statestringrequired
Example: "paid"
data[].​payments.​data[].​refunded_amountintegerrequired
data[].​payments.​data[].​return_urlstring or null(uri)required
Example: "https://example.com/thank-you"
data[].​payments.​data[].​cancel_urlstring or null(uri)required
Example: "https://example.com/cancel"
data[].​payments.​data[].​metadataobjectrequired
Example: {}
data[].​payments.​data[].​customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
data[].​payments.​data[].​mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
data[].​payments.​data[].​subscriptionstring or nullrequired
data[].​payments.​data[].​installment_planstring or nullrequired
data[].​payments.​data[].​paid_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
data[].​payments.​data[].​created_atstring or null(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​payments.​data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
data[].​payments.​data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
data[].​payments.​data[].​_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
data[].​payments.​data[].​_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
data[].​payments.​data[].​_links.​subscriptionstring(uri)
data[].​payments.​data[].​_links.​installment_planstring(uri)
data[].​payments.​data[].​_links.​checkoutstring(uri)
data[].​payments.​countintegerrequired
Example: 1
data[].​payments.​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"}
data[].​payments.​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"
data[].​created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX","subscription":"https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS"}
data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX"
data[].​_links.​subscriptionstring(uri)required
Example: "https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS"
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" } }

Create a next period for this subscription

Request

Create a next period for this subscription

Path
idstringrequired
Bodyapplication/json
amountintegerrequired

The amount that the customer will have to pay in the next period.

Example: 1000
descriptionstring

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

Responses

subscription period created

Bodyapplication/json
idstringrequired
Example: "SPD344S1PDY8XX"
typestringrequired
Value"subscription_period"
Example: "subscription_period"
amountintegerrequired
Example: 1500
period_numberintegerrequired
Example: 1
subscriptionstringrequired
Example: "PSUJDW4VCMG9JS"
statestringrequired
Enum"open""pending""paid""canceled""reversed""refunded"
Example: "paid"
paymentsobjectrequired
Example: {"type":"list","data":[{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}],"count":1,"_links":{"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"}}
payments.​typestringrequired
Value"list"
Example: "list"
payments.​dataArray of objects(payment)required
Example: [{"id":"PPH25H07JYWLR7PA82","type":"payment","amount":1000,"description":"Test Payment","currency":"EUR","state":"paid","refunded_amount":0,"return_url":"https://example.com/thank-you","cancel_url":"https://example.com/cancel","paid_at":"2023-06-30T12:44:35Z","created_at":"2023-06-30T12:40:10Z","_links":{"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"}}]
payments.​data[].​idstringrequired
Example: "PPH25H07JYWLR7PA82"
payments.​data[].​typestringrequired
Value"payment"
Example: "payment"
payments.​data[].​amountintegerrequired
Example: 1000
payments.​data[].​descriptionstringrequired
Example: "Test Payment"
payments.​data[].​currencystringrequired
Value"EUR"
Example: "EUR"
payments.​data[].​pay_methodpay_method (object) or null_type (any)required
Example: {"id":"ideal","type":"pay_method","name":"iDEAL","currencies":["EUR"],"minimum_amount":10,"maximum_amount":5000000,"details":{"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}}
Any of:
payments.​data[].​pay_method.​idstringrequired
Example: "ideal"
payments.​data[].​pay_method.​typestringrequired
Value"pay_method"
Example: "pay_method"
payments.​data[].​pay_method.​namestringrequired
Example: "iDEAL"
payments.​data[].​pay_method.​currenciesArray of strings
Items Value"EUR"
Example: ["EUR"]
payments.​data[].​pay_method.​minimum_amountinteger
Example: 10
payments.​data[].​pay_method.​maximum_amountinteger
Example: 5000000
payments.​data[].​pay_method.​detailsobject
Example: {"issuers":[{"code":"ABNANL2A","name":"ABN AMRO"}]}
payments.​data[].​statestringrequired
Example: "paid"
payments.​data[].​refunded_amountintegerrequired
payments.​data[].​return_urlstring or null(uri)required
Example: "https://example.com/thank-you"
payments.​data[].​cancel_urlstring or null(uri)required
Example: "https://example.com/cancel"
payments.​data[].​metadataobjectrequired
Example: {}
payments.​data[].​customerstring or nullrequired
Example: "CU7JRN6W6K3DA9"
payments.​data[].​mandatestring or nullrequired
Example: "MD6ULYXJ4HP9RJ"
payments.​data[].​subscriptionstring or nullrequired
payments.​data[].​installment_planstring or nullrequired
payments.​data[].​paid_atstring or null(date-time)required
Example: "2023-06-30T12:44:35Z"
payments.​data[].​created_atstring or null(date-time)required
Example: "2023-06-30T12:40:10Z"
payments.​data[].​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/payments/PPH25H07JYWLR7PA82","customer":"https://api.paypro.nl/customers/CU7JRN6W6K3DA9","mandate":"https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"}
payments.​data[].​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/payments/PPH25H07JYWLR7PA82"
payments.​data[].​_links.​customerstring(uri)
Example: "https://api.paypro.nl/customers/CU7JRN6W6K3DA9"
payments.​data[].​_links.​mandatestring(uri)
Example: "https://api.paypro.nl/mandates/MD6ULYXJ4HP9RJ"
payments.​data[].​_links.​subscriptionstring(uri)
payments.​data[].​_links.​installment_planstring(uri)
payments.​data[].​_links.​checkoutstring(uri)
payments.​countintegerrequired
Example: 1
payments.​_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"}
payments.​_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX/payments"
created_atstring(date-time)required
Example: "2023-06-30T12:40:10Z"
_linksobjectrequired
Example: {"self":"https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX","subscription":"https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS"}
_links.​selfstring(uri)required
Example: "https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX"
_links.​subscriptionstring(uri)required
Example: "https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS"
Response
application/json
{ "id": "SPD344S1PDY8XX", "type": "subscription_period", "amount": 1500, "period_number": 1, "subscription": "PSUJDW4VCMG9JS", "state": "paid", "payments": { "type": "list", "data": [], "count": 1, "_links": {} }, "created_at": "2023-06-30T12:40:10Z", "_links": { "self": "https://api.paypro.nl/subscription_periods/SPD344S1PDY8XX", "subscription": "https://api.paypro.nl/subscriptions/PSUJDW4VCMG9JS" } }

Subscription periods

Operations

Installment plans

Operations

Installment plan periods

Operations

Events

Operations

Webhooks

Operations