POST /api/action/network-v1/update-suscription

PROD

Este webservice se usa para actualizar la suscripción del usuario en la red. La información de los usuarios debe obtenerse mediante el servicio network/query-customers.

Información del recurso
Autenticación	Requerida
Scope	`network-suscription`
Método HTTP	POST
Respuesta	JSON
Versión	1

URL del recurso

https://mapaprop.app/api/action/network-v1/update-suscription

Parámetros

Clave	Tipo	Requerido	Descripción
agencyId	string	sí	El ID de la inmobiliaria provisto por los webservices GET /api/action/feed-v1/get-properties o GET /api/action/feed-v1/get-delta de la Feeds API. Formato: `ECID0011126701EN`
planDescription	string	sí	Una descripción de la suscripción del usuario. Por ejemplo "Plan Plus 5 Publicaciones". Este texto se muestra al cliente.
planMaxPublications	int	sí	El número máximo de publicaciones permitidas por el plan. Enviá 0 (cero) para bloquear al usuario.
planCost	string	sí	El costo de la suscripción. Es un string libre, por lo que debés incluir el signo y la moneda. Este texto se muestra al usuario.
planBillingCycle	string	sí	Indica el ciclo de facturación del plan, por ejemplo "Semanal", "Mensual". Este texto se muestra al usuario.
planUpgradeURL	string	sí	La URL donde el usuario puede hacer clic para mejorar, cancelar o modificar su suscripción.
listingURL	string	sí	La URL de tu red con todas las propiedades del usuario. Por ejemplo http://tusitio.com/nelson-propiedades
accountStatus	string	sí	Un texto que indica el estado actual de la cuenta. Útil para mostrar si el usuario tiene un pago pendiente, la cuenta suspendida o el saldo disponible.

Código de ejemplo

POST /api/action/network-v1/update-suscription HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

agencyId=ECID001126701EN&planDescription=PLUS%2010&planMaxPublications=10&planCost=%24%2033&planBillingCycle=SEMANAL
&planUpgradeURL=https%3A%2F%2Fmysite.com%2Fupgrade%3FagencyId%3DAIGIGI
&listingURL=https%3A%2F%2Fmysite.com%2Fjulian-inmobiliaria
&accountStatus=AL%20DIA

Respuesta

La respuesta JSON indica si la suscripción fue actualizada. En caso contrario, un código de error indica qué ocurrió.

Objeto	Campo	Tipo	Requerido	Descripción
Response	success	boolean	sí	Un booleano que indica si la actualización fue exitosa o no
	error	string	no	Un texto que indica el tipo de error cuando success == false

Códigos de error

Error	Causa
`CHECK_YOUR_INPUT`	Falta un parámetro requerido (por ejemplo agencyId, planDescription o planMaxPublications)
`INVALID_AGENCY_ID`	El agencyId no es válido
`CUSTOMER_DOES_NOT_HAVE_NETWORK`	El cliente no es miembro de tu red

Código de ejemplo

{
    "success": false,
    "error": "CUSTOMER_DOES_NOT_HAVE_NETWORK"
}