Subscriptions

A Subscription is the number of records to be processed that a customer has purchased for the year along with the start and end dates of that year. Subscriptions are available for Integration Services and Replication Services. This endpoint also allows you to track usage for a specific Organization or for multiple Child Organizations. See Managing Organizations in the TIBCO Scribe® Help.

Use the Subscriptions endpoint to view information about an annual Subscription to TIBCO Scribe®.

Endpoints — Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields For Subscriptions Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Considerations

In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.

GET /v1/orgs/{orgId}/subscriptions

  • If this is a parent Organization, Subscription information for each child Organization is returned.

Endpoints

Return a list Subscriptions

Return information about a Subscription

Fields For Subscriptions Endpoints

The list of fields defined in this table is comprehensive across all Subscriptions endpoints. See Endpoints for a list of Subscriptions endpoints with links to the associated Swagger page.

Name
Type
Data Type

Description

Endpoints

Parameters

orgId

path

integer

Unique ID for each Organization. Required

All

showAll

query

boolean

Includes or excludes all subscriptions. Default is false.

  • true — Returns all subscriptions.
  • false — Returns only the current subscriptions for this Organization.
  • GET /v1/orgs/{orgId}/subscriptions

showMonthlyUsage

query

boolean

Includes or excludes number of records processed by each Organization in each of the last 12 months. Default is false.

  • true — Returns monthly usage.
  • false — Does not return monthly usage.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

subscriptionId

path

string

GUID/UUID of the Subscription.

  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

Response

date

response

string

Date and time in UTC time that the month began when tracking monthly usage.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

description

response

string

Description of the Subscription.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

expirationDate

response

string

Date and time in UTC time that the Subscription ends.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

id

response

string

GUID/UUID of the Subscription.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

monthlyUsage

response

array

MonthlyUsage model containing the number of records processed for each month of the Subscription. Fields include:
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

name

response

string

Name of the Subscription type. Types include:

  • Integration Services (IS) — Enables Integration Services Solutions to synchronize data between two or more datastores.
  • Replication Services (RS) — Enables Replication Services Solutions to replicate data from one datastore to another and update the target datastore as needed.
  • Migration Services (MS) — Enables Migration Services Solutions for a one time migration of data from one datastore to another.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

orgId

response

integer

ID of the Organization or Parent Organization.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

isTrial

response

boolean

Indicates whether or not this is a Trial Subscription.

  • true — Is a Trial.
  • false— Is not a Trial.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

recordsAllowed

response

string

Total number of records allowed to be processed for this Subscription type within the starting and expiration dates. See name for a list of types.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

recordsProcessed

response

integer

Total number of records processed for this Subscription type within the starting and expiration dates or for the month. See name for a list of types.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

sku

response

string

Internal use only.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

startDate

response

string

Date and time in UTC time that the Subscription began.
  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

tscAccountId

response

string

Internal use only.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

tscRegion

response

string

Internal use only.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

tscSubscriptionId

response

string

Internal use only.

  • GET /v1/orgs/{orgId}/subscriptions
  • GET /v1/orgs/{orgId}/subscriptions{subscriptionId]

 

See

Endpoints

API Basics