curl --request GET \
--url https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-merchant-id: <api-key>'import requests
url = "https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}"
headers = {
"x-api-key": "<api-key>",
"x-merchant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-merchant-id': '<api-key>'}
};
fetch('https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-merchant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-merchant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}")
.header("x-api-key", "<api-key>")
.header("x-merchant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-merchant-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "123e4567-e89b-12d3-a456-426614174000",
"merchantId": "merchant_123",
"customerId": "123e4567-e89b-12d3-a456-426614174001",
"planId": "123e4567-e89b-12d3-a456-426614174002",
"paymentMethodId": "123e4567-e89b-12d3-a456-426614174003",
"status": "ACTIVE",
"currentPeriodStart": "2025-01-01T00:00:00.000Z",
"currentPeriodEnd": "2025-02-01T00:00:00.000Z",
"cancelAtPeriodEnd": false,
"nextBillingDate": "2025-02-01T00:00:00.000Z",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-15T10:00:00.000Z",
"trialStart": "2025-01-01T00:00:00.000Z",
"trialEnd": "2025-01-15T00:00:00.000Z",
"canceledAt": null,
"endedAt": null,
"metadata": {},
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"amount": "<string>",
"currency": "<string>",
"interval": "DAY",
"intervalCount": 123
}
}{
"message": "Invalid api key"
}{
"message": "Merchant not found"
}{
"message": "Error message"
}Get a subscription by ID
Retrieves a specific subscription by its unique identifier, including associated plan details.
curl --request GET \
--url https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-merchant-id: <api-key>'import requests
url = "https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}"
headers = {
"x-api-key": "<api-key>",
"x-merchant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-merchant-id': '<api-key>'}
};
fetch('https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-merchant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-merchant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}")
.header("x-api-key", "<api-key>")
.header("x-merchant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.cheqpay.mx/pos/v1/subscriptions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-merchant-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "123e4567-e89b-12d3-a456-426614174000",
"merchantId": "merchant_123",
"customerId": "123e4567-e89b-12d3-a456-426614174001",
"planId": "123e4567-e89b-12d3-a456-426614174002",
"paymentMethodId": "123e4567-e89b-12d3-a456-426614174003",
"status": "ACTIVE",
"currentPeriodStart": "2025-01-01T00:00:00.000Z",
"currentPeriodEnd": "2025-02-01T00:00:00.000Z",
"cancelAtPeriodEnd": false,
"nextBillingDate": "2025-02-01T00:00:00.000Z",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-15T10:00:00.000Z",
"trialStart": "2025-01-01T00:00:00.000Z",
"trialEnd": "2025-01-15T00:00:00.000Z",
"canceledAt": null,
"endedAt": null,
"metadata": {},
"plan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"amount": "<string>",
"currency": "<string>",
"interval": "DAY",
"intervalCount": 123
}
}{
"message": "Invalid api key"
}{
"message": "Merchant not found"
}{
"message": "Error message"
}Authorizations
API key for authentication (required)
Merchant ID for identifying the merchant (required)
Path Parameters
Subscription unique identifier
Response
Subscription retrieved successfully
Unique subscription identifier
"123e4567-e89b-12d3-a456-426614174000"
Merchant identifier
"merchant_123"
Customer identifier
"123e4567-e89b-12d3-a456-426614174001"
Plan identifier
"123e4567-e89b-12d3-a456-426614174002"
Payment method identifier
"123e4567-e89b-12d3-a456-426614174003"
Subscription status
TRIALING, ACTIVE, PAST_DUE, CANCELED, UNPAID "ACTIVE"
Start of the current billing period
"2025-01-01T00:00:00.000Z"
End of the current billing period
"2025-02-01T00:00:00.000Z"
Whether the subscription will cancel at period end
false
Date of the next billing charge (trial end date while trialing, otherwise the current period end date)
"2025-02-01T00:00:00.000Z"
Creation timestamp
"2025-01-01T00:00:00.000Z"
Last update timestamp
"2025-01-15T10:00:00.000Z"
Trial period start date
"2025-01-01T00:00:00.000Z"
Trial period end date
"2025-01-15T00:00:00.000Z"
When the subscription was canceled
null
When the subscription ended
null
Additional metadata
Associated plan details
Show child attributes
Show child attributes