API de Planes

Para consultas contactate a pay@increase.app

Recurso para obtener los planes dados de alta en Increase Pay o crear nuevos planes

Cómo probar#

Recuerda usar la Base URL de Sandbox para hacer pruebas: https://gateway.increase.app/pay-sandbox/public/v1/

URL Producción: https://gateway.increase.app/pay/public/v1/

Recordar siempre enviar en los headers Content-Type: application/json

Crear un plan#

POST https://gateway.increase.app/pay/public/v1/plans

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>

Parámetro	Tipo	Descripción
product_id*	String	Id del producto asociado
type*	String	tipo de plan
name*	String	nombre del plan
cycle_amount*	Int	cantidad de ciclos
cycle_unit*	String	unidad de la cantidad de ciclos
currency	String	moneda
trial_period_days	Int	Período de prueba por defecto
country*	String	País en ISO 3166-1 alpha-3
collect_methods*	Object	Objeto de configuración de medios de pago que seran ofrecidos al cliente
amount	String	monto a cobrar para planes fijos o por volumen. Ejemplo: 100.0
charge_after_period	Boolean	Indica si debe cobrarse al inicio o al final del período.
tiers	Array	Niveles, solo para planes escalonados
taxes	Array	Impuestos asociados
one_time_costs	Array	Pagos únicos asociados.
discounts	Array	Descuentos asociados
external_id	String	Id para tu aplicación.
success_url	String	URL de exito `(https://www.tuempresa.com/gracias)`
automatic_subscription_request_approval*	Boolean	Indica si las suscripciones se aprueban automaticamente para este plan o requiere aprobacíon manual
charge_proportional	String	Indica en que momento se factura el cargo proporcional, si se factura junto al siguiente ciclo se debe enviar `"after_first_period"` y si se factura al instante debera enviar `"before_first_period"`
start_day	Int	Indica el dia del mes en que inicia el ciclo de facturacion

Los parámetros con * son obligatorios

Al crear un plan con sucess_url luego de que el cliente complete su medio de pago y se suscriba a dicho plan será redirigido de manera automática a la URL. Enviaremos también customer_id, subscription_id y payment_method_id

Los diferentes type que podras enviar al momento de crear tu plan son:

Parámetro	Tipo	Descripción
Flat	String	Plan fijo
VariableFlat	String	Plan variable, en este tipo de plan el `amount` debera enviarse en `0.0`
Usage	String	Plan por unidad
Graduated	String	Plan escalonado o escalonado con base
Volume	String	Plan por volumen

Collect methods#

El objeto collect_methods admite un solo collect_method por payment_category, excepto para los de tipo mercadopago, en cuyo caso admite todos los que hubieran.

{
  "card": [{"id": "..."}],
  "cbu": [{"id": "..."}],
  "ticket": []
}

Adicionales#

Todos los adicionales discounts, one_time_costs, taxes son de tipo array y admiten multiples ids de cada tipo.

"discounts": [
    {
      "id": "00000000-0000-0000-0000-000000000001"
    }
  ],
  "one_time_costs": [
    {
      "id": "00000000-0000-0000-0000-000000000001"
    }
  ],
  "taxes": [
    {
      "id": "00000000-0000-0000-0000-000000000001"
    }
  ]

Response#

