Skip to content

WeTransact Platform API (1.0)

API for managing subscriptions and metering for WeTransact Publishers.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Support Team

support@wetransact.io

Languages
Servers
WeTransact Publisher API Base URL

https://<yoursubdomain>.wetransact.io/api/v1/

Subscriptions

All functions that relate to the subscription entity in the WeTransact Platform.

Operations

Get all subscriptions

Request

Security
api_key
Query
includeMetersboolean

If true, include meters in the response.

curl -i -X GET \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Returns the list of subscriptions

Bodyapplication/jsonArray [
marketplaceSubscriptionIdstring
Example: "aa930163-2330-45c2-a17c-dd325f9f2d44"
createdstring(date-time)
Example: "2025-11-25T00:00:00Z"
customerTenantIdstring
Example: "36a5a162-2d92-4255-8f01-0a6b35dba770"
companyNamestring
Example: "WeTransact"
marketplaceOfferIdstring
Example: "my-product"
marketplacePlanIdstring
Example: "my-sku"
seatQuantitystring
Example: "10"
termUnitstring
Example: "P1M | P1Y | P2Y | P3Y"
initialUserEmailstring
Example: "test@wetransact.io"
additionalDetailsstring
Example: "{'phonenumber':'445533663388'}"
statusstring
Example: "New | Approved | Cancelled | Suspended | Rejected | ApproveBy | Succeeded | Failed | Deleted"
meteringDetailsobject
linksArray of objects
]
Response
application/json
[
  {
    "marketplaceSubscriptionId": "aa930163-2330-45c2-a17c-dd325f9f2d44",
    "created": "2025-11-25T00:00:00Z",
    "customerTenantId": "36a5a162-2d92-4255-8f01-0a6b35dba770",
    "companyName": "WeTransact",
    "marketplaceOfferId": "my-product",
    "marketplacePlanId": "my-sku",
    "seatQuantity": "10",
    "termUnit": "P1M | P1Y | P2Y | P3Y",
    "initialUserEmail": "test@wetransact.io",
    "additionalDetails": "{'phonenumber':'445533663388'}",
    "status": "New | Approved | Cancelled | Suspended | Rejected | ApproveBy | Succeeded | Failed | Deleted",
    "meteringDetails": { … },
    "links": [ … ]
  }
]

Get a subscription by ID

Request

Security
api_key
Path
subscriptionIdstringrequired

The ID of the subscription.

Query
includeMetersboolean

If true, include meters in the response.

curl -i -X GET \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Returns the subscription

Bodyapplication/json
marketplaceSubscriptionIdstring
Example: "aa930163-2330-45c2-a17c-dd325f9f2d44"
createdstring(date-time)
Example: "2025-11-25T00:00:00Z"
customerTenantIdstring
Example: "36a5a162-2d92-4255-8f01-0a6b35dba770"
companyNamestring
Example: "WeTransact"
marketplaceOfferIdstring
Example: "my-product"
marketplacePlanIdstring
Example: "my-sku"
seatQuantitystring
Example: "10"
termUnitstring
Example: "P1M | P1Y | P2Y | P3Y"
initialUserEmailstring
Example: "test@wetransact.io"
additionalDetailsstring
Example: "{'phonenumber':'445533663388'}"
statusstring
Example: "New | Approved | Cancelled | Suspended | Rejected | ApproveBy | Succeeded | Failed | Deleted"
meteringDetailsobject
linksArray of objects
Response
application/json
{
  "marketplaceSubscriptionId": "aa930163-2330-45c2-a17c-dd325f9f2d44",
  "created": "2025-11-25T00:00:00Z",
  "customerTenantId": "36a5a162-2d92-4255-8f01-0a6b35dba770",
  "companyName": "WeTransact",
  "marketplaceOfferId": "my-product",
  "marketplacePlanId": "my-sku",
  "seatQuantity": "10",
  "termUnit": "P1M | P1Y | P2Y | P3Y",
  "initialUserEmail": "test@wetransact.io",
  "additionalDetails": "{'phonenumber':'445533663388'}",
  "status": "New | Approved | Cancelled | Suspended | Rejected | ApproveBy | Succeeded | Failed | Deleted",
  "meteringDetails": {
    "meters": [ … ]
  },
  "links": [
    { … }
  ]
}

Activate a subscription

Request

Security
api_key
Path
subscriptionIdstringrequired

The ID of the subscription.

curl -i -X POST \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Subscription activated successfully

Reject a subscription

Request

Security
api_key
Path
subscriptionIdstringrequired

The ID of the subscription.

curl -i -X POST \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Subscription rejected successfully

Charge the dimensions that are tied to a subscription

Request

Security
api_key
Path
subscriptionIdstringrequired

The ID of the subscription.

Query
dimensionIdstringrequired

The ID of the dimension to charge.

quantitystringrequired

The quantity to charge.

curl -i -X POST \
  '' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Subscription charged successfully

Products

All product operations on the WeTransact Platform

Operations