Pagamentos Recorrentes – Endpoint da API REST

Pagamentos Recorrentes estende a API RESTful existente integrada ao Easy Digital Downloads. Ela pode ser acessada em

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN

Observação: certifique-se de substituir example.com pelo seu próprio endereço e os valores de chave e token pelos seus.

O exemplo acima retornará uma lista de todas as assinaturas existentes na loja.

Entrada

A API REST de Pagamentos Recorrentes aceita 3 opções além de chave e token: customer, number e paged.

Cliente

A entrada para um cliente pode ser um inteiro representando um customer_id ou um endereço de e-mail. A URL resultante se parecerá com isto:

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&customer=2

ou

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&[email protected]

Número

A opção number aceita um inteiro e retorna essa quantidade de resultados. Um exemplo seria assim:

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=5

Paginado

A opção paged permite que você escolha uma fatia de um número maior. Por exemplo, se você tem 100 entradas e usa number=10, você pode passar paged=2 e obter as linhas 11-20. Isso se pareceria com isto:

https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=10&paged=2

Saída

A saída para cada assinatura contém todas as informações sobre essa assinatura, bem como sobre o cliente e cada pagamento de renovação (filho). Adicionalmente, há um valor indicando o tempo gasto para obter as informações de todos os resultados. Exemplo:

{
    "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
}