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 staging para hacer pruebas: https://gateway.staging.increase.app/pay/public/v1/

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
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
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

Response

  "id": "0c57bc90-a6dd-4040-b97f-e05d24d2c7a4",
  "name": "test",
  "amount": "0.0",
  "currency": "ARS",
  "cycle_unit": "monthly",
  "cycle_amount": 1,
  "type": "Volume",
  "country": "argentina",
  "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"
    }
  ],
  "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": [],
      "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