COconekta
Plans

Get A List of Plans

get/plans

Request

Query parameters

limitinteger

The numbers of items to return, the maximum value is 250

searchstring

General order search, e.g. by mail, reference etc.

nextstring

next page

previousstring

previous page

currencystring

currency of the object to be retrieved

frequencyinteger

frequency of the object to be retrieved

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

successful

has_moreboolean required

Indicates if there are more pages to be requested

objectstring required

Object type, in this case is list

next_page_urlstring nullable

URL of the next page.

previous_page_urlstring nullable

Url of the previous page.

Example response

{
  "object": "list",
  "next_page_url": "https://api.conekta.io/resources?limit=10&next=chrg_1",
  "previous_page_url": "https://api.conekta.io/resources?limit=10&previous=chrg_1",
  "data": [
    {
      "amount": 10000,
      "created_at": 1666900846,
      "currency": "MXN",
      "expiry_count": 12,
      "frequency": 1,
      "id": "gold-plan",
      "interval": "month",
      "livemode": true,
      "name": "Extra Plan3",
      "object": "plan",
      "max_retries": 3,
      "retry_delay_hours": 48
    }
  ]
}

Changes

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