Recurring Payments

[v2.0] Recurring Payment Status

Returns the status of a recurring payment for the PreKey specified.

get/v2.0/recurring_payment/{preKey}

Request

  • Base URL: https://api.jvzoo.com
  • URL: https://api.jvzoo.com/v2.0/recurring_payment/{preKey}
  • Auth: HTTP basic

Path parameters

preKeystring required

The key used for that payment.

Response

Success

Example response

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success"
    },
    "results_count": 1,
    "api_version": "2.0"
  },
  "results": [
    {
      "id": 123456,
      "status": "ACTIVE",
      "current_payments": 6,
      "max_number_of_payments": 13,
      "max_total_of_all_payments": "37.00",
      "max_amount_per_payment": "3.00",
      "next_payment": "3.00",
      "paypal_email": "email@domain.com",
      "contact_email": "email@domain.com",
      "price": "3.00",
      "payment_period": 1,
      "payment_count": 12,
      "payment_first_payout": "0.25",
      "has_payment_trial": true,
      "payment_trial_price": "1.00",
      "payment_trial_period": 3,
      "payment_trial_payout": "0.5",
      "current_payments_amount": "16.00",
      "created": "2015-06-19T13:12:44+00:00",
      "preKey": "PA-1234567890ABCDEFG",
      "sender_email": "email@domain.com",
      "last_date": "2015-10-23T04:00:00+00:00",
      "next_date": "2015-11-23T05:00:00+00:00",
      "ip": "1.1.1.1",
      "referrer": "https://www.domain.com",
      "product_id": 123456
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.