Create Plan

post

https://api.conekta.io/plans

Create a new plan for an existing order

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requested field for plan

amount

integer

required

≥ 1

The amount in cents that will be charged on the interval specified.

currency

string

length ≤ 3

ISO 4217 for currencies, for the Mexican peso it is MXN/USD

expiry_count

integer

Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count.

frequency

integer

required

≥ 1

Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights

string

internal reference id

interval

string

enum

required

The interval of time between each charge.

Allowed:

name

string

required

The name of the plan.

trial_period_days

integer

The number of days the customer will have a free trial.

max_retries

integer

≥ 3

(optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled.

retry_delay_hours

integer

≥ 48

(optional) Defines the number of hours between subscription payment retry attempts.

Headers

Accept-Language

string

enum

Defaults to es

Use for knowing which language to use

Allowed:

X-Child-Company-Id

string

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

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.conekta-v2.2.0+json

200successful

401authentication error

422parameter validation error

500internal server error