API · Subscriber payments

POST /api/v1/getSuscriptorPayments

What it does#

Returns the payments of the subscribers of a recurring plan.

Authentication#

Requires the API bearer token in the Authorization header — see authentication.

Parameters#

Request example#

The <...> values are placeholders: replace them with your own credentials and data.

{
  "key": "<api_key>",
  "id": "1"
}

Response#

{
  "type": "200",
  "message": "Success",
  "data": [
    {
      "id": 150,
      "commerce_id": 37,
      "suscriptor_id": 86,
      "reference": "0",
      "currency": "USD",
      "amount": "0.00",
      "status": 0,
      "data": "{\"first\":1,\"expire\":\"2024-12-28T19:05:29.572648Z\",\"amount\":0,\"activeAmount\":0,\"originalAmount\":0,\"key\":\"XXXX-XXXX-XXXX-XXXX-XXXX\"}",
      "create": "2024-12-13 13:05:06"
    }
  ]
}

The data field of each payment is a string containing JSON, not an object: it has to be deserialized separately after deserializing the response. The key inside it is the integration key; it is masked here. The creation date comes in create, in Y-m-d H:i:s format — see response conventions.

To interpret a response that is not a success, see how to read an error response.