List

List

curl --request GET \
  --url https://api.paygentic.io/v0/subscriptions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/subscriptions', 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.paygentic.io/v0/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.paygentic.io/v0/subscriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "sub_z1a2b3c4d5e6f7g8",
      "object": "subscription",
      "autoCharge": false,
      "taxExempt": false,
      "createdAt": "2024-01-10T08:00:00Z",
      "customerId": "cus_q3r4s5t6u7v8w9x0",
      "endingAt": null,
      "estimatedTaxRate": 8.5,
      "name": "StartupXYZ - Image Generation Service",
      "payment": null,
      "planId": "plan_t9u0v1w2x3y4z5a6",
      "startedAt": "2024-01-10T08:00:00Z",
      "status": "active",
      "terminatedAt": null,
      "terminatedBy": null,
      "terminationReason": null,
      "updatedAt": "2024-01-10T08:00:00Z"
    },
    {
      "id": "sub_j1k2l3m4n5o6p7q8",
      "object": "subscription",
      "autoCharge": true,
      "taxExempt": true,
      "createdAt": "2024-02-01T14:45:30Z",
      "customerId": "cus_r9s0t1u2v3w4x5y6",
      "endingAt": "2024-12-31T23:59:59Z",
      "estimatedTaxRate": 0,
      "name": "Analytics Co - Data Platform Enterprise",
      "payment": null,
      "planId": "plan_z7a8b9c0d1e2f3g4",
      "startedAt": "2024-02-01T14:45:30Z",
      "status": "active",
      "terminatedAt": null,
      "terminatedBy": null,
      "terminationReason": null,
      "updatedAt": "2024-02-15T09:20:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

GET

subscriptions

List

curl --request GET \
  --url https://api.paygentic.io/v0/subscriptions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/subscriptions', 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.paygentic.io/v0/subscriptions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.paygentic.io/v0/subscriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "sub_z1a2b3c4d5e6f7g8",
      "object": "subscription",
      "autoCharge": false,
      "taxExempt": false,
      "createdAt": "2024-01-10T08:00:00Z",
      "customerId": "cus_q3r4s5t6u7v8w9x0",
      "endingAt": null,
      "estimatedTaxRate": 8.5,
      "name": "StartupXYZ - Image Generation Service",
      "payment": null,
      "planId": "plan_t9u0v1w2x3y4z5a6",
      "startedAt": "2024-01-10T08:00:00Z",
      "status": "active",
      "terminatedAt": null,
      "terminatedBy": null,
      "terminationReason": null,
      "updatedAt": "2024-01-10T08:00:00Z"
    },
    {
      "id": "sub_j1k2l3m4n5o6p7q8",
      "object": "subscription",
      "autoCharge": true,
      "taxExempt": true,
      "createdAt": "2024-02-01T14:45:30Z",
      "customerId": "cus_r9s0t1u2v3w4x5y6",
      "endingAt": "2024-12-31T23:59:59Z",
      "estimatedTaxRate": 0,
      "name": "Analytics Co - Data Platform Enterprise",
      "payment": null,
      "planId": "plan_z7a8b9c0d1e2f3g4",
      "startedAt": "2024-02-01T14:45:30Z",
      "status": "active",
      "terminatedAt": null,
      "terminatedBy": null,
      "terminationReason": null,
      "updatedAt": "2024-02-15T09:20:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization

string

header

required

API key authentication

Query Parameters

consumerId

string

Return subscriptions for this consumer organization. May be combined with merchantId to scope to a single consumer/merchant pair. Cannot be combined with customerId. Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$

customerId

string

Return subscriptions for this customer. Cannot be combined with consumerId or merchantId. Unique identifier for a customer

Pattern: ^cus_[a-zA-Z0-9]+$

limit

string

default:10

Number of subscriptions to return

merchantId

string

Return subscriptions for this merchant organization. May be combined with consumerId to scope to a single consumer/merchant pair. Cannot be combined with customerId. Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$

offset

string

default:0

Number of subscriptions to skip

status

enum<string>

Available options:

active,

terminated,

pending_payment

startedBefore

string<date-time>

Filter subscriptions started at or before this ISO 8601 date-time

include

enum<string>

Include related resources. When 'customer' is specified, each subscription includes merchant and consumer details.

Available options:

customer

Response

List of subscriptions

data

object[]

Show child attributes

pagination

object

Offset-based pagination response.

Show child attributes

Billable Metrics

Customers

Entitlements

Grants

Features

Fees

Plans

Prices

Products

Sources

Subscriptions

Users

Invoices V2

Payments

Payment Sessions

Events

Costs

Revenue

Profitability

Test Clocks

ExternalReferences

Items

Orders

Billing Schedules

Salesforce

MerchantIntegrations

Approvals

Authorizations

Query Parameters

Response