{ "opencollection": "1.0.0", "info": { "name": "Conekta Antifraud Subscriptions API", "version": "2.2.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:customer_id/subscriptions", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of subscriptions for a customer" }, { "info": { "name": "Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new subscription for a customer (keeps existing subscriptions active)" }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a specific subscription" }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a specific subscription" }, { "info": { "name": "Get Subscription Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/events", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" }, { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get events for a specific subscription" }, { "info": { "name": "Cancel Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/cancel", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a specific subscription" }, { "info": { "name": "Pause Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/pause", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Pause a specific subscription" }, { "info": { "name": "Resume Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/resume", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume a specific paused subscription" }, { "info": { "name": "Retry Failed Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/retry", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retry a failed payment for a specific subscription" }, { "info": { "name": "Get Subscription [Deprecated]", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:id/subscription", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." }, { "info": { "name": "Create Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0. You can create the subscription to include the plans that your customers consume" }, { "info": { "name": "Update Subscription [Deprecated]", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:id/subscription", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0. You can modify the subscription to change the plans that your customers consume" }, { "info": { "name": "Cancel Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription/cancel", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." }, { "info": { "name": "Get Subscription Events [Deprecated]", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:id/subscription/events", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0. You can get the events of the subscription(s) of a client, with the customer id" }, { "info": { "name": "Pause Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription/pause", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." }, { "info": { "name": "Resume Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription/resume", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." } ] } ], "bundled": true }