Detalles de una suscripción

curl --request GET \
  --url https://api.onepay.la/v1/subscriptions/{subscription_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onepay.la/v1/subscriptions/{subscription_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onepay.la/v1/subscriptions/{subscription_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onepay.la/v1/subscriptions/{subscription_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onepay.la/v1/subscriptions/{subscription_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "9ddfcfc1-7b5e-490c-9731-4aabd986908e",
  "name": "SpectreSaaS",
  "status": "active",
  "description": "<p>1 Free</p><p>2 COP 449.000</p>",
  "internal_id": "SaaSSpectre",
  "plan_id": null,
  "coupon_id": null,
  "reference_price_in_cents": "44900000",
  "currency": "COP",
  "amount_in_cents": 44900000,
  "cicle_frequency": "monthly",
  "cicles": null,
  "current_cicle": 2,
  "allows": {
    "cards": true,
    "accounts": true,
    "card_extra": false,
    "realtime": false,
    "pse": true,
    "transfiya": true
  },
  "suggest_auto_debit": true,
  "start_date": "2025-01-05T00:00:00.000000Z",
  "end_date": null,
  "payment_mode": "request",
  "trial": {
    "has_trial": false,
    "start_trial_date": null,
    "trial_days": 0
  },
  "remember_to_pay_before": 3,
  "cancel_after_no_payment_before": 2,
  "complex_payments": [],
  "features": [],
  "metadata": null,
  "created_at": "2025-01-02T19:24:48.000000Z",
  "updated_at": "2025-02-05T16:01:24.000000Z",
  "customer": {
    "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
    "first_name": "Empresa",
    "last_name": "SAS",
    "email": "empresa@empresa.com",
    "phone": "+573221234567",
    "document": "1234567890",
    "document_type": "RUT"
  }
}

{
  "message": "Registro no encontrado, Suscripción no existe",
  "code": 10002,
  "code_name": "record_not_found"
}

GET

subscriptions

{subscription_id}

Detalles de una suscripción

curl --request GET \
  --url https://api.onepay.la/v1/subscriptions/{subscription_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onepay.la/v1/subscriptions/{subscription_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onepay.la/v1/subscriptions/{subscription_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onepay.la/v1/subscriptions/{subscription_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onepay.la/v1/subscriptions/{subscription_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "9ddfcfc1-7b5e-490c-9731-4aabd986908e",
  "name": "SpectreSaaS",
  "status": "active",
  "description": "<p>1 Free</p><p>2 COP 449.000</p>",
  "internal_id": "SaaSSpectre",
  "plan_id": null,
  "coupon_id": null,
  "reference_price_in_cents": "44900000",
  "currency": "COP",
  "amount_in_cents": 44900000,
  "cicle_frequency": "monthly",
  "cicles": null,
  "current_cicle": 2,
  "allows": {
    "cards": true,
    "accounts": true,
    "card_extra": false,
    "realtime": false,
    "pse": true,
    "transfiya": true
  },
  "suggest_auto_debit": true,
  "start_date": "2025-01-05T00:00:00.000000Z",
  "end_date": null,
  "payment_mode": "request",
  "trial": {
    "has_trial": false,
    "start_trial_date": null,
    "trial_days": 0
  },
  "remember_to_pay_before": 3,
  "cancel_after_no_payment_before": 2,
  "complex_payments": [],
  "features": [],
  "metadata": null,
  "created_at": "2025-01-02T19:24:48.000000Z",
  "updated_at": "2025-02-05T16:01:24.000000Z",
  "customer": {
    "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
    "first_name": "Empresa",
    "last_name": "SAS",
    "email": "empresa@empresa.com",
    "phone": "+573221234567",
    "document": "1234567890",
    "document_type": "RUT"
  }
}

{
  "message": "Registro no encontrado, Suscripción no existe",
  "code": 10002,
  "code_name": "record_not_found"
}

Parámetros de Ruta

string

required

ID único de la suscripción que deseas consultar

Response

string

Identificador único de la suscripción (UUID).

string

Nombre comercial de la suscripción.

string

Estado actual (active, unpaid, pass_due, canceled, finished, frozen).

string

Descripción enriquecida (puede contener HTML).

string

Identificador interno que usas en tu sistema.

string

ID del plan asociado, si aplica.

string

ID del cupón aplicado.

string

Precio de referencia en centavos como string.

string

Moneda en formato ISO-4217 (ej. COP).

number

Valor base cobrado en cada ciclo.

string

Frecuencia de cobro: weekly, monthly, annual, etc.

number

Cantidad máxima de ciclos; null para indefinido.

number

Ciclo actual procesado.

object

Configuración de métodos de pago permitidos para la suscripción.

boolean

Indica si se sugiere activar débito automático durante el onboarding del cliente.

date

Fecha programada de inicio.

date

Fecha de finalización si aplica.

object

Información de periodo de prueba (has_trial, trial_days, start_trial_date).

string

Modo de cobro (request, auto_debit, etc.).

number

Días de anticipación para recordatorios de pago.

number

Número de ciclos fallidos antes de cancelar automáticamente.

array

Pagos con valores diferenciados por ciclo.

object

Atributos personalizados que acompañan la suscripción.

object

Resumen del cliente asociado.

object

Información del plan enlazado, cuando existe.

date

Fecha de creación de la suscripción.

date

Fecha de última actualización.

{
  "id": "9ddfcfc1-7b5e-490c-9731-4aabd986908e",
  "name": "SpectreSaaS",
  "status": "active",
  "description": "<p>1 Free</p><p>2 COP 449.000</p>",
  "internal_id": "SaaSSpectre",
  "plan_id": null,
  "coupon_id": null,
  "reference_price_in_cents": "44900000",
  "currency": "COP",
  "amount_in_cents": 44900000,
  "cicle_frequency": "monthly",
  "cicles": null,
  "current_cicle": 2,
  "allows": {
    "cards": true,
    "accounts": true,
    "card_extra": false,
    "realtime": false,
    "pse": true,
    "transfiya": true
  },
  "suggest_auto_debit": true,
  "start_date": "2025-01-05T00:00:00.000000Z",
  "end_date": null,
  "payment_mode": "request",
  "trial": {
    "has_trial": false,
    "start_trial_date": null,
    "trial_days": 0
  },
  "remember_to_pay_before": 3,
  "cancel_after_no_payment_before": 2,
  "complex_payments": [],
  "features": [],
  "metadata": null,
  "created_at": "2025-01-02T19:24:48.000000Z",
  "updated_at": "2025-02-05T16:01:24.000000Z",
  "customer": {
    "id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
    "first_name": "Empresa",
    "last_name": "SAS",
    "email": "empresa@empresa.com",
    "phone": "+573221234567",
    "document": "1234567890",
    "document_type": "RUT"
  }
}

{
  "message": "Registro no encontrado, Suscripción no existe",
  "code": 10002,
  "code_name": "record_not_found"
}

API

Empresas

Métodos de pago

Recaudo

Productos

Facturación

Balances

Webhooks

Fintech as a service

Detalles de una suscripción

Parámetros de Ruta

Response

​Parámetros de Ruta

​Response

Parámetros de Ruta

Response