API - Planyo Web Services - get_reservation_payment_amount

You are here: Planyo » Help » API » get_reservation_payment_amount

get_reservation_payment_amount

Description:

This method returns payment information (total amount paid and number of payments made) for given reservation.

Input:

reservation_id int required
ID of the reservation
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

amount float
Total amount of all payments made for the reservation
payments int
Number of individual payments made
currency int
Currency used (3-letter ISO 4217 code)

API playground:

Click here to test this function in the API playground.
Planyo has a new Terms of Service and Privacy Policy, effective May 25, 2018. By using Planyo on or after this date you agree to the new conditions (the only change being GDPR compliance).