conekta.PlansApi

All URIs are relative to https://api.conekta.io

Method	HTTP request	Description
create_plan	POST /plans	Create Plan
delete_plan	DELETE /plans/{id}	Delete Plan
get_plan	GET /plans/{id}	Get Plan
get_plans	GET /plans	Get A List of Plans
update_plan	PUT /plans/{id}	Update Plan

create_plan

PlanResponse create_plan(plan_request, accept_language=accept_language, x_child_company_id=x_child_company_id)

Create Plan

Create a new plan for an existing order

Example

Bearer Authentication (bearerAuth):

import conekta
from conekta.models.plan_request import PlanRequest
from conekta.models.plan_response import PlanResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.PlansApi(api_client)
    plan_request = conekta.PlanRequest() # PlanRequest | requested field for plan
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)

    try:
        # Create Plan
        api_response = api_instance.create_plan(plan_request, accept_language=accept_language, x_child_company_id=x_child_company_id)
        print("The response of PlansApi->create_plan:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->create_plan: %s\n" % e)

Parameters

Name	Type	Description	Notes
plan_request	PlanRequest	requested field for plan
accept_language	str	Use for knowing which language to use	[optional] [default to es]
x_child_company_id	str	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

PlanResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
422	parameter validation error	-
401	authentication error	-
500	internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_plan

PlanResponse delete_plan(id, accept_language=accept_language)

Delete Plan

Example

Bearer Authentication (bearerAuth):

import conekta
from conekta.models.plan_response import PlanResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.PlansApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)

    try:
        # Delete Plan
        api_response = api_instance.delete_plan(id, accept_language=accept_language)
        print("The response of PlansApi->delete_plan:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->delete_plan: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of the resource
accept_language	str	Use for knowing which language to use	[optional] [default to es]

Return type

PlanResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
422	parameter validation error	-
401	authentication error	-
404	not found entity	-
500	internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_plan

PlanResponse get_plan(id, accept_language=accept_language, x_child_company_id=x_child_company_id)

Get Plan

Example

Bearer Authentication (bearerAuth):

import conekta
from conekta.models.plan_response import PlanResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.PlansApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)

    try:
        # Get Plan
        api_response = api_instance.get_plan(id, accept_language=accept_language, x_child_company_id=x_child_company_id)
        print("The response of PlansApi->get_plan:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->get_plan: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of the resource
accept_language	str	Use for knowing which language to use	[optional] [default to es]
x_child_company_id	str	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

PlanResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
422	parameter validation error	-
401	authentication error	-
404	not found entity	-
500	internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_plans

GetPlansResponse get_plans(accept_language=accept_language, x_child_company_id=x_child_company_id, limit=limit, search=search, next=next, previous=previous)

Get A List of Plans

Example

Bearer Authentication (bearerAuth):

import conekta
from conekta.models.get_plans_response import GetPlansResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.PlansApi(api_client)
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)
    limit = 20 # int | The numbers of items to return, the maximum value is 250 (optional) (default to 20)
    search = 'search_example' # str | General order search, e.g. by mail, reference etc. (optional)
    next = 'next_example' # str | next page (optional)
    previous = 'previous_example' # str | previous page (optional)

    try:
        # Get A List of Plans
        api_response = api_instance.get_plans(accept_language=accept_language, x_child_company_id=x_child_company_id, limit=limit, search=search, next=next, previous=previous)
        print("The response of PlansApi->get_plans:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->get_plans: %s\n" % e)

Parameters

Name	Type	Description	Notes
accept_language	str	Use for knowing which language to use	[optional] [default to es]
x_child_company_id	str	In the case of a holding company, the company id of the child company to which will process the request.	[optional]
limit	int	The numbers of items to return, the maximum value is 250	[optional] [default to 20]
search	str	General order search, e.g. by mail, reference etc.	[optional]
next	str	next page	[optional]
previous	str	previous page	[optional]

Return type

GetPlansResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
422	parameter validation error	-
401	authentication error	-
500	internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_plan

PlanResponse update_plan(id, plan_update_request, accept_language=accept_language, x_child_company_id=x_child_company_id)

Update Plan

Example

Bearer Authentication (bearerAuth):

import conekta
from conekta.models.plan_response import PlanResponse
from conekta.models.plan_update_request import PlanUpdateRequest
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.PlansApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    plan_update_request = conekta.PlanUpdateRequest() # PlanUpdateRequest | requested field for plan
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    x_child_company_id = '6441b6376b60c3a638da80af' # str | In the case of a holding company, the company id of the child company to which will process the request. (optional)

    try:
        # Update Plan
        api_response = api_instance.update_plan(id, plan_update_request, accept_language=accept_language, x_child_company_id=x_child_company_id)
        print("The response of PlansApi->update_plan:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlansApi->update_plan: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of the resource
plan_update_request	PlanUpdateRequest	requested field for plan
accept_language	str	Use for knowing which language to use	[optional] [default to es]
x_child_company_id	str	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

PlanResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
422	parameter validation error	-
401	authentication error	-
404	not found entity	-
500	internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PlansApi.md

Latest commit

History

PlansApi.md

File metadata and controls

conekta.PlansApi

create_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_plans

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_plan

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details