COconekta
Subscriptions - Customer Portal

Get customer portal

Retrieves the customer portal for a subscription

get/subscriptions/{subscription_id}/customer_portal

Request

Path parameters

subscription_idstring required
Example:sub_2tGzG1GxtDAZHEGPH

Identifier of the subscription resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Response

Customer portal retrieved successfully

slugstring

Unique slug identifier for the portal

subscription_idstring

Associated subscription ID

customer_idstring

Associated customer ID

livemodeboolean

Whether this is a live or test mode portal

idstring

Customer portal ID

company_idstring

Associated company ID

objectstring
created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of last update

portal_urlstring uri

URL to access the customer portal

Example response

{
  "slug": "agIvD4QSBl4Nunq4TmuozMw2ThtyVC",
  "subscription_id": "sub_2yYsQuYtXAbP1fdYu",
  "customer_id": "cus_2yDzKtEAD3khH8Sga",
  "subscription": {
    "card": {
      "id": "src_2yw5zPrVahTy7xy7P",
      "created_at": 1761745218,
      "active": true,
      "object": "card",
      "exp_month": "05",
      "exp_year": "26",
      "brand": "mastercard",
      "last4": "1005",
      "name": "test",
      "payment_source_status": "active",
      "customer_id": "cus_2yDzKtEAD3khH8Sga"
    },
    "plan": {
      "id": "VG5",
      "object": "plan",
      "name": "CLARO",
      "amount": 30000,
      "currency": "USD",
      "interval": "month",
      "frequency": 1,
      "expiry_count": 1,
      "created_at": 1742087277
    },
    "id": "sub_2yYsQuYtXAbP1fdYu",
    "object": "subscription",
    "status": "canceled",
    "plan_id": "VG5",
    "customer_id": "cus_2yDzKtEAD3khH8Sga",
    "next_billing_cycle": 1876833632,
    "created_at": 1755873642,
    "updated_at": 1761745218
  },
  "customer": {
    "id": "cus_2yDzKtEAD3khH8Sga",
    "object": "customer",
    "name": "mao",
    "email": "maoarroya@gmail.com"
  },
  "id": "scp_2ym7QbU9dTh7Froti",
  "company_id": "63dad459920de10001d177b3",
  "object": "customer_portal",
  "created_at": 1759108828,
  "updated_at": 1759108828,
  "portal_url": "https://pay.stg.conekta.io/subscription/management/agIvD4QSBl4Nunq4TmuozMw2ThtyVC"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.