Os parâmetros passados aqui servem para filtrar os dados recebidos como resposta

HEADERS :

https://app.perfectpay.com.br/api/v1/subscriptions/get

EXEMPLO DE REQUISIÇÃO:

$sendData = [
    "subscription_status_enum" => 3,
    "customer_email"           => "[email protected]",
];
$ch       = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://app.perfectpay.com.br/api/v1/subscriptions/get');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($sendData));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer "TOKEN_API_GERADO_NA_PAY"',
]);
curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response     = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

PARÂMETROS:

subscription_status_enum

array

-

1  => 'Período de teste',
2  => 'Ativa',
3  => 'Cancelada',
4  => 'Aguardando pagamento'

recurrent_type_enum

array

-

1  => '7 dias',
2  => '15 dias',
3  => 'Mensal',
4  => 'Trimestral',
5  => 'Semestral',
6  => 'Anual',

customer_email

string

-

Email do cliente

page

int

-

Paginação do resultado

RESPOSTA 200 :

installments

Integer

Prestações

start_date_recurrent

Date

Data de criação da assinatura

end_date_recurrent

Date

Data de término da Assinatura

next_date_recurrent

Date

Data da próxima cobrança

canceled_date

Date

Data de cancelamento da assinatura

charges_made

Integer

Quantidade de cobranças

subscription_status_enum

Integer

Status da Assinatura

1  => 'Período de teste',
2  => 'Ativa',
3  => 'Cancelada',
4  => 'Aguardando pagamento'

subscription_status_detail

String

Detalhe do status

'new_subscription_purchased' => 'Cancelada devido a nova assinatura adquirida',
'attempt'                    => 'Tentativa de cobrança',
'cancelled_billing_error'    => 'Cancelada por erro na cobrança',
'active'                     => 'Assinatura Ativa',
'trial'                      => 'Assinatura em período teste',
'cancelled_by_customer'      => 'Assinatura cancelada pelo cliente',
'cancelled_by_producer'      => 'Assinatura cancelada pelo proprietário',
'error_charge'               => 'Problema na tentativa de cobrança',
'awaiting_payment'           => 'Aguardando pagamento',
'subscription_expired'       => 'Quantidade máxima de cobranças'

payment_type_enum

Integer

Tipo de Pagamento

0 => 'Sem opção de pagamento',
1 => 'Cartão de Crédito',
2 => 'Boleto',
3 => 'PayPal',
4 => 'Cartão de Crédito Recorrente',
5 => 'Venda Grátis',
6 => 'Cartão de Crédito - Upsell'

customer.email

String

E-mail do cliente

customer.full_name

String

Nome completo do cliente

product.name

String

Nome do produto

String

Nome do Plano

subscription_amount

Decimal

Valor da Assinatura

current_page

Integer

Página atual

current_items_count

Integer

Contagem dos itens atuais

total_pages

Integer

Total de páginas da pesquisa

total_items

Integer

Total de itens da pesquisa

recurrent_type_enum

String

'7 dias',
'15 dias',
'Mensal',
'Trimestral',
'Semestral',
'Anual',

SUCCESS-RESPONSE :

{
  "subscriptions": {
    "data": [
      {
        "id": 2,
        "recurrent_type_enum": "15 Dias",
        "installments": 1,
        "start_date_recurrent": "2019-07-05",
        "end_date_recurrent": null,
        "next_date_recurrent": "2019-07-22",
        "canceled_date": "2019-07-09",
        "charges_made": 3,
        "subscription_status_enum": "Cancelada",
        "subscription_status_detail": "cancelled_billing_error",
        "payment_type_enum": 1,
        "customer": {
          "email": "[email protected]",
          "full_name": "Cliente Teste"
        },
        "product": {
          "name": "Teste Recorrente"
        },
        "plan": {
          "name": "Produto Caps | 4 Potes"
        },
        "subscription_amount": "R$ 5,00"
      },
      {
        "id": 1965,
        "recurrent_type_enum": "7 Dias",
        "installments": 1,
        "start_date_recurrent": "2019-11-05",
        "end_date_recurrent": null,
        "next_date_recurrent": "2019-12-11",
        "canceled_date": "2019-11-13",
        "charges_made": 4,
        "subscription_status_enum": "Ativa",
        "subscription_status_detail": "active",
        "payment_type_enum": 1,
        "customer": {
          "email": "[email protected]",
          "full_name": "Cliente Full Name"
        },
        "product": {
          "name": "Teste Recorrente"
        },
        "plan": {
          "name": null
        },
        "subscription_amount": "R$ 5,00"
      }
    ],
    "current_page": 1,
    "current_items_count": 2,
    "total_pages": 1,
    "total_items": 2
  }
}