Saltar al contenido principal

/plan/{plan_id}

Consultar un plan

(GET /plan/<plan_id>)

Devuelve información asociada con el identificador del plan.

Respuesta - success

Get Plan Active

{
"description": "the plan has been retrieved",
"code": "0",
"type": "success",
"request_id": null,
"detail": "plan_retrieved",
"uuid": "8ee7cf68-9e22-4fd2-8da4-bfd919ca0750",
"payload": {
"amount": 100,
"fees": 12,
"description": "Annual playstation subscription",
"status": "active",
"name": "12654-playstation-subscription",
"expired_at": null,
"plan_id": "5976fc0dc928580001cc5dd8",
"custom_data": {
"dummy": "foo"
},
"method": {
"type": "card",
"token": "card-token-123456"
},
"periodicity": "1m",
"resource": "resource-example-key",
"currency": "EUR",
"deleted_at": null,
"customer": {
"taxid": "29724381D",
"reference": "client-123465",
"name": "John Doe Sullivan"
},
"start_date": "2016-01-25",
"external_id": "external-reference-123456"
}
}

Get Plan Deleted

{
"type": "success",
"uuid": "3543d5db-7894-45a0-9447-f38528f46633",
"description": "the plan has been retrieved",
"code": "0",
"request_id": null,
"detail": "plan_retrieved",
"payload": {
"custom_data": null,
"name": "Mensual - 1200",
"currency": "EUR",
"migrated": true,
"amount": 1200,
"status": "deleted",
"periodicity": "1m",
"external_id": "a090Y00000L6IBNQA3",
"resource": "sipay-test-recu-planner",
"plan_id": "5a899d5fc9faa700012c177b",
"start_date": "2018-03-15",
"fees": null,
"description": "Donación Recurrente Mensual - 12.00 - 0030Y000015vteyQAA",
"customer": {
"name": "ANGIE LIZETH CASTAÑO DUQUE",
"taxid": "23940174A",
"reference": "0030Y000015vteyQAA"
},
"method": {
"token": "777eb271242d46a9b05d857504bcb23f",
"type": "card",
"reference": "Cuota de ACNUR {recurrence} {month_name} {year} de {amount} {currency} - {customer_id}"
},
"deleted_at": "2018-03-05",
"events": [
{
"operations": [],
"completed_at": null,
"_id": "4b480070a4d34e2d84caafe136eefb03",
"suspended_at": null,
"sequence": 1,
"created_at": "2018-02-18",
"throw_at": "2018-03-15",
"recorded_at": null,
"updated_at": null
}
],
"expired_at": null
}
}