{
  "id": "0c57bc90-a6dd-4040-b97f-e05d24d2c7a4",
  "name": "test",
  "amount": "0.0",
  "currency": "ARS",
  "cycle_unit": "monthly",
  "cycle_amount": 1,
  "type": "Volume",
  "country": "argentina",
  "collect_methods": {
    "card": [{
      "id": "7936a685-9eaa-4b33-be44-df4240c17412",
      "name": "collect method 3",
      "type": "mercadopago_connect",
      "status": "enabled",
      "country": "ARG",
      "max_payment_retries": 0,
      "retry_period_time": 0,
      "retry_period_unit": "days",
      "payment_categories": ["card"],
      "currencies": [
          "ARS"
      ],
      "public_key": "AAAAAAAAAA",
    }],
    "cbu": [{
      "id": "2ae4e61c-0382-4c67-86d0-85fd205823b3",
      "name": "collect method 3",
      "type": "supervielle",
      "status": "enabled",
      "country": "ARG",
      "max_payment_retries": 0,
      "retry_period_time": 0,
      "retry_period_unit": "days",
      "payment_categories": ["cbu"],
      "currencies": [
          "ARS"
      ],
      "metadata": {
          "company_code": "12345",
          "cuit": "20109753395",
          "id_size": 11
      }
    }],
    "ticket": []
  },
  "external_id": null,
  "trial_period_days": 7,
  "tiers": [
    {
      "minimum": 1,
      "maximum": 10,
      "amount": "10.0",
      "amount_type": "per_unit"
    },
    {
      "minimum": 11,
      "amount": "8.0",
      "amount_type": "per_unit"
    }
  ],
  "discounts": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "external_id": null,
      "name": "laboriosam fuga",
      "type": "flat",
      "amount": "97494.46",
      "currency": "ARS",
      "duration": "periodic",
      "cycle_unit": "monthly",
      "cycle_amount": 1,
      "created_at": "2020-03-27T17:23:11-03:00",
      "description": null
    }
  ],
  "one_time_costs": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "external_id": null,
      "name": "consequatur cumque",
      "amount": "18.61",
      "currency": "ARS"
    }
  ],
  "taxes": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "type": "flat",
      "name": "blanditiis fugit",
      "amount": "15090.15",
      "region": null,
      "created_at": "2020-03-27T17:23:11-03:00",
      "country": null,
      "description": null,
      "external_id": null
    }
  ],
  "charge_after_period": false,
  "product_id": "00000000-0000-0000-0000-000000000001",
  "start_day": 1,
  "charge_proportional": "after_first_period",
  "automatic_subscription_request_approval": true,
  "checkout_link": "https://pay.increase.app/checkout/8898b790-b8f4-44d0-b2db-10c4a881da63?plan_id=0c57bc90-a6dd-4040-b97f-e05d24d2c7a4&product_id=089859fc-5ed8-49fd-8749-aebcd3168b1d",
  "success_url": "https://increase.app/gracias"
}

Obtener todos los planes#

GET https://gateway.increase.app/pay/public/v1/plans

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>

Parámetros optativos#

Parámetro	Tipo	Descripción
Page	Integer	Indica la página a obtener resultados.
per_page	Integer	Cantidad de resultados por página (Máximo 40).
type	String	tipo de suscripción
product_id	String	id del producto

Success response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "possimus occaecati",
      "amount": "30.36",
      "currency": "ARS",
      "cycle_unit": "monthly",
      "cycle_amount": 1,
      "type": "flat",
      "country": "Argentina",
      "external_id": null,
      "trial_period_days": 7,
      "tiers": [],
      "discounts": [],
      "one_time_costs": [],
      "taxes": [],
      "charge_after_period": false,
      "product_id": "00000000-0000-0000-0000-000000000001",
      "automatic_subscription_request_approval": true,
      "checkout_link": "https://pay.increase.app/checkout/8898b790-b8f4-44d0-b2db-10c4a881da63?plan_id=0c57bc90-a6dd-4040-b97f-e05d24d2c7a4&product_id=089859fc-5ed8-49fd-8749-aebcd3168b1d",
      "success_url": "https://increase.app/gracias"
    }
  ],
  "current_page": 1,
  "per_page": 20,
  "total_pages": 1,
  "total_elements": 1
}

Obtener un plan específico#

GET https://gateway.increase.app/pay/public/v1/plans/<id>

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>

Actualizar un plan específico#

PUT https://gateway.increase.app/pay/public/v1/plans/<id>

Headers#

Content-Type: application/json
Authorization: Bearer <access_token>

Parámetro	Tipo	Descripción
name*	String	nombre del plan
trial_period_days	Int	Período de prueba por defecto
amount	String	monto a cobrar para planes fijos o por
external_id	String	Id para tu aplicación
success_url	String	URL de exito
taxes	Array	Impuestos asociados
one_time_costs	Array	Pagos únicos asociados.
discounts	Array	Descuentos asociados
collect_methods	Object	Objeto de configuración de medios de pago que seran ofrecidos al cliente