Pagos recurrentes extiende la API REST existente integrada en Easy Digital Downloads. Se puede acceder en
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN
Nota: asegúrate de reemplazar example.com con tu propia dirección y los valores de clave y token con los tuyos.
El ejemplo anterior devolverá una lista de todas las suscripciones existentes en la tienda.
Entrada
La API REST de Pagos recurrentes acepta 3 opciones además de clave y token: customer, number y paged.
Cliente
La entrada para un cliente puede ser un entero que represente un customer_id o una dirección de correo electrónico. La URL resultante se parecerá a esto:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&customer=2
o
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&[email protected]
Número
La opción number acepta un entero y devuelve esa cantidad de resultados. Un ejemplo se vería así:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=5
Paginado
La opción paged te permite elegir una porción de un número mayor. Por ejemplo, si tienes 100 entradas y usas number=10, podrías pasar paged=2 y obtener las filas 11-20. Eso se vería así:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=10&paged=2
Salida
La salida de cada suscripción contiene toda la información sobre esa suscripción, así como sobre el cliente y cada pago de renovación (hijo). Además, hay un valor que indica el tiempo empleado en obtener la información para todos los resultados. Ejemplo:
{
"subscriptions": [
{
"info": {
"u0000EDD_Subscriptionu0000subs_db": {
"table_name": "wp_edd_subscriptions",
"version": "1.0",
"primary_key": "id"
},
"id": "1",
"customer_id": "2",
"period": "month",
"initial_amount": "50.00",
"recurring_amount": "50.00",
"bill_times": "0",
"parent_payment_id": "87",
"product_id": "85",
"created": "2016-03-15 15:36:30",
"expiration": "2016-04-15 23:59:59",
"status": "active",
"profile_id": "paypal-363e3cc178dab152bb59b958024bce75",
"gateway": "paypal",
"customer": {
"id": "2",
"purchase_count": "2",
"purchase_value": "20.000000",
"email": "[email protected]",
"name": "Jane Doe",
"date_created": "2016-03-07 22:33:44",
"payment_ids": "16",
"user_id": "3",
"notes": [
]
}
},
"payments": [
{
"id": 106,
"amount": 10.36,
"date": "March 21, 2016",
"status": "Renewal"
},
{
"id": 105,
"amount": 10,
"date": "March 21, 2016",
"status": "Renewal"
},
{
"id": 104,
"amount": 10,
"date": "March 21, 2016",
"status": "Renewal"
}
]
}
],
"request_speed": 0.076335906982422
}
