Skip to content

Get a subscription by ID

Request

Security
api_key
Path
subscriptionIdstringrequired

The ID of the subscription.

Query
includeMetersboolean
curl -i -X GET \
  'https://apidocs.wetransact.io/_mock/openapi/api/v1.0/subscriptions/{subscriptionId}?includeMeters=true' \
  -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

Present when includeMeters=true and the plan has metered dimensions.

Response
{
  "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": [
    { … }
  ]
